← Back to branch summary

~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/gtk2-Bindings.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2013-01-10 12:53:20 UTC
  • mfrom: (1.14.16)
  • Revision ID: package-import@ubuntu.com-20130110125320-x13bjpwtqq36izs2
Tags: 2.24.14-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/gtk2-Bindings.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>Bindings</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
 
8
<link rel="up" href="gtkbase.html" title="Part II. GTK+ Core Reference">
 
9
<link rel="prev" href="GtkSettings.html" title="Settings">
 
10
<link rel="next" href="gtk2-Standard-Enumerations.html" title="Standard Enumerations">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GtkSettings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="gtkbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
 
21
<td><a accesskey="n" href="gtk2-Standard-Enumerations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#gtk2-Bindings.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#gtk2-Bindings.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="gtk2-Bindings"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="gtk2-Bindings.top_of_page"></a>Bindings</span></h2>
 
34
<p>Bindings — Key bindings for individual widgets</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="gtk2-Bindings.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
#include &lt;gtk/gtk.h&gt;
 
42
 
 
43
struct              <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet">GtkBindingSet</a>;
 
44
struct              <a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry">GtkBindingEntry</a>;
 
45
struct              <a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal">GtkBindingSignal</a>;
 
46
struct              <a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg">GtkBindingArg</a>;
 
47
#define             <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add" title="gtk_binding_entry_add">gtk_binding_entry_add</a>
 
48
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signall" title="gtk_binding_entry_add_signall ()">gtk_binding_entry_add_signall</a>       (<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>,
 
49
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
50
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GSList</span> *binding_args</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-clear" title="gtk_binding_entry_clear ()">gtk_binding_entry_clear</a>             (<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>,
 
54
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
55
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);
 
56
<span class="returnvalue">guint</span>               <a class="link" href="gtk2-Bindings.html#gtk-binding-parse-binding" title="gtk_binding_parse_binding ()">gtk_binding_parse_binding</a>           (<em class="parameter"><code><span class="type">GScanner</span> *scanner</code></em>);
 
57
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *     <a class="link" href="gtk2-Bindings.html#gtk-binding-set-new" title="gtk_binding_set_new ()">gtk_binding_set_new</a>                 (<em class="parameter"><code>const <span class="type">gchar</span> *set_name</code></em>);
 
58
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *     <a class="link" href="gtk2-Bindings.html#gtk-binding-set-by-class" title="gtk_binding_set_by_class ()">gtk_binding_set_by_class</a>            (<em class="parameter"><code><span class="type">gpointer</span> object_class</code></em>);
 
59
<a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="returnvalue">GtkBindingSet</span></a> *     <a class="link" href="gtk2-Bindings.html#gtk-binding-set-find" title="gtk_binding_set_find ()">gtk_binding_set_find</a>                (<em class="parameter"><code>const <span class="type">gchar</span> *set_name</code></em>);
 
60
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk2-Bindings.html#gtk-bindings-activate" title="gtk_bindings_activate ()">gtk_bindings_activate</a>               (<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
62
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);
 
63
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk2-Bindings.html#gtk-bindings-activate-event" title="gtk_bindings_activate_event ()">gtk_bindings_activate_event</a>         (<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>,
 
64
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);
 
65
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk2-Bindings.html#gtk-binding-set-activate" title="gtk_binding_set_activate ()">gtk_binding_set_activate</a>            (<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>,
 
66
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
67
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
68
                                                         <em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>);
 
69
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-add-signal" title="gtk_binding_entry_add_signal ()">gtk_binding_entry_add_signal</a>        (<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>,
 
70
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
71
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
72
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
 
73
                                                         <em class="parameter"><code><span class="type">guint</span> n_args</code></em>,
 
74
                                                         <em class="parameter"><code>...</code></em>);
 
75
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-skip" title="gtk_binding_entry_skip ()">gtk_binding_entry_skip</a>              (<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>,
 
76
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
77
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);
 
78
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-entry-remove" title="gtk_binding_entry_remove ()">gtk_binding_entry_remove</a>            (<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>,
 
79
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
80
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);
 
81
<span class="returnvalue">void</span>                <a class="link" href="gtk2-Bindings.html#gtk-binding-set-add-path" title="gtk_binding_set_add_path ()">gtk_binding_set_add_path</a>            (<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>,
 
82
                                                         <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>,
 
83
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path_pattern</code></em>,
 
84
                                                         <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>);
 
85
</pre>
 
86
</div>
 
87
<div class="refsect1">
 
88
<a name="gtk2-Bindings.description"></a><h2>Description</h2>
 
89
<p>
 
90
GtkBinding provides a mechanism for configuring GTK+ key bindings through
 
91
RC files. This eases key binding adjustments for application developers as
 
92
well as users and provides GTK+ users or administrators with high key
 
93
binding configurability which requires no application or toolkit side changes.
 
94
</p>
 
95
<div class="refsect2">
 
96
<a name="idp13318448"></a><h3>Installing a key binding</h3>
 
97
<a name="gtk-bindings-install"></a><p>
 
98
A resource file binding consists of a 'binding' definition and a match
 
99
statement to apply the binding to specific widget types. Details on the
 
100
matching mechanism are described under
 
101
<a class="link" href="gtk2-Resource-Files.html#gtkrc-pathnames-and-patterns">Pathnames and patterns</a>.
 
102
Inside the binding definition, key combinations are bound to specific signal
 
103
emissions on the target widget. Key combinations are strings consisting of
 
104
an optional <a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> name and
 
105
key names such as those defined
 
106
in <code class="filename">&lt;gdk/gdkkeysyms.h&gt;</code> or returned from
 
107
<a href="../gdk2/gdk2-Keyboard-Handling.html#gdk-keyval-name"><code class="function">gdk_keyval_name()</code></a>, they have to be parsable by <a class="link" href="gtk2-Keyboard-Accelerators.html#gtk-accelerator-parse" title="gtk_accelerator_parse ()"><code class="function">gtk_accelerator_parse()</code></a>.
 
108
Specifications of signal emissions consist of a string identifying the signal
 
109
name, and a list of signal specific arguments in parenthesis.
 
110
</p>
 
111
<p>
 
112
For example for binding Control and the left or right cursor keys of a
 
113
<a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> widget to the <a class="link" href="GtkEntry.html#GtkEntry-move-cursor" title='The "move-cursor" signal'><span class="type">"move-cursor"</span></a> signal, so movement occurs
 
114
in 3 letter steps, the following binding can be used:
 
115
</p>
 
116
<div class="informalexample">
 
117
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
118
    <tbody>
 
119
      <tr>
 
120
        <td class="listing_lines" align="right"><pre>1
 
121
2
 
122
3
 
123
4
 
124
5
 
125
6
 
126
7
 
127
8
 
128
9</pre></td>
 
129
        <td class="listing_code"><pre class="programlisting"><span class="normal">binding </span><span class="string">"MoveCursor3"</span><span class="normal"> </span><span class="cbracket">{</span>
 
130
<span class="normal">  bind </span><span class="string">"&lt;Control&gt;Right"</span><span class="normal"> </span><span class="cbracket">{</span>
 
131
<span class="normal">    </span><span class="string">"move-cursor"</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">visual</span><span class="symbol">-</span><span class="normal">positions</span><span class="symbol">,</span><span class="normal"> </span><span class="number">3</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">)</span>
 
132
<span class="normal">  </span><span class="cbracket">}</span>
 
133
<span class="normal">  bind </span><span class="string">"&lt;Control&gt;Left"</span><span class="normal"> </span><span class="cbracket">{</span>
 
134
<span class="normal">    </span><span class="string">"move-cursor"</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">visual</span><span class="symbol">-</span><span class="normal">positions</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">3</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">)</span>
 
135
<span class="normal">  </span><span class="cbracket">}</span>
 
136
<span class="cbracket">}</span>
 
137
<span class="normal">class </span><span class="string">"GtkEntry"</span><span class="normal"> binding </span><span class="string">"MoveCursor3"</span></pre></td>
 
138
      </tr>
 
139
    </tbody>
 
140
  </table>
 
141
</div>
 
142
 
 
143
<p>
 
144
</p>
 
145
<a name="gtk-bindings-unbind"></a><p>
 
146
GTK+ already defines a number of useful bindings for the widgets it provides.
 
147
Because custom bindings set up in RC files take precedence over the default
 
148
bindings shipped with GTK+, overriding existing bindings as demonstrated in
 
149
<a class="link" href="gtk2-Bindings.html#gtk-bindings-install">Installing a key binding</a>
 
150
works as expected. The same mechanism can not be used to "unbind" existing
 
151
bindings, however.
 
152
</p>
 
153
<div class="informalexample">
 
154
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
155
    <tbody>
 
156
      <tr>
 
157
        <td class="listing_lines" align="right"><pre>1
 
158
2
 
159
3
 
160
4
 
161
5</pre></td>
 
162
        <td class="listing_code"><pre class="programlisting"><span class="normal">binding </span><span class="string">"MoveCursor3"</span><span class="normal"> </span><span class="cbracket">{</span>
 
163
<span class="normal">  bind </span><span class="string">"&lt;Control&gt;Right"</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="cbracket">}</span>
 
164
<span class="normal">  bind </span><span class="string">"&lt;Control&gt;Left"</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="cbracket">}</span>
 
165
<span class="cbracket">}</span>
 
166
<span class="normal">class </span><span class="string">"GtkEntry"</span><span class="normal"> binding </span><span class="string">"MoveCursor3"</span></pre></td>
 
167
      </tr>
 
168
    </tbody>
 
169
  </table>
 
170
</div>
 
171
 
 
172
<p>
 
173
The above example will not have the desired effect of causing
 
174
"&lt;Control&gt;Right" and "&lt;Control&gt;Left" key presses to be ignored
 
175
by GTK+. Instead, it just causes any existing bindings from the bindings
 
176
set "MoveCursor3" to be deleted, so when "&lt;Control&gt;Right" or
 
177
"&lt;Control&gt;Left" are pressed, no binding for these keys is found in
 
178
binding set "MoveCursor3". GTK+ will thus continue to search for matching
 
179
key bindings, and will eventually lookup and find the default GTK+ bindings
 
180
for entries which implement word movement. To keep GTK+ from activating its
 
181
default bindings, the "unbind" keyword can be used like this:
 
182
</p>
 
183
<div class="informalexample">
 
184
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
185
    <tbody>
 
186
      <tr>
 
187
        <td class="listing_lines" align="right"><pre>1
 
188
2
 
189
3
 
190
4
 
191
5</pre></td>
 
192
        <td class="listing_code"><pre class="programlisting"><span class="normal">binding </span><span class="string">"MoveCursor3"</span><span class="normal"> </span><span class="cbracket">{</span>
 
193
<span class="normal">  unbind </span><span class="string">"&lt;Control&gt;Right"</span>
 
194
<span class="normal">  unbind </span><span class="string">"&lt;Control&gt;Left"</span>
 
195
<span class="cbracket">}</span>
 
196
<span class="normal">class </span><span class="string">"GtkEntry"</span><span class="normal"> binding </span><span class="string">"MoveCursor3"</span></pre></td>
 
197
      </tr>
 
198
    </tbody>
 
199
  </table>
 
200
</div>
 
201
 
 
202
<p>
 
203
Now, GTK+ will find a match when looking up "&lt;Control&gt;Right" and
 
204
"&lt;Control&gt;Left" key presses before it resorts to its default
 
205
bindings, and the match instructs it to abort ("unbind") the search, so
 
206
the key presses are not consumed by this widget. As usual, further processing
 
207
of the key presses, e.g. by an entry's parent widget, is now possible.
 
208
</p>
 
209
<p>
 
210
The "unbind" functionality has been introduced in GTK+ 2.12.
 
211
</p>
 
212
</div>
 
213
</div>
 
214
<div class="refsect1">
 
215
<a name="gtk2-Bindings.details"></a><h2>Details</h2>
 
216
<div class="refsect2">
 
217
<a name="GtkBindingSet"></a><h3>struct GtkBindingSet</h3>
 
218
<pre class="programlisting">struct GtkBindingSet {
 
219
  gchar                 *set_name;
 
220
  gint                   priority;
 
221
  GSList                *widget_path_pspecs;
 
222
  GSList                *widget_class_pspecs;
 
223
  GSList                *class_branch_pspecs;
 
224
  GtkBindingEntry *entries;
 
225
  GtkBindingEntry *current;
 
226
  guint                  parsed : 1; /* From RC content */
 
227
};
 
228
</pre>
 
229
<p>
 
230
A binding set maintains a list of activatable key bindings.
 
231
A single binding set can match multiple types of widgets.
 
232
Similar to styles, widgets can be mapped by widget name paths, widget
 
233
class paths or widget class types.  When a binding within a set is
 
234
matched upon activation, an action signal is emitted on the target
 
235
widget to carry out the actual activation.
 
236
</p>
 
237
<div class="variablelist"><table border="0" class="variablelist">
 
238
<colgroup>
 
239
<col align="left" valign="top">
 
240
<col>
 
241
</colgroup>
 
242
<tbody>
 
243
<tr>
 
244
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GtkBindingSet.set-name"></a>set_name</code></em>;</span></p></td>
 
245
<td>unique binding set name</td>
 
246
</tr>
 
247
<tr>
 
248
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="GtkBindingSet.priority"></a>priority</code></em>;</span></p></td>
 
249
<td>unused</td>
 
250
</tr>
 
251
<tr>
 
252
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="GtkBindingSet.widget-path-pspecs"></a>widget_path_pspecs</code></em>;</span></p></td>
 
253
<td>widgets matched by path that this binding set applies to</td>
 
254
</tr>
 
255
<tr>
 
256
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="GtkBindingSet.widget-class-pspecs"></a>widget_class_pspecs</code></em>;</span></p></td>
 
257
<td>widgets matched by class path that this binding set applies to</td>
 
258
</tr>
 
259
<tr>
 
260
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="GtkBindingSet.class-branch-pspecs"></a>class_branch_pspecs</code></em>;</span></p></td>
 
261
<td>widgets matched by class that this binding set applies to</td>
 
262
</tr>
 
263
<tr>
 
264
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry"><span class="type">GtkBindingEntry</span></a> *<em class="structfield"><code><a name="GtkBindingSet.entries"></a>entries</code></em>;</span></p></td>
 
265
<td>the key binding entries in this binding set</td>
 
266
</tr>
 
267
<tr>
 
268
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry"><span class="type">GtkBindingEntry</span></a> *<em class="structfield"><code><a name="GtkBindingSet.current"></a>current</code></em>;</span></p></td>
 
269
<td>implementation detail</td>
 
270
</tr>
 
271
<tr>
 
272
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingSet.parsed"></a>parsed</code></em> : 1;</span></p></td>
 
273
<td>whether this binding set stems from an RC file and is reset upon theme changes</td>
 
274
</tr>
 
275
</tbody>
 
276
</table></div>
 
277
</div>
 
278
<hr>
 
279
<div class="refsect2">
 
280
<a name="GtkBindingEntry"></a><h3>struct GtkBindingEntry</h3>
 
281
<pre class="programlisting">struct GtkBindingEntry {
 
282
  /* key portion
 
283
   */
 
284
  guint                  keyval;
 
285
  GdkModifierType        modifiers;
 
286
  
 
287
  GtkBindingSet         *binding_set;
 
288
  guint                 destroyed : 1;
 
289
  guint                 in_emission : 1;
 
290
  guint                 marks_unbound : 1;
 
291
  GtkBindingEntry *set_next;
 
292
  GtkBindingEntry *hash_next;
 
293
  GtkBindingSignal *signals;
 
294
};
 
295
</pre>
 
296
<p>
 
297
Each key binding element of a binding sets binding list is represented by
 
298
a <a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry"><span class="type">GtkBindingEntry</span></a>.
 
299
</p>
 
300
<div class="variablelist"><table border="0" class="variablelist">
 
301
<colgroup>
 
302
<col align="left" valign="top">
 
303
<col>
 
304
</colgroup>
 
305
<tbody>
 
306
<tr>
 
307
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingEntry.keyval"></a>keyval</code></em>;</span></p></td>
 
308
<td>key value to match</td>
 
309
</tr>
 
310
<tr>
 
311
<td><p><span class="term"><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> <em class="structfield"><code><a name="GtkBindingEntry.modifiers"></a>modifiers</code></em>;</span></p></td>
 
312
<td>key modifier to match</td>
 
313
</tr>
 
314
<tr>
 
315
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> *<em class="structfield"><code><a name="GtkBindingEntry.binding-set"></a>binding_set</code></em>;</span></p></td>
 
316
<td>binding set this entry belongs to</td>
 
317
</tr>
 
318
<tr>
 
319
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingEntry.destroyed"></a>destroyed</code></em> : 1;</span></p></td>
 
320
<td>implementation detail</td>
 
321
</tr>
 
322
<tr>
 
323
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingEntry.in-emission"></a>in_emission</code></em> : 1;</span></p></td>
 
324
<td>implementation detail</td>
 
325
</tr>
 
326
<tr>
 
327
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingEntry.marks-unbound"></a>marks_unbound</code></em> : 1;</span></p></td>
 
328
<td>implementation detail</td>
 
329
</tr>
 
330
<tr>
 
331
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry"><span class="type">GtkBindingEntry</span></a> *<em class="structfield"><code><a name="GtkBindingEntry.set-next"></a>set_next</code></em>;</span></p></td>
 
332
<td>linked list of entries maintained by binding set</td>
 
333
</tr>
 
334
<tr>
 
335
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingEntry" title="struct GtkBindingEntry"><span class="type">GtkBindingEntry</span></a> *<em class="structfield"><code><a name="GtkBindingEntry.hash-next"></a>hash_next</code></em>;</span></p></td>
 
336
<td>implementation detail</td>
 
337
</tr>
 
338
<tr>
 
339
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal"><span class="type">GtkBindingSignal</span></a> *<em class="structfield"><code><a name="GtkBindingEntry.signals"></a>signals</code></em>;</span></p></td>
 
340
<td>action signals of this entry</td>
 
341
</tr>
 
342
</tbody>
 
343
</table></div>
 
344
</div>
 
345
<hr>
 
346
<div class="refsect2">
 
347
<a name="GtkBindingSignal"></a><h3>struct GtkBindingSignal</h3>
 
348
<pre class="programlisting">struct GtkBindingSignal {
 
349
  GtkBindingSignal *next;
 
350
  gchar                 *signal_name;
 
351
  guint                  n_args;
 
352
  GtkBindingArg         *args;
 
353
};
 
354
</pre>
 
355
<a name="keybinding-signals"></a><p>
 
356
A <a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal"><span class="type">GtkBindingSignal</span></a> stores the necessary information to activate a widget
 
357
in response to a key press via a signal emission.
 
358
</p>
 
359
<div class="variablelist"><table border="0" class="variablelist">
 
360
<colgroup>
 
361
<col align="left" valign="top">
 
362
<col>
 
363
</colgroup>
 
364
<tbody>
 
365
<tr>
 
366
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal"><span class="type">GtkBindingSignal</span></a> *<em class="structfield"><code><a name="GtkBindingSignal.next"></a>next</code></em>;</span></p></td>
 
367
<td>implementation detail</td>
 
368
</tr>
 
369
<tr>
 
370
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GtkBindingSignal.signal-name"></a>signal_name</code></em>;</span></p></td>
 
371
<td>the action signal to be emitted</td>
 
372
</tr>
 
373
<tr>
 
374
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="GtkBindingSignal.n-args"></a>n_args</code></em>;</span></p></td>
 
375
<td>number of arguments specified for the signal</td>
 
376
</tr>
 
377
<tr>
 
378
<td><p><span class="term"><a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg"><span class="type">GtkBindingArg</span></a> *<em class="structfield"><code><a name="GtkBindingSignal.args"></a>args</code></em>;</span></p></td>
 
379
<td>the arguments specified for the signal</td>
 
380
</tr>
 
381
</tbody>
 
382
</table></div>
 
383
</div>
 
384
<hr>
 
385
<div class="refsect2">
 
386
<a name="GtkBindingArg"></a><h3>struct GtkBindingArg</h3>
 
387
<pre class="programlisting">struct GtkBindingArg {
 
388
  GType          arg_type;
 
389
  union {
 
390
    glong        long_data;
 
391
    gdouble      double_data;
 
392
    gchar *string_data;
 
393
  } d;
 
394
};
 
395
</pre>
 
396
<p>
 
397
A <a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg"><span class="type">GtkBindingArg</span></a> holds the data associated with an argument for a
 
398
key binding signal emission as stored in <a class="link" href="gtk2-Bindings.html#GtkBindingSignal" title="struct GtkBindingSignal"><span class="type">GtkBindingSignal</span></a>.
 
399
</p>
 
400
<div class="variablelist"><table border="0" class="variablelist">
 
401
<colgroup>
 
402
<col align="left" valign="top">
 
403
<col>
 
404
</colgroup>
 
405
<tbody><tr>
 
406
<td><p><span class="term"><span class="type">GType</span> <em class="structfield"><code><a name="GtkBindingArg.arg-type"></a>arg_type</code></em>;</span></p></td>
 
407
<td>implementation detail</td>
 
408
</tr></tbody>
 
409
</table></div>
 
410
</div>
 
411
<hr>
 
412
<div class="refsect2">
 
413
<a name="gtk-binding-entry-add"></a><h3>gtk_binding_entry_add</h3>
 
414
<pre class="programlisting">#define      gtk_binding_entry_add          gtk_binding_entry_clear
 
415
</pre>
 
416
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
417
<h3 class="title">Warning</h3>
 
418
<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. 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>
 
419
</div>
 
420
<p>
 
421
Adds a binding entry.
 
422
</p>
 
423
<div class="variablelist"><table border="0" class="variablelist">
 
424
<colgroup>
 
425
<col align="left" valign="top">
 
426
<col>
 
427
</colgroup>
 
428
<tbody>
 
429
<tr>
 
430
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
431
<td>#a GtkBindingSet to clear an entry of</td>
 
432
</tr>
 
433
<tr>
 
434
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
435
<td>key value of binding to clear</td>
 
436
</tr>
 
437
<tr>
 
438
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
439
<td>key modifier of binding to clear</td>
 
440
</tr>
 
441
</tbody>
 
442
</table></div>
 
443
</div>
 
444
<hr>
 
445
<div class="refsect2">
 
446
<a name="gtk-binding-entry-add-signall"></a><h3>gtk_binding_entry_add_signall ()</h3>
 
447
<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>,
 
448
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
449
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
450
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
 
451
                                                         <em class="parameter"><code><span class="type">GSList</span> *binding_args</code></em>);</pre>
 
452
<p>
 
453
Override or install a new key binding for <em class="parameter"><code>keyval</code></em> with <em class="parameter"><code>modifiers</code></em> on
 
454
<em class="parameter"><code>binding_set</code></em>.
 
455
</p>
 
456
<div class="variablelist"><table border="0" class="variablelist">
 
457
<colgroup>
 
458
<col align="left" valign="top">
 
459
<col>
 
460
</colgroup>
 
461
<tbody>
 
462
<tr>
 
463
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
464
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to add a signal to</td>
 
465
</tr>
 
466
<tr>
 
467
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
468
<td>key value</td>
 
469
</tr>
 
470
<tr>
 
471
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
472
<td>key modifier</td>
 
473
</tr>
 
474
<tr>
 
475
<td><p><span class="term"><em class="parameter"><code>signal_name</code></em> :</span></p></td>
 
476
<td>signal name to be bound</td>
 
477
</tr>
 
478
<tr>
 
479
<td><p><span class="term"><em class="parameter"><code>binding_args</code></em> :</span></p></td>
 
480
<td>list of <a class="link" href="gtk2-Bindings.html#GtkBindingArg" title="struct GtkBindingArg"><span class="type">GtkBindingArg</span></a> signal arguments. <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>
 
481
</td>
 
482
</tr>
 
483
</tbody>
 
484
</table></div>
 
485
</div>
 
486
<hr>
 
487
<div class="refsect2">
 
488
<a name="gtk-binding-entry-clear"></a><h3>gtk_binding_entry_clear ()</h3>
 
489
<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>,
 
490
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
491
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
 
492
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
493
<h3 class="title">Warning</h3>
 
494
<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. 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>
 
495
</div>
 
496
<p>
 
497
Clears a binding entry.
 
498
</p>
 
499
<div class="variablelist"><table border="0" class="variablelist">
 
500
<colgroup>
 
501
<col align="left" valign="top">
 
502
<col>
 
503
</colgroup>
 
504
<tbody>
 
505
<tr>
 
506
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
507
<td>binding set to clear an entry of</td>
 
508
</tr>
 
509
<tr>
 
510
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
511
<td>key value of binding to clear</td>
 
512
</tr>
 
513
<tr>
 
514
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
515
<td>key modifier of binding to clear</td>
 
516
</tr>
 
517
</tbody>
 
518
</table></div>
 
519
</div>
 
520
<hr>
 
521
<div class="refsect2">
 
522
<a name="gtk-binding-parse-binding"></a><h3>gtk_binding_parse_binding ()</h3>
 
523
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_binding_parse_binding           (<em class="parameter"><code><span class="type">GScanner</span> *scanner</code></em>);</pre>
 
524
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
525
<h3 class="title">Warning</h3>
 
526
<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. There should be no need to call this function outside GTK+.</p>
 
527
</div>
 
528
<p>
 
529
Parse a binding entry from a gtkrc file.
 
530
</p>
 
531
<div class="variablelist"><table border="0" class="variablelist">
 
532
<colgroup>
 
533
<col align="left" valign="top">
 
534
<col>
 
535
</colgroup>
 
536
<tbody>
 
537
<tr>
 
538
<td><p><span class="term"><em class="parameter"><code>scanner</code></em> :</span></p></td>
 
539
<td>GtkRC scanner</td>
 
540
</tr>
 
541
<tr>
 
542
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
543
<td>expected token upon errors, <code class="literal">G_TOKEN_NONE</code> on success.</td>
 
544
</tr>
 
545
</tbody>
 
546
</table></div>
 
547
</div>
 
548
<hr>
 
549
<div class="refsect2">
 
550
<a name="gtk-binding-set-new"></a><h3>gtk_binding_set_new ()</h3>
 
551
<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 <span class="type">gchar</span> *set_name</code></em>);</pre>
 
552
<p>
 
553
GTK+ maintains a global list of binding sets. Each binding set has
 
554
a unique name which needs to be specified upon creation.
 
555
</p>
 
556
<div class="variablelist"><table border="0" class="variablelist">
 
557
<colgroup>
 
558
<col align="left" valign="top">
 
559
<col>
 
560
</colgroup>
 
561
<tbody>
 
562
<tr>
 
563
<td><p><span class="term"><em class="parameter"><code>set_name</code></em> :</span></p></td>
 
564
<td>unique name of this binding set</td>
 
565
</tr>
 
566
<tr>
 
567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
568
<td>new binding set</td>
 
569
</tr>
 
570
</tbody>
 
571
</table></div>
 
572
</div>
 
573
<hr>
 
574
<div class="refsect2">
 
575
<a name="gtk-binding-set-by-class"></a><h3>gtk_binding_set_by_class ()</h3>
 
576
<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><span class="type">gpointer</span> object_class</code></em>);</pre>
 
577
<p>
 
578
This function returns the binding set named after the type name of
 
579
the passed in class structure. New binding sets are created on
 
580
demand by this function.
 
581
</p>
 
582
<div class="variablelist"><table border="0" class="variablelist">
 
583
<colgroup>
 
584
<col align="left" valign="top">
 
585
<col>
 
586
</colgroup>
 
587
<tbody>
 
588
<tr>
 
589
<td><p><span class="term"><em class="parameter"><code>object_class</code></em> :</span></p></td>
 
590
<td>a valid <a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> class</td>
 
591
</tr>
 
592
<tr>
 
593
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
594
<td>the binding set corresponding to <em class="parameter"><code>object_class</code></em>
 
595
</td>
 
596
</tr>
 
597
</tbody>
 
598
</table></div>
 
599
</div>
 
600
<hr>
 
601
<div class="refsect2">
 
602
<a name="gtk-binding-set-find"></a><h3>gtk_binding_set_find ()</h3>
 
603
<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 <span class="type">gchar</span> *set_name</code></em>);</pre>
 
604
<p>
 
605
Find a binding set by its globally unique name. The <em class="parameter"><code>set_name</code></em> can
 
606
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
 
607
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>.
 
608
</p>
 
609
<div class="variablelist"><table border="0" class="variablelist">
 
610
<colgroup>
 
611
<col align="left" valign="top">
 
612
<col>
 
613
</colgroup>
 
614
<tbody>
 
615
<tr>
 
616
<td><p><span class="term"><em class="parameter"><code>set_name</code></em> :</span></p></td>
 
617
<td>unique binding set name</td>
 
618
</tr>
 
619
<tr>
 
620
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
621
<td>
 
622
<a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> or the specified binding set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
623
</td>
 
624
</tr>
 
625
</tbody>
 
626
</table></div>
 
627
</div>
 
628
<hr>
 
629
<div class="refsect2">
 
630
<a name="gtk-bindings-activate"></a><h3>gtk_bindings_activate ()</h3>
 
631
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_bindings_activate               (<em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>,
 
632
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
633
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
 
634
<p>
 
635
Find a key binding matching <em class="parameter"><code>keyval</code></em> and <em class="parameter"><code>modifiers</code></em> and activate the
 
636
binding on <em class="parameter"><code>object</code></em>.
 
637
</p>
 
638
<div class="variablelist"><table border="0" class="variablelist">
 
639
<colgroup>
 
640
<col align="left" valign="top">
 
641
<col>
 
642
</colgroup>
 
643
<tbody>
 
644
<tr>
 
645
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
646
<td>object to activate when binding found</td>
 
647
</tr>
 
648
<tr>
 
649
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
650
<td>key value of the binding</td>
 
651
</tr>
 
652
<tr>
 
653
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
654
<td>key modifier of the binding</td>
 
655
</tr>
 
656
<tr>
 
657
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
658
<td>
 
659
<code class="literal">TRUE</code> if a binding was found and activated</td>
 
660
</tr>
 
661
</tbody>
 
662
</table></div>
 
663
</div>
 
664
<hr>
 
665
<div class="refsect2">
 
666
<a name="gtk-bindings-activate-event"></a><h3>gtk_bindings_activate_event ()</h3>
 
667
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
 
668
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>);</pre>
 
669
<p>
 
670
Looks up key bindings for <em class="parameter"><code>object</code></em> to find one matching
 
671
<em class="parameter"><code>event</code></em>, and if one was found, activate it.
 
672
</p>
 
673
<div class="variablelist"><table border="0" class="variablelist">
 
674
<colgroup>
 
675
<col align="left" valign="top">
 
676
<col>
 
677
</colgroup>
 
678
<tbody>
 
679
<tr>
 
680
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
681
<td>a <a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> (generally must be a widget)</td>
 
682
</tr>
 
683
<tr>
 
684
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 
685
<td>a <a href="../gdk2/gdk2-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a>
 
686
</td>
 
687
</tr>
 
688
<tr>
 
689
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
690
<td>
 
691
<code class="literal">TRUE</code> if a matching key binding was found</td>
 
692
</tr>
 
693
</tbody>
 
694
</table></div>
 
695
<p class="since">Since 2.4</p>
 
696
</div>
 
697
<hr>
 
698
<div class="refsect2">
 
699
<a name="gtk-binding-set-activate"></a><h3>gtk_binding_set_activate ()</h3>
 
700
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
 
701
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
702
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
703
                                                         <em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>);</pre>
 
704
<p>
 
705
Find a key binding matching <em class="parameter"><code>keyval</code></em> and <em class="parameter"><code>modifiers</code></em> within
 
706
<em class="parameter"><code>binding_set</code></em> and activate the binding on <em class="parameter"><code>object</code></em>.
 
707
</p>
 
708
<div class="variablelist"><table border="0" class="variablelist">
 
709
<colgroup>
 
710
<col align="left" valign="top">
 
711
<col>
 
712
</colgroup>
 
713
<tbody>
 
714
<tr>
 
715
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
716
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> set to activate</td>
 
717
</tr>
 
718
<tr>
 
719
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
720
<td>key value of the binding</td>
 
721
</tr>
 
722
<tr>
 
723
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
724
<td>key modifier of the binding</td>
 
725
</tr>
 
726
<tr>
 
727
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
728
<td>object to activate when binding found</td>
 
729
</tr>
 
730
<tr>
 
731
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
732
<td>
 
733
<code class="literal">TRUE</code> if a binding was found and activated</td>
 
734
</tr>
 
735
</tbody>
 
736
</table></div>
 
737
</div>
 
738
<hr>
 
739
<div class="refsect2">
 
740
<a name="gtk-binding-entry-add-signal"></a><h3>gtk_binding_entry_add_signal ()</h3>
 
741
<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>,
 
742
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
743
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>,
 
744
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *signal_name</code></em>,
 
745
                                                         <em class="parameter"><code><span class="type">guint</span> n_args</code></em>,
 
746
                                                         <em class="parameter"><code>...</code></em>);</pre>
 
747
<p>
 
748
Override or install a new key binding for <em class="parameter"><code>keyval</code></em> with <em class="parameter"><code>modifiers</code></em> on
 
749
<em class="parameter"><code>binding_set</code></em>. When the binding is activated, <em class="parameter"><code>signal_name</code></em> will be
 
750
emitted on the target widget, with <em class="parameter"><code>n_args</code></em> <em class="parameter"><code>Varargs</code></em> used as
 
751
arguments.
 
752
</p>
 
753
<div class="variablelist"><table border="0" class="variablelist">
 
754
<colgroup>
 
755
<col align="left" valign="top">
 
756
<col>
 
757
</colgroup>
 
758
<tbody>
 
759
<tr>
 
760
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
761
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to install an entry for</td>
 
762
</tr>
 
763
<tr>
 
764
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
765
<td>key value of binding to install</td>
 
766
</tr>
 
767
<tr>
 
768
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
769
<td>key modifier of binding to install</td>
 
770
</tr>
 
771
<tr>
 
772
<td><p><span class="term"><em class="parameter"><code>signal_name</code></em> :</span></p></td>
 
773
<td>signal to execute upon activation</td>
 
774
</tr>
 
775
<tr>
 
776
<td><p><span class="term"><em class="parameter"><code>n_args</code></em> :</span></p></td>
 
777
<td>number of arguments to <em class="parameter"><code>signal_name</code></em>
 
778
</td>
 
779
</tr>
 
780
</tbody>
 
781
</table></div>
 
782
</div>
 
783
<hr>
 
784
<div class="refsect2">
 
785
<a name="gtk-binding-entry-skip"></a><h3>gtk_binding_entry_skip ()</h3>
 
786
<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>,
 
787
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
788
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
 
789
<p>
 
790
Install a binding on <em class="parameter"><code>binding_set</code></em> which causes key lookups
 
791
to be aborted, to prevent bindings from lower priority sets
 
792
to be activated.
 
793
</p>
 
794
<div class="variablelist"><table border="0" class="variablelist">
 
795
<colgroup>
 
796
<col align="left" valign="top">
 
797
<col>
 
798
</colgroup>
 
799
<tbody>
 
800
<tr>
 
801
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
802
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to skip an entry of</td>
 
803
</tr>
 
804
<tr>
 
805
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
806
<td>key value of binding to skip</td>
 
807
</tr>
 
808
<tr>
 
809
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
810
<td>key modifier of binding to skip</td>
 
811
</tr>
 
812
</tbody>
 
813
</table></div>
 
814
<p class="since">Since 2.12</p>
 
815
</div>
 
816
<hr>
 
817
<div class="refsect2">
 
818
<a name="gtk-binding-entry-remove"></a><h3>gtk_binding_entry_remove ()</h3>
 
819
<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>,
 
820
                                                         <em class="parameter"><code><span class="type">guint</span> keyval</code></em>,
 
821
                                                         <em class="parameter"><code><a href="../gdk2/gdk2-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifiers</code></em>);</pre>
 
822
<p>
 
823
Remove a binding previously installed via
 
824
<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>.
 
825
</p>
 
826
<div class="variablelist"><table border="0" class="variablelist">
 
827
<colgroup>
 
828
<col align="left" valign="top">
 
829
<col>
 
830
</colgroup>
 
831
<tbody>
 
832
<tr>
 
833
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
834
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to remove an entry of</td>
 
835
</tr>
 
836
<tr>
 
837
<td><p><span class="term"><em class="parameter"><code>keyval</code></em> :</span></p></td>
 
838
<td>key value of binding to remove</td>
 
839
</tr>
 
840
<tr>
 
841
<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td>
 
842
<td>key modifier of binding to remove</td>
 
843
</tr>
 
844
</tbody>
 
845
</table></div>
 
846
</div>
 
847
<hr>
 
848
<div class="refsect2">
 
849
<a name="gtk-binding-set-add-path"></a><h3>gtk_binding_set_add_path ()</h3>
 
850
<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>,
 
851
                                                         <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>,
 
852
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path_pattern</code></em>,
 
853
                                                         <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>
 
854
<p>
 
855
This function is used internally by the GtkRC parsing mechanism to
 
856
assign match patterns to <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> structures.
 
857
</p>
 
858
<div class="variablelist"><table border="0" class="variablelist">
 
859
<colgroup>
 
860
<col align="left" valign="top">
 
861
<col>
 
862
</colgroup>
 
863
<tbody>
 
864
<tr>
 
865
<td><p><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></p></td>
 
866
<td>a <a class="link" href="gtk2-Bindings.html#GtkBindingSet" title="struct GtkBindingSet"><span class="type">GtkBindingSet</span></a> to add a path to</td>
 
867
</tr>
 
868
<tr>
 
869
<td><p><span class="term"><em class="parameter"><code>path_type</code></em> :</span></p></td>
 
870
<td>path type the pattern applies to</td>
 
871
</tr>
 
872
<tr>
 
873
<td><p><span class="term"><em class="parameter"><code>path_pattern</code></em> :</span></p></td>
 
874
<td>the actual match pattern</td>
 
875
</tr>
 
876
<tr>
 
877
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
 
878
<td>binding priority</td>
 
879
</tr>
 
880
</tbody>
 
881
</table></div>
 
882
</div>
 
883
</div>
 
884
<div class="refsect1">
 
885
<a name="gtk2-Bindings.see-also"></a><h2>See Also</h2>
 
886
<p>
 
887
</p>
 
888
<div class="variablelist"><table border="0" class="variablelist">
 
889
<colgroup>
 
890
<col align="left" valign="top">
 
891
<col>
 
892
</colgroup>
 
893
<tbody>
 
894
<tr>
 
895
<td><p><span class="term">Keyboard Accelerators
 
896
</span></p></td>
 
897
<td><p>installing and using keyboard short-cuts.</p></td>
 
898
</tr>
 
899
<tr>
 
900
<td><p><span class="term">Resource Files
 
901
</span></p></td>
 
902
<td><p>GTK+ Resource Files - behavior and style definitions.</p></td>
 
903
</tr>
 
904
</tbody>
 
905
</table></div>
 
906
<p>
 
907
</p>
 
908
</div>
 
909
</div>
 
910
<div class="footer">
 
911
<hr>
 
912
          Generated by GTK-Doc V1.18</div>
 
913
</body>
 
914
</html>
 
 
b'\\ No newline at end of file'