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