1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
<title>Bindings</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
<link rel="start" href="index.html" title="GTK+ 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="gtk-Standard-Enumerations.html" title="Standard Enumerations">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
14
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
15
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
16
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
17
<link rel="chapter" href="ch02.html" title="Widget Gallery">
18
<link rel="chapter" href="WindowWidgets.html" title="Windows">
19
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
20
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
21
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
22
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
23
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
24
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
25
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
26
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
27
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
28
<link rel="chapter" href="Ornaments.html" title="Ornaments">
29
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
30
<link rel="chapter" href="Printing.html" title="Printing">
31
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
32
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
33
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
34
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
35
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
36
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
37
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
38
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
39
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
40
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
41
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
42
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
43
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
44
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
45
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
46
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
47
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
48
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
49
<link rel="glossary" href="glossary.html" title="Glossary">
50
<link rel="index" href="ix01.html" title="Index">
51
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
52
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
53
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
54
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
55
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
56
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
58
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
59
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
61
<td><a accesskey="p" href="GtkSettings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
62
<td><a accesskey="u" href="gtkbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
63
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
64
<th width="100%" align="center">GTK+ Reference Manual</th>
65
<td><a accesskey="n" href="gtk-Standard-Enumerations.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
67
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2744001" class="shortcut">Top</a>
69
<a href="#id2744512" class="shortcut">Description</a></nobr></td></tr>
71
<div class="refentry" lang="en">
72
<a name="gtk-Bindings"></a><div class="titlepage"></div>
73
<div class="refnamediv"><table width="100%"><tr>
76
<a name="id2744001"></a><span class="refentrytitle">Bindings</span>
78
<p>Bindings — Key bindings for individual widgets</p>
80
<td valign="top" align="right"></td>
82
<div class="refsynopsisdiv">
84
<pre class="synopsis">
86
#include <gtk/gtk.h>
89
<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>;
90
<a href="gtk-Bindings.html#GtkBindingEntry">GtkBindingEntry</a>;
91
<a href="gtk-Bindings.html#GtkBindingSignal">GtkBindingSignal</a>;
92
<a href="gtk-Bindings.html#GtkBindingArg">GtkBindingArg</a>;
93
<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* <a href="gtk-Bindings.html#gtk-binding-set-new">gtk_binding_set_new</a> (const gchar *set_name);
94
<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* <a href="gtk-Bindings.html#gtk-binding-set-by-class">gtk_binding_set_by_class</a> (gpointer object_class);
95
<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* <a href="gtk-Bindings.html#gtk-binding-set-find">gtk_binding_set_find</a> (const gchar *set_name);
96
gboolean <a href="gtk-Bindings.html#gtk-bindings-activate">gtk_bindings_activate</a> (<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object,
99
href="../gdk/gdk-Windows.html#GdkModifierType"
100
>GdkModifierType</a> modifiers);
101
gboolean <a href="gtk-Bindings.html#gtk-bindings-activate-event">gtk_bindings_activate_event</a> (<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object,
103
href="../gdk/gdk-Event-Structures.html#GdkEventKey"
104
>GdkEventKey</a> *event);
105
gboolean <a href="gtk-Bindings.html#gtk-binding-set-activate">gtk_binding_set_activate</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
108
href="../gdk/gdk-Windows.html#GdkModifierType"
109
>GdkModifierType</a> modifiers,
110
<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object);
111
#define <a href="gtk-Bindings.html#gtk-binding-entry-add">gtk_binding_entry_add</a>
112
void <a href="gtk-Bindings.html#gtk-binding-entry-clear">gtk_binding_entry_clear</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
115
href="../gdk/gdk-Windows.html#GdkModifierType"
116
>GdkModifierType</a> modifiers);
117
void <a href="gtk-Bindings.html#gtk-binding-entry-add-signal">gtk_binding_entry_add_signal</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
120
href="../gdk/gdk-Windows.html#GdkModifierType"
121
>GdkModifierType</a> modifiers,
122
const gchar *signal_name,
125
void <a href="gtk-Bindings.html#gtk-binding-set-add-path">gtk_binding_set_add_path</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
126
<a href="gtk-Standard-Enumerations.html#GtkPathType">GtkPathType</a> path_type,
127
const gchar *path_pattern,
128
<a href="gtk-Standard-Enumerations.html#GtkPathPriorityType">GtkPathPriorityType</a> priority);
129
void <a href="gtk-Bindings.html#gtk-binding-entry-remove">gtk_binding_entry_remove</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
132
href="../gdk/gdk-Windows.html#GdkModifierType"
133
>GdkModifierType</a> modifiers);
134
void <a href="gtk-Bindings.html#gtk-binding-entry-add-signall">gtk_binding_entry_add_signall</a> (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
137
href="../gdk/gdk-Windows.html#GdkModifierType"
138
>GdkModifierType</a> modifiers,
139
const gchar *signal_name,
140
GSList *binding_args);
141
guint <a href="gtk-Bindings.html#gtk-binding-parse-binding">gtk_binding_parse_binding</a> (GScanner *scanner);
144
<div class="refsect1" lang="en">
145
<a name="id2744512"></a><h2>Description</h2>
150
<div class="refsect1" lang="en">
151
<a name="id2744526"></a><h2>Details</h2>
152
<div class="refsect2" lang="en">
153
<a name="id2744536"></a><h3>
154
<a name="GtkBindingSet"></a>GtkBindingSet</h3>
155
<a class="indexterm" name="id2744549"></a><pre class="programlisting">typedef struct {
158
GSList *widget_path_pspecs;
159
GSList *widget_class_pspecs;
160
GSList *class_branch_pspecs;
161
GtkBindingEntry *entries;
162
GtkBindingEntry *current;
163
guint parsed : 1; /* From RC content */
171
<div class="refsect2" lang="en">
172
<a name="id2744569"></a><h3>
173
<a name="GtkBindingEntry"></a>GtkBindingEntry</h3>
174
<a class="indexterm" name="id2744582"></a><pre class="programlisting">typedef struct {
178
GdkModifierType modifiers;
180
GtkBindingSet *binding_set;
182
guint in_emission : 1;
183
GtkBindingEntry *set_next;
184
GtkBindingEntry *hash_next;
185
GtkBindingSignal *signals;
193
<div class="refsect2" lang="en">
194
<a name="id2744601"></a><h3>
195
<a name="GtkBindingSignal"></a>GtkBindingSignal</h3>
196
<a class="indexterm" name="id2744614"></a><pre class="programlisting">typedef struct {
197
GtkBindingSignal *next;
208
<div class="refsect2" lang="en">
209
<a name="id2744631"></a><h3>
210
<a name="GtkBindingArg"></a>GtkBindingArg</h3>
211
<a class="indexterm" name="id2744644"></a><pre class="programlisting">typedef struct {
225
<div class="refsect2" lang="en">
226
<a name="id2744661"></a><h3>
227
<a name="gtk-binding-set-new"></a>gtk_binding_set_new ()</h3>
228
<a class="indexterm" name="id2744675"></a><pre class="programlisting"><a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* gtk_binding_set_new (const gchar *set_name);</pre>
232
<div class="variablelist"><table border="0">
233
<col align="left" valign="top">
236
<td><span class="term"><em class="parameter"><code>set_name</code></em> :</span></td>
241
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
251
<div class="refsect2" lang="en">
252
<a name="id2744731"></a><h3>
253
<a name="gtk-binding-set-by-class"></a>gtk_binding_set_by_class ()</h3>
254
<a class="indexterm" name="id2744744"></a><pre class="programlisting"><a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* gtk_binding_set_by_class (gpointer object_class);</pre>
258
<div class="variablelist"><table border="0">
259
<col align="left" valign="top">
262
<td><span class="term"><em class="parameter"><code>object_class</code></em> :</span></td>
267
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
277
<div class="refsect2" lang="en">
278
<a name="id2744801"></a><h3>
279
<a name="gtk-binding-set-find"></a>gtk_binding_set_find ()</h3>
280
<a class="indexterm" name="id2744814"></a><pre class="programlisting"><a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a>* gtk_binding_set_find (const gchar *set_name);</pre>
284
<div class="variablelist"><table border="0">
285
<col align="left" valign="top">
288
<td><span class="term"><em class="parameter"><code>set_name</code></em> :</span></td>
293
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
303
<div class="refsect2" lang="en">
304
<a name="id2744871"></a><h3>
305
<a name="gtk-bindings-activate"></a>gtk_bindings_activate ()</h3>
306
<a class="indexterm" name="id2744885"></a><pre class="programlisting">gboolean gtk_bindings_activate (<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object,
309
href="../gdk/gdk-Windows.html#GdkModifierType"
310
>GdkModifierType</a> modifiers);</pre>
314
<div class="variablelist"><table border="0">
315
<col align="left" valign="top">
318
<td><span class="term"><em class="parameter"><code>object</code></em> :</span></td>
323
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
328
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
333
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
343
<div class="refsect2" lang="en">
344
<a name="id2744984"></a><h3>
345
<a name="gtk-bindings-activate-event"></a>gtk_bindings_activate_event ()</h3>
346
<a class="indexterm" name="id2744998"></a><pre class="programlisting">gboolean gtk_bindings_activate_event (<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object,
348
href="../gdk/gdk-Event-Structures.html#GdkEventKey"
349
>GdkEventKey</a> *event);</pre>
351
Looks up key bindings for <em class="parameter"><code>object</code></em> to find one matching
352
<em class="parameter"><code>event</code></em>, and if one was found, activate it.</p>
356
<div class="variablelist"><table border="0">
357
<col align="left" valign="top">
360
<td><span class="term"><em class="parameter"><code>object</code></em> :</span></td>
361
<td> a <a href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> (generally must be a widget)
365
<td><span class="term"><em class="parameter"><code>event</code></em> :</span></td>
367
href="../gdk/gdk-Event-Structures.html#GdkEventKey"
368
><span class="type">GdkEventKey</span></a>
372
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
373
<td> <code class="literal">TRUE</code> if a matching key binding was found
380
<div class="refsect2" lang="en">
381
<a name="id2745118"></a><h3>
382
<a name="gtk-binding-set-activate"></a>gtk_binding_set_activate ()</h3>
383
<a class="indexterm" name="id2745131"></a><pre class="programlisting">gboolean gtk_binding_set_activate (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
386
href="../gdk/gdk-Windows.html#GdkModifierType"
387
>GdkModifierType</a> modifiers,
388
<a href="GtkObject.html" title="GtkObject">GtkObject</a> *object);</pre>
392
<div class="variablelist"><table border="0">
393
<col align="left" valign="top">
396
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
401
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
406
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
411
<td><span class="term"><em class="parameter"><code>object</code></em> :</span></td>
416
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
426
<div class="refsect2" lang="en">
427
<a name="id2745253"></a><h3>
428
<a name="gtk-binding-entry-add"></a>gtk_binding_entry_add</h3>
429
<a class="indexterm" name="id2745266"></a><pre class="programlisting">#define gtk_binding_entry_add gtk_binding_entry_clear
436
<div class="refsect2" lang="en">
437
<a name="id2745282"></a><h3>
438
<a name="gtk-binding-entry-clear"></a>gtk_binding_entry_clear ()</h3>
439
<a class="indexterm" name="id2745295"></a><pre class="programlisting">void gtk_binding_entry_clear (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
442
href="../gdk/gdk-Windows.html#GdkModifierType"
443
>GdkModifierType</a> modifiers);</pre>
447
<div class="variablelist"><table border="0">
448
<col align="left" valign="top">
451
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
456
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
461
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
471
<div class="refsect2" lang="en">
472
<a name="id2745385"></a><h3>
473
<a name="gtk-binding-entry-add-signal"></a>gtk_binding_entry_add_signal ()</h3>
474
<a class="indexterm" name="id2745398"></a><pre class="programlisting">void gtk_binding_entry_add_signal (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
477
href="../gdk/gdk-Windows.html#GdkModifierType"
478
>GdkModifierType</a> modifiers,
479
const gchar *signal_name,
485
<div class="variablelist"><table border="0">
486
<col align="left" valign="top">
489
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
494
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
499
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
504
<td><span class="term"><em class="parameter"><code>signal_name</code></em> :</span></td>
509
<td><span class="term"><em class="parameter"><code>n_args</code></em> :</span></td>
514
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
524
<div class="refsect2" lang="en">
525
<a name="id2745546"></a><h3>
526
<a name="gtk-binding-set-add-path"></a>gtk_binding_set_add_path ()</h3>
527
<a class="indexterm" name="id2745559"></a><pre class="programlisting">void gtk_binding_set_add_path (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
528
<a href="gtk-Standard-Enumerations.html#GtkPathType">GtkPathType</a> path_type,
529
const gchar *path_pattern,
530
<a href="gtk-Standard-Enumerations.html#GtkPathPriorityType">GtkPathPriorityType</a> priority);</pre>
534
<div class="variablelist"><table border="0">
535
<col align="left" valign="top">
538
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
543
<td><span class="term"><em class="parameter"><code>path_type</code></em> :</span></td>
548
<td><span class="term"><em class="parameter"><code>path_pattern</code></em> :</span></td>
553
<td><span class="term"><em class="parameter"><code>priority</code></em> :</span></td>
563
<div class="refsect2" lang="en">
564
<a name="id2745671"></a><h3>
565
<a name="gtk-binding-entry-remove"></a>gtk_binding_entry_remove ()</h3>
566
<a class="indexterm" name="id2745684"></a><pre class="programlisting">void gtk_binding_entry_remove (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
569
href="../gdk/gdk-Windows.html#GdkModifierType"
570
>GdkModifierType</a> modifiers);</pre>
574
<div class="variablelist"><table border="0">
575
<col align="left" valign="top">
578
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
583
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
588
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
598
<div class="refsect2" lang="en">
599
<a name="id2745774"></a><h3>
600
<a name="gtk-binding-entry-add-signall"></a>gtk_binding_entry_add_signall ()</h3>
601
<a class="indexterm" name="id2745788"></a><pre class="programlisting">void gtk_binding_entry_add_signall (<a href="gtk-Bindings.html#GtkBindingSet">GtkBindingSet</a> *binding_set,
604
href="../gdk/gdk-Windows.html#GdkModifierType"
605
>GdkModifierType</a> modifiers,
606
const gchar *signal_name,
607
GSList *binding_args);</pre>
611
<div class="variablelist"><table border="0">
612
<col align="left" valign="top">
615
<td><span class="term"><em class="parameter"><code>binding_set</code></em> :</span></td>
620
<td><span class="term"><em class="parameter"><code>keyval</code></em> :</span></td>
625
<td><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></td>
630
<td><span class="term"><em class="parameter"><code>signal_name</code></em> :</span></td>
635
<td><span class="term"><em class="parameter"><code>binding_args</code></em> :</span></td>
645
<div class="refsect2" lang="en">
646
<a name="id2745921"></a><h3>
647
<a name="gtk-binding-parse-binding"></a>gtk_binding_parse_binding ()</h3>
648
<a class="indexterm" name="id2745935"></a><pre class="programlisting">guint gtk_binding_parse_binding (GScanner *scanner);</pre>
652
<div class="variablelist"><table border="0">
653
<col align="left" valign="top">
656
<td><span class="term"><em class="parameter"><code>scanner</code></em> :</span></td>
661
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>