<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Bindings: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="prev" href="GtkSettings.html" title="GtkSettings">
<link rel="next" href="gtk2-Standard-Enumerations.html" title="Standard Enumerations">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gtk2-Bindings.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gtkbase.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSettings.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gtk2-Standard-Enumerations.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtk2-Bindings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk2-Bindings.top_of_page"></a>Bindings</span></h2>
<p>Bindings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gtk2-Bindings.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signall" title="gtk_binding_entry_add_signall ()">gtk_binding_entry_add_signall</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-clear" title="gtk_binding_entry_clear ()">gtk_binding_entry_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-parse-binding" title="gtk_binding_parse_binding ()">gtk_binding_parse_binding</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-set-new" title="gtk_binding_set_new ()">gtk_binding_set_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-set-by-class" title="gtk_binding_set_by_class ()">gtk_binding_set_by_class</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-set-find" title="gtk_binding_set_find ()">gtk_binding_set_find</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-bindings-activate" title="gtk_bindings_activate ()">gtk_bindings_activate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-bindings-activate-event" title="gtk_bindings_activate_event ()">gtk_bindings_activate_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-set-activate" title="gtk_binding_set_activate ()">gtk_binding_set_activate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signal" title="gtk_binding_entry_add_signal ()">gtk_binding_entry_add_signal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-skip" title="gtk_binding_entry_skip ()">gtk_binding_entry_skip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-remove" title="gtk_binding_entry_remove ()">gtk_binding_entry_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gtk2-Bindings.html#gtk-binding-set-add-path" title="gtk_binding_set_add_path ()">gtk_binding_set_add_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk2-Bindings.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet">GtkBindingSet</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry">GtkBindingEntry</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal">GtkBindingSignal</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg">GtkBindingArg</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add" title="gtk_binding_entry_add">gtk_binding_entry_add</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtk2-Bindings.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="gtk2-Bindings.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gtk2-Bindings.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-binding-entry-add-signall"></a><h3>gtk_binding_entry_add_signall ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_entry_add_signall (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *signal_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *binding_args</code></em>);</pre>
<p>Override or install a new key binding for <em class="parameter"><code>keyval</code></em>
with <em class="parameter"><code>modifiers</code></em>
on
<em class="parameter"><code>binding_set</code></em>
.</p>
<div class="refsect3">
<a name="gtk-binding-entry-add-signall.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to add a signal to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signal_name</p></td>
<td class="parameter_description"><p>signal name to be bound</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>binding_args</p></td>
<td class="parameter_description"><p>list of <a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg"><span class="type">GtkBindingArg</span></a> signal arguments. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkBindingArg]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-entry-clear"></a><h3>gtk_binding_entry_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_entry_clear (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_binding_entry_clear</code> has been deprecated since version 2.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-remove" title="gtk_binding_entry_remove ()"><code class="function">gtk_binding_entry_remove()</code></a> instead.</p>
</div>
<p>Clears a binding entry.</p>
<div class="refsect3">
<a name="gtk-binding-entry-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>binding set to clear an entry of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of binding to clear</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of binding to clear</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-parse-binding"></a><h3>gtk_binding_parse_binding ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gtk_binding_parse_binding (<em class="parameter"><code><a href="../glib/glib-Lexical-Scanner.html#GScanner"><span class="type">GScanner</span></a> *scanner</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_binding_parse_binding</code> has been deprecated since version 2.12 and should not be used in newly-written code.</p>
<p>There should be no need to call this function outside GTK+.</p>
</div>
<p>Parse a binding entry from a gtkrc file.</p>
<div class="refsect3">
<a name="gtk-binding-parse-binding.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>scanner</p></td>
<td class="parameter_description"><p>GtkRC scanner</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-binding-parse-binding.returns"></a><h4>Returns</h4>
<p> expected token upon errors, <a href="../glib/glib-Lexical-Scanner.html#G-TOKEN-NONE:CAPS"><code class="literal">G_TOKEN_NONE</code></a> on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-set-new"></a><h3>gtk_binding_set_new ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
gtk_binding_set_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *set_name</code></em>);</pre>
<p>GTK+ maintains a global list of binding sets. Each binding set has
a unique name which needs to be specified upon creation.</p>
<div class="refsect3">
<a name="gtk-binding-set-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>set_name</p></td>
<td class="parameter_description"><p>unique name of this binding set</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-binding-set-new.returns"></a><h4>Returns</h4>
<p> new binding set</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-set-by-class"></a><h3>gtk_binding_set_by_class ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
gtk_binding_set_by_class (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object_class</code></em>);</pre>
<p>This function returns the binding set named after the type name of
the passed in class structure. New binding sets are created on
demand by this function.</p>
<div class="refsect3">
<a name="gtk-binding-set-by-class.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>object_class</p></td>
<td class="parameter_description"><p>a valid <a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> class</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-binding-set-by-class.returns"></a><h4>Returns</h4>
<p> the binding set corresponding to <em class="parameter"><code>object_class</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-set-find"></a><h3>gtk_binding_set_find ()</h3>
<pre class="programlisting"><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *
gtk_binding_set_find (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *set_name</code></em>);</pre>
<p>Find a binding set by its globally unique name. The <em class="parameter"><code>set_name</code></em>
can
either be a name used for <a class="link" href="gtk2-Bindings.html#gtk-binding-set-new" title="gtk_binding_set_new ()"><code class="function">gtk_binding_set_new()</code></a> or the type name of
a class used in <a class="link" href="gtk2-Bindings.html#gtk-binding-set-by-class" title="gtk_binding_set_by_class ()"><code class="function">gtk_binding_set_by_class()</code></a>.</p>
<div class="refsect3">
<a name="gtk-binding-set-find.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>set_name</p></td>
<td class="parameter_description"><p>unique binding set name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-binding-set-find.returns"></a><h4>Returns</h4>
<p><a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the specified binding set. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-bindings-activate"></a><h3>gtk_bindings_activate ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_bindings_activate (<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
<p>Find a key binding matching <em class="parameter"><code>keyval</code></em>
and <em class="parameter"><code>modifiers</code></em>
and activate the
binding on <em class="parameter"><code>object</code></em>
.</p>
<div class="refsect3">
<a name="gtk-bindings-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>object to activate when binding found</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of the binding</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of the binding</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-bindings-activate.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a binding was found and activated</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-bindings-activate-event"></a><h3>gtk_bindings_activate_event ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_bindings_activate_event (<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);</pre>
<p>Looks up key bindings for <em class="parameter"><code>object</code></em>
to find one matching
<em class="parameter"><code>event</code></em>
, and if one was found, activate it.</p>
<div class="refsect3">
<a name="gtk-bindings-activate-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> (generally must be a widget)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <a href="../html/gdk2-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-bindings-activate-event.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a matching key binding was found</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-set-activate"></a><h3>gtk_binding_set_activate ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_binding_set_activate (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>);</pre>
<p>Find a key binding matching <em class="parameter"><code>keyval</code></em>
and <em class="parameter"><code>modifiers</code></em>
within
<em class="parameter"><code>binding_set</code></em>
and activate the binding on <em class="parameter"><code>object</code></em>
.</p>
<div class="refsect3">
<a name="gtk-binding-set-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> set to activate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of the binding</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of the binding</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>object to activate when binding found</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-binding-set-activate.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a binding was found and activated</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-entry-add-signal"></a><h3>gtk_binding_entry_add_signal ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_entry_add_signal (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *signal_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_args</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Override or install a new key binding for <em class="parameter"><code>keyval</code></em>
with <em class="parameter"><code>modifiers</code></em>
on
<em class="parameter"><code>binding_set</code></em>
. When the binding is activated, <em class="parameter"><code>signal_name</code></em>
will be
emitted on the target widget, with <em class="parameter"><code>n_args</code></em>
<em class="parameter"><code>Varargs</code></em>
used as
arguments.</p>
<div class="refsect3">
<a name="gtk-binding-entry-add-signal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to install an entry for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of binding to install</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of binding to install</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>signal_name</p></td>
<td class="parameter_description"><p>signal to execute upon activation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_args</p></td>
<td class="parameter_description"><p>number of arguments to <em class="parameter"><code>signal_name</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Varargs</p></td>
<td class="parameter_description"><p>arguments to <em class="parameter"><code>signal_name</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-entry-skip"></a><h3>gtk_binding_entry_skip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_entry_skip (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_binding_entry_skip</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Install a binding on <em class="parameter"><code>binding_set</code></em>
which causes key lookups
to be aborted, to prevent bindings from lower priority sets
to be activated.</p>
<div class="refsect3">
<a name="gtk-binding-entry-skip.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to skip an entry of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of binding to skip</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of binding to skip</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-12.html#api-index-2.12">2.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-entry-remove"></a><h3>gtk_binding_entry_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_entry_remove (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> keyval</code></em>,
<em class="parameter"><code><a href="../html/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
<p>Remove a binding previously installed via
<a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signal" title="gtk_binding_entry_add_signal ()"><code class="function">gtk_binding_entry_add_signal()</code></a> on <em class="parameter"><code>binding_set</code></em>
.</p>
<div class="refsect3">
<a name="gtk-binding-entry-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to remove an entry of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of binding to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of binding to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-set-add-path"></a><h3>gtk_binding_set_add_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_binding_set_add_path (<em class="parameter"><code><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *binding_set</code></em>,
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPathType" title="enum GtkPathType"><span class="type">GtkPathType</span></a> path_type</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path_pattern</code></em>,
<em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkPathPriorityType" title="enum GtkPathPriorityType"><span class="type">GtkPathPriorityType</span></a> priority</code></em>);</pre>
<p>This function is used internally by the GtkRC parsing mechanism to
assign match patterns to <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> structures.</p>
<div class="refsect3">
<a name="gtk-binding-set-add-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to add a path to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path_type</p></td>
<td class="parameter_description"><p>path type the pattern applies to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path_pattern</p></td>
<td class="parameter_description"><p>the actual match pattern</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>priority</p></td>
<td class="parameter_description"><p>binding priority</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gtk2-Bindings.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkBindingSet"></a><h3>struct GtkBindingSet</h3>
<pre class="programlisting">struct GtkBindingSet {
gchar *set_name;
gint priority;
GSList *widget_path_pspecs;
GSList *widget_class_pspecs;
GSList *class_branch_pspecs;
GtkBindingEntry *entries;
GtkBindingEntry *current;
guint parsed : 1; /* From RC content */
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkBindingEntry"></a><h3>struct GtkBindingEntry</h3>
<pre class="programlisting">struct GtkBindingEntry {
/* key portion
*/
guint keyval;
GdkModifierType modifiers;
GtkBindingSet *binding_set;
guint destroyed : 1;
guint in_emission : 1;
guint marks_unbound : 1;
GtkBindingEntry *set_next;
GtkBindingEntry *hash_next;
GtkBindingSignal *signals;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkBindingSignal"></a><h3>struct GtkBindingSignal</h3>
<pre class="programlisting">struct GtkBindingSignal {
GtkBindingSignal *next;
gchar *signal_name;
guint n_args;
GtkBindingArg *args;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkBindingArg"></a><h3>struct GtkBindingArg</h3>
<pre class="programlisting">struct GtkBindingArg {
GType arg_type;
union {
glong long_data;
gdouble double_data;
gchar *string_data;
} d;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-binding-entry-add"></a><h3>gtk_binding_entry_add</h3>
<pre class="programlisting">#define gtk_binding_entry_add gtk_binding_entry_clear
</pre>
<div class="warning">
<p><code class="literal">gtk_binding_entry_add</code> has been deprecated since version 2.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signal" title="gtk_binding_entry_add_signal ()"><code class="function">gtk_binding_entry_add_signal()</code></a> instead.</p>
</div>
<p>Adds a binding entry.</p>
<div class="refsect3">
<a name="gtk-binding-entry-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>binding_set</p></td>
<td class="parameter_description"><p>#a GtkBindingSet to clear an entry of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keyval</p></td>
<td class="parameter_description"><p>key value of binding to clear</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifiers</p></td>
<td class="parameter_description"><p>key modifier of binding to clear</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>