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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkaccelmap">
<refnamediv>
<refname>gtk.AccelMap</refname>
<refpurpose>Loadable keyboard accelerator specifications (new in PyGTK
2.10)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.AccelMap</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-add-entry">gtk.accel_map_add_entry</link></methodname>
<methodparam><parameter role="keyword">accel_path</parameter></methodparam>
<methodparam><parameter role="keyword">accel_key</parameter></methodparam>
<methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-lookup-entry">gtk.accel_map_lookup_entry</link></methodname>
<methodparam><parameter role="keyword">accel_path</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-change-entry">gtk.accel_map_change_entry</link></methodname>
<methodparam><parameter role="keyword">accel_path</parameter></methodparam>
<methodparam><parameter role="keyword">accel_key</parameter></methodparam>
<methodparam><parameter role="keyword">accel_mods</parameter></methodparam>
<methodparam><parameter role="keyword">replace</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--accel-map-foreach">gtk.accel_map_foreach</link></methodname>
<methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--accel-map-foreach-unfiltered">gtk.accel_map_foreach_unfiltered</link></methodname>
<methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--accel-map-get">gtk.accel_map_get</link></methodname>
<methodparam></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-load">gtk.accel_map_load</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-save">gtk.accel_map_save</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-load-fd">gtk.accel_map_load_fd</link></methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-save-fd">gtk.accel_map_save_fd</link></methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-lock-path">gtk.accel_map_lock_path</link></methodname>
<methodparam><parameter role="keyword">accel_path</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-unlock-path">gtk.accel_map_unlock_path</link></methodname>
<methodparam><parameter role="keyword">accel_path</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-map-add-filter">gtk.accel_map_add_filter</link></methodname>
<methodparam><parameter role="keyword">filter_pattern</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
<methodname><link
linkend="function-gtk--accel-groups-from-object">gtk.accel_groups_from_object</link></methodname>
<methodparam><parameter>object</parameter></methodparam>
</methodsynopsis>
</programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkaccelmap">gtk.AccelMap</link>
</synopsis>
</refsect1>
<refsect1 id="signal-prototypes-gtkaccelmap">
<title>gtk.AccelMap Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkaccelmap--changed">changed</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>object</parameter></methodparam>
<methodparam><parameter>accel_path</parameter></methodparam>
<methodparam><parameter>accel_key</parameter></methodparam>
<methodparam><parameter>accel_mods</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para></para>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gtk--accel-map-add-entry">
<title>gtk.accel_map_add_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_add_entry</methodname>
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
<methodparam><parameter
role="keyword">accel_key</parameter></methodparam>
<methodparam><parameter
role="keyword">accel_mods</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">accel_path</parameter> :</term>
<listitem><simpara>a valid accelerator path</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">accel_key</parameter> :</term>
<listitem><simpara>the accelerator key</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">accel_mods</parameter> :</term>
<listitem><simpara>the accelerator modifiers</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.4 and above.</para>
</note>
<para>The <function>gtk.accel_map_add_entry</function>() function
registers a new accelerator specified by <parameter>accel_key</parameter>
and <parameter>accel_mods</parameter> with the global accelerator map. The
accelerator will be associated with the accelerator path specified by
<parameter>accel_path</parameter>. This function should only be called once
per <parameter>accel_path</parameter> with the canonical
<parameter>accel_key</parameter> and <parameter>accel_mods</parameter> for
this path. To change the accelerator during runtime programatically, use the
<link
linkend="function-gtk--accel-map-change-entry"><function>gtk.accel_map_change_entry</function>()</link>
function. The accelerator path must consist of
"<WINDOWTYPE>/Category1/Category2/.../Action", where
<WINDOWTYPE> should be a unique application-specific identifier, that
corresponds to the kind of window the accelerator is being used in,
e.g. "Gimp-Image", "Abiword-Document" or "Gnumeric-Settings". The
Category1/.../Action portion is most appropriately chosen by the action the
accelerator triggers, i.e. for accelerators on menu items, choose the item's
menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a
full valid accelerator path may look like:
"<Gimp-Toolbox>/File/Dialogs/Tool Options...".</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-lookup-entry">
<title>gtk.accel_map_lookup_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_lookup_entry</methodname>
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">accel_path</parameter> :</term>
<listitem><simpara>a valid accelerator path</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a 2-tuple containing the keyval and modifier
mask corresponding to <parameter>accel_path</parameter> or
<literal>None</literal> if not valid</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_lookup_entry</function>() function
returns a 2-tuple containing the keyval and modifier mask corresponding to
the accelerator path specified by <parameter>accel_path</parameter> or
<literal>None</literal> if <parameter>accel_path</parameter> is not a valid
accelerator path.</para>
<para>The accelerator path must consist of
"<WINDOWTYPE>/Category1/Category2/.../Action", where <WINDOWTYPE> should be
a unique application-specific identifier, that corresponds to the kind of
window the accelerator is being used in, e.g. "Gimp-Image",
"Abiword-Document" or "Gnumeric-Settings". The Category1/.../Action portion
is most appropriately chosen by the action the accelerator triggers, i.e.
for accelerators on menu items, choose the item's menu path, e.g. "File/Save
As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator
path may look like: "<Gimp-Toolbox>/File/Dialogs/Tool Options...".</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-change-entry">
<title>gtk.accel_map_change_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_change_entry</methodname>
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
<methodparam><parameter
role="keyword">accel_key</parameter></methodparam>
<methodparam><parameter
role="keyword">accel_mods</parameter></methodparam>
<methodparam><parameter
role="keyword">replace</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">accel_path</parameter> :</term>
<listitem><simpara>a valid accelerator path</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">accel_key</parameter> :</term>
<listitem><simpara> the new accelerator key</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter
role="keyword">accel_mods</parameter> :</term>
<listitem><simpara> the new accelerator
modifiers</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">replace</parameter> :</term>
<listitem><simpara>if <literal>True</literal> other accelerators
may be deleted if conflicting</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the accelerator
could be changed</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_change_entry</function>() function
changes the keyval and modifier mask currently associated with the
accelerator path specified by <parameter>accel_path</parameter> to the
values specified by <parameter>accel_key</parameter> and
<parameter>accel_mods</parameter> respectively. Due to conflicts with other
accelerators, a change may not always be possible. If
<parameter>replace</parameter> is <literal>True</literal> the other
accelerators may be deleted to resolve such conflicts. A change will only
occur if all conflicts could be resolved (which might not be the case if
conflicting accelerators are locked). Successful changes are indicated by a
<literal>True</literal> return value.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-foreach">
<title>gtk.accel_map_foreach</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_foreach</methodname>
<methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">foreach_func</parameter> :</term>
<listitem><simpara>function to be executed for each accel map
entry which is not filtered out</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>data to be passed into
<parameter>foreach_func</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.10 and above.</para>
</note>
<para>Loops over the entries in the accelerator map whose accel path
doesn't match any of the filters added with the <link
linkend="function-gtk--accel-map-add-filter"><function>gtk.accel_map_add_filter</function>()</link>
function, and executes <parameter>foreach_func</parameter> on
each. The signature of <parameter>foreach_func</parameter> is:</para>
<programlisting>
def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):
</programlisting>
<para>where <parameter>accel_path</parameter>,
<parameter>accel_key</parameter> and <parameter>accel_mode</parameter>
describe the accel map accelerator entry and the
<parameter>changed</parameter> parameter indicates whether this
accelerator was changed during runtime ( and thus, would need saving
during an accelerator map dump). <parameter>user_data</parameter> is
<parameter>data</parameter> if <parameter>data</parameter> was
specified. See the <link
linkend="function-gtk--accel-map-add-entry"><function>gtk.accel_map_add_entry</function>()</link>
function for more information.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-foreach-unfiltered">
<title>gtk.accel_map_foreach_unfiltered</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_foreach_unfiltered</methodname>
<methodparam><parameter role="keyword">foreach_func</parameter></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">foreach_func</parameter> :</term>
<listitem><simpara>function to be executed for each accel map
entry</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>data to be passed into
<parameter>foreach_func</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.10 and above.</para>
</note>
<para>Loops over all entries in the accelerator map, and executes
<parameter>foreach_func</parameter> on each. The signature of
<parameter>foreach_func</parameter> is:</para>
<programlisting>
def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):
</programlisting>
<para>where <parameter>accel_path</parameter>,
<parameter>accel_key</parameter> and <parameter>accel_mode</parameter>
describe the accel map accelerator entry and the
<parameter>changed</parameter> parameter indicates whether this
accelerator was changed during runtime (thus, would need saving during
an accelerator map dump). <parameter>user_data</parameter> is
<parameter>data</parameter> if <parameter>data</parameter> was
specified. See the <link
linkend="function-gtk--accel-map-add-entry"><function>gtk.accel_map_add_entry</function>()</link>
function for more information.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-get">
<title>gtk.accel_map_get</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_get</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the global <link
linkend="class-gtkaccelmap"><classname>gtk.AccelMap</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.10 and above.</para>
</note>
<para>Gets the singleton global <link
linkend="class-gtkaccelmap"><classname>gtk.AccelMap</classname></link>
object. This object is useful only for notification of changes to the
accelerator map via the "changed" signal. it has no methods or
properties.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-load">
<title>gtk.accel_map_load</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_load</methodname>
<methodparam><parameter
role="keyword">file_name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">file_name</parameter> :</term>
<listitem><simpara>the file containing accelerator
specifications</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_load</function>() function parses
the file (specified by <parameter>file_name</parameter>) previously saved
with the <link
linkend="function-gtk--accel-map-save"><function>gtk.accel_map_save</function>()</link>
function for accelerator specifications, and propagates them
accordingly.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-save">
<title>gtk.accel_map_save</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_save</methodname>
<methodparam><parameter
role="keyword">file_name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">file_name</parameter> :</term>
<listitem><simpara>the file to save the accelerator specifications
in</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_save</function>() function saves
current accelerator specifications (accelerator path, key and modifiers) to
the file specified by <parameter>file_name</parameter>. The file is written
in a format suitable to be read back in by the <link
linkend="function-gtk--accel-map-load"><function>gtk.accel_map_load</function>()</link>
function.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-load-fd">
<title>gtk.accel_map_load_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_load_fd</methodname>
<methodparam><parameter
role="keyword">fd</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">fd</parameter> :</term>
<listitem><simpara>a Python file object or an integer file
descriptor</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_load_fd</function>() function loads
the accelerator map from the open Python file object specified by
<parameter>fd</parameter>. <parameter>fd</parameter> may also be an integer
file descriptor. See the <link
linkend="function-gtk--accel-map-load"><function>gtk.accel_map_load</function>()</link>
function.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-save-fd">
<title>gtk.accel_map_save_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_save_fd</methodname>
<methodparam><parameter
role="keyword">fd</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">fd</parameter> :</term>
<listitem><simpara>a Python file object or an integer file
descriptor</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_save_fd</function>() function saves
the accelerator map into the open Python file object specified by fd.
<parameter>fd</parameter> may also be an integer file descriptor. See the
<link
linkend="function-gtk--accel-map-save"><function>gtk.accel_map_save</function>()</link>
function.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-lock-path">
<title>gtk.accel_map_lock_path</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_lock_path</methodname>
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">accel_path</parameter> :</term>
<listitem><simpara>a valid accelerator path</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.4 and above.</para>
</note>
<para>The <function>gtk.accel_map_lock_path</function>() function
locks the accelerator path specified by
<parameter>accel_path</parameter>. If the accelerator map doesn't yet
contain an entry for <parameter>accel_path</parameter>, a new one is
created.</para>
<para>Locking an accelerator path prevents its accelerator from being
changed during runtime. A locked accelerator path can be unlocked by
the <link
linkend="function-gtk--accel-map-unlock-path"><function>gtk.accel_map_unlock_path</function>()</link>
function. Refer to the <link
linkend="function-gtk--accel-map-change-entry"><function>gtk.accel_map_change_entry</function>()</link>
function for information about runtime accelerator changes.</para>
<para>If called more than once, <parameter>accel_path</parameter>
remains locked until the <link
linkend="function-gtk--accel-map-unlock-path"><function>gtk.accel_map_unlock_path</function>()</link>
function has been called an equivalent number of times.</para>
<para>Note that locking of individual accelerator paths is independent
from locking the <link
linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
containing them. For runtime accelerator changes to be possible both
the accelerator path and its <link
linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
have to be unlocked.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-unlock-path">
<title>gtk.accel_map_unlock_path</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_unlock_path</methodname>
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">accel_path</parameter> :</term>
<listitem><simpara>a valid accelerator path</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.4 and above.</para>
</note>
<para>The <function>gtk.accel_map_unlock_path</function>() function
undoes the last call to the <link
linkend="function-gtk--accel-map-lock-path"><function>gtk.accel_map_lock_path</function>()</link>
function on the accelerator path specified by
<parameter>accel_path</parameter>. Refer to the <link
linkend="function-gtk--accel-map-lock-path"><function>gtk.accel_map_lock_path</function>()</link>
function for information about accelerator path locking.</para>
</refsect2>
<refsect2 id="function-gtk--accel-map-add-filter">
<title>gtk.accel_map_add_filter</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.accel_map_add_filter</methodname>
<methodparam><parameter
role="keyword">filter_pattern</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">filter_pattern</parameter> :</term>
<listitem><simpara>a glob-style pattern</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <function>gtk.accel_map_add_filter</function>() function
adds the filter pattern specified by
<parameter>filter_pattern</parameter> to the global list of accel path
filters. The pattern specified by
<parameter>filter_pattern</parameter> contain '*' and '?' wildcards
with similar semantics as the Python <filename>glob.py</filename> and
<filename>fnmatch.py</filename> modules: '*' matches an arbitrary,
possibly empty, string, '?' matches an arbitrary character. Note that
in contrast to <filename>glob.py</filename>, the '/' character can be
matched by the wildcards, there are no '[...]' character ranges and
'*' and '?' can not be escaped to include them literally in a
pattern. Accelerator map entries whose accelerator path matches one of
the filters are skipped by the <link
linkend="function-gtk--accel-map-foreach"><function>gtk.accel_map_foreach</function>()</link>
function. This function is intended for <literal>PyGTK</literal>
modules that create their own menus, but don't want them to be saved
into the applications accelerator map dump.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkaccelmap--changed">
<title>The "changed" gtk.AccelMap Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>object</parameter></methodparam>
<methodparam><parameter>accel_path</parameter></methodparam>
<methodparam><parameter>accel_key</parameter></methodparam>
<methodparam><parameter>accel_mods</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>object</parameter> :</term>
<listitem><simpara>the global accel map object</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>accel_path</parameter> :</term>
<listitem><simpara>the path of the accelerator that
changed</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>accel_key</parameter> :</term>
<listitem><simpara>the key value for the new
accelerator</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>accel_mods</parameter> :</term>
<listitem><simpara>the modifier mask for the new
accelerator</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.4 and above.</para>
</note>
<para>Notifies of a change in the global accelerator map. The path is
also used as the detail for the signal, so it is possible to connect
to changed::<replaceable>accel_path</replaceable>.</para>
</refsect2>
</refsect1>
</refentry>
|
