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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.AccelGroup</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="class-gtkaboutdialog.html" title="gtk.AboutDialog"><link rel="next" href="class-gtkaccellabel.html" title="gtk.AccelLabel"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.AccelGroup</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkaboutdialog.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkaccellabel.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkaccelgroup"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.AccelGroup</h2><p>gtk.AccelGroup — a group of accelerators for a Window hierarchy</p></div><div class="refsect1" lang="en"><a name="id3338090"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AccelGroup</span></span>(<span class="ooclass"><span class="classname"><a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtkaccelgroup.html#constructor-gtkaccelgroup" title="Constructor">gtk.AccelGroup</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--lock" title="gtk.AccelGroup.lock">lock</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--unlock" title="gtk.AccelGroup.unlock">unlock</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--connect-group" title="gtk.AccelGroup.connect_group">connect</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_flags</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>callback</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--connect-group" title="gtk.AccelGroup.connect_group">connect_group</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_flags</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>callback</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--connect-by-path" title="gtk.AccelGroup.connect_by_path">connect_by_path</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>callback</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#method-gtkaccelgroup--disconnect-key" title="gtk.AccelGroup.disconnect_key">disconnect_key</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>)</code><br></pre></td></tr></table><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>
<code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-valid" title="gtk.accelerator_valid">gtk.accelerator_valid</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>keyval</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>modifiers</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-parse" title="gtk.accelerator_parse">gtk.accelerator_parse</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-name" title="gtk.accelerator_name">gtk.accelerator_name</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_mods</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-set-default-mod-mask" title="gtk.accelerator_set_default_mod_mask">gtk.accelerator_set_default_mod_mask</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>default_mod_mask</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-get-default-mod-mask" title="gtk.accelerator_get_default_mod_mask">gtk.accelerator_get_default_mod_mask</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accelerator-get-label" title="gtk.accelerator_get_label">gtk.accelerator_get_label</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_mods</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-add-entry" title="gtk.accel_map_add_entry">gtk.accel_map_add_entry</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-lookup-entry" title="gtk.accel_map_lookup_entry">gtk.accel_map_lookup_entry</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-change-entry" title="gtk.accel_map_change_entry">gtk.accel_map_change_entry</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>replace</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-load" title="gtk.accel_map_load">gtk.accel_map_load</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>file_name</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-save" title="gtk.accel_map_save">gtk.accel_map_save</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>file_name</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-load-fd" title="gtk.accel_map_load_fd">gtk.accel_map_load_fd</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>fd</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-save-fd" title="gtk.accel_map_save_fd">gtk.accel_map_save_fd</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>fd</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-lock-path" title="gtk.accel_map_lock_path">gtk.accel_map_lock_path</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-unlock-path" title="gtk.accel_map_unlock_path">gtk.accel_map_unlock_path</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-map-add-filter" title="gtk.accel_map_add_filter">gtk.accel_map_add_filter</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>filter_pattern</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtkaccelgroup.html#function-gtk--accel-groups-from-object" title="gtk.accel_groups_from_object">gtk.accel_groups_from_object</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>object</tt></i></span></span>)</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3337606"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">
+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
+-- <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup">gtk.AccelGroup</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3337588"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkaccelgroup.html#signal-gtkaccelgroup--accel-activate" title='The "accel-activate" gtk.AccelGroup Signal'>accel-activate</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>accelgroup</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>acceleratable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_key</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_mods</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkaccelgroup.html#signal-gtkaccelgroup--accel-changed" title='The "accel-changed" gtk.AccelGroup Signal'>accel-changed</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>accelgroup</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_key</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_mods</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>closure</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3337481"></a><h2>Description</h2><p>A <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
object groups all the accelerators for the associated window hierarchy
(either <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a> (or a
descendant) or <a href="class-gtkmenushell.html" title="gtk.MenuShell"><tt class="classname">gtk.MenuShell</tt></a> (or
a descendant)). Once the <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
is associated with a window or menu (using <a href="class-gtkwindow.html#method-gtkwindow--add-accel-group" title="gtk.Window.add_accel_group"><tt class="methodname">gtk.Window.add_accel_group</tt>()</a>
or <a href="class-gtkmenu.html#method-gtkmenu--set-accel-group" title="gtk.Menu.set_accel_group"><tt class="methodname">gtk.Menu.set_accel_group</tt>()</a>),
accelerators can be added to the widget or one of its children by using
<a href="class-gtkwidget.html#method-gtkwidget--add-accelerator" title="gtk.Widget.add_accelerator"><tt class="methodname">gtk.Widget.add_accelerator</tt>()</a>
. Accelerators can also be added by using a <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.ItemFactory</tt></a>.</p><p>Note that accelerators are different from mnemonics. Accelerators
are shortcuts for activating a menu item; they appear alongside the menu
item they're a shortcut for. For example
<span><b class="keycap">Ctrl</b></span>+<span><b class="keycap">Q</b></span> might appear alongside the
<span class="guimenu">Files</span>-><span class="guimenuitem">Quit</span> menu item. Mnemonics are shortcuts for GUI elements such
as text entries or buttons; they appear as underlined characters. Of course,
menu items can have both accelerators and mnemonics.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkaccelgroup"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.AccelGroup</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>an AccelGroup object</td></tr></tbody></table><p>Creates a new <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
object.</p></div><div class="refsect1" lang="en"><a name="id3337359"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkaccelgroup--lock"></a><h3>gtk.AccelGroup.lock</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">lock</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">lock</tt>() method locks the accelerator
group. preventing its accelerators from being changed during runtime. Refer
to <a href="class-gtkaccelgroup.html#function-gtk--accel-map-change-entry" title="gtk.accel_map_change_entry"><tt class="function">gtk.accel_map_change_entry</tt>()</a>
about runtime accelerator changes.</p><p>If called more than once, the accelerator group remains locked
until <a href="class-gtkaccelgroup.html#method-gtkaccelgroup--unlock" title="gtk.AccelGroup.unlock"><tt class="methodname">gtk.AccelGroup.unlock</tt>()</a>
has been called an equivalent number of times.</p></div><div class="refsect2" lang="en"><a name="method-gtkaccelgroup--unlock"></a><h3>gtk.AccelGroup.unlock</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">unlock</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">unlock</tt>() method undoes the last
call to <a href="class-gtkaccelgroup.html#method-gtkaccelgroup--lock" title="gtk.AccelGroup.lock"><tt class="methodname">gtk.AccelGroup.lock</tt>()</a>
for this accelerator group.</p></div><div class="refsect2" lang="en"><a name="method-gtkaccelgroup--connect-group"></a><h3>gtk.AccelGroup.connect_group</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">connect</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_flags</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>callback</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_key</tt></b>:</span></td><td>key value of the
accelerator</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_mods</tt></b>:</span></td><td>modifier combination of the
accelerator</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_flags</tt></b>:</span></td><td>a flag mask to configure this
accelerator</td></tr><tr><td><span class="term"><b class="parameter"><tt>callback</tt></b>:</span></td><td>a function or method to be executed upon
accelerator activation</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 as
<i class="parameter"><tt>connect</tt></i>() and was changed in PyGTK 2.4 and
above to <i class="parameter"><tt>connect_group</tt></i>() to avoid conflict
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">gobject.GObject.connect</tt>()</a>
method.</p></div><p>The <tt class="methodname">connect_group</tt>() method installs an
accelerator in the accelerator group. When the accelerator group is being
activated, the function (or method) specified by
<i class="parameter"><tt>callback</tt></i> will be invoked if the accelerator key and
modifier key match those specified by <i class="parameter"><tt>accel_key</tt></i> and
<i class="parameter"><tt>accel_mods</tt></i>.</p><p>The value of <i class="parameter"><tt>modifier</tt></i> is a combination of
the <a href="gdk-constants.html#gdk-modifier-constants">GDK Modifier Constants</a>. <i class="parameter"><tt>accel_flags</tt></i>
is a combination of <tt class="literal">gtk.ACCEL_VISIBLE</tt> and
<tt class="literal">gtk.ACCEL_LOCKED</tt>.</p><p>The <i class="parameter"><tt>callback</tt></i> function is defined as:</p><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
def callback(accel_group, acceleratable, keyval, modifier)
</pre></td></tr></table><p>where <i class="parameter"><tt>accel_group</tt></i> is the accelerator
group, <i class="parameter"><tt>acceleratable</tt></i> is the object that the
<i class="parameter"><tt>accel_group</tt></i> is attached to (e.g. a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>),
<i class="parameter"><tt>keyval</tt></i> is the accelerator key and
<i class="parameter"><tt>modifier</tt></i> is the key
modifier. <i class="parameter"><tt>callback</tt></i> returns <tt class="literal">TRUE</tt> if
the accelerator was handled by <i class="parameter"><tt>callback</tt></i>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Due to implementation details, a single function or method
can only be connected to one accelerator group.</p></div></div><div class="refsect2" lang="en"><a name="method-gtkaccelgroup--connect-by-path"></a><h3>gtk.AccelGroup.connect_by_path</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">connect_by_path</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>callback</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>path used for determining key and
modifiers.</td></tr><tr><td><span class="term"><b class="parameter"><tt>callback</tt></b>:</span></td><td>function or method to be executed upon accelerator
activation</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above</p></div><p>The <tt class="methodname">connect_by_path</tt>() method installs
an accelerator in the accelerator group, using an accelerator path to look
up the appropriate key and modifiers (see the function <a href="class-gtkaccelgroup.html#function-gtk--accel-map-add-entry" title="gtk.accel_map_add_entry"><tt class="function">gtk.accel_map_add_entry</tt>()</a>). When
the accelerator group is being activated, the function (or method) specified
by <i class="parameter"><tt>callback</tt></i> will be invoked if the
<i class="parameter"><tt>accel_key</tt></i> and <i class="parameter"><tt>accel_mods</tt></i> that
cause the activation match the key and modifiers for the accelerator path
specified by <i class="parameter"><tt>accel_path</tt></i>.</p><p>The <i class="parameter"><tt>callback</tt></i> function is defined as:</p><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
def callback(accel_group, acceleratable, keyval, modifier)
</pre></td></tr></table><p>where <i class="parameter"><tt>accel_group</tt></i> is the accelerator
group, <i class="parameter"><tt>acceleratable</tt></i> is the object that the
<i class="parameter"><tt>accel_group</tt></i> is attached to (e.g. a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a>),
<i class="parameter"><tt>keyval</tt></i> is the accelerator key and
<i class="parameter"><tt>modifier</tt></i> is the key
modifier. <i class="parameter"><tt>callback</tt></i> returns <tt class="literal">TRUE</tt> if
the accelerator was handled by <i class="parameter"><tt>callback</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gtkaccelgroup--disconnect-key"></a><h3>gtk.AccelGroup.disconnect_key</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">disconnect_key</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_key</tt></b>:</span></td><td>key value of the
accelerator</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_mods</tt></b>:</span></td><td>modifier combination of the
accelerator</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if there was an
accelerator which was removed, <tt class="literal">FALSE</tt>
otherwise</td></tr></tbody></table><p>The <tt class="methodname">disconnect</tt>() method removes a
previously installed accelerator specified by
<i class="parameter"><tt>accel_key</tt></i> and <i class="parameter"><tt>accel_mods</tt></i> from
the accelerator group.</p></div></div><div class="refsect1" lang="en"><a name="id3094694"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--accelerator-valid"></a><h3>gtk.accelerator_valid</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_valid</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>keyval</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>modifiers</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>keyval</tt></b>:</span></td><td>a key value</td></tr><tr><td><span class="term"><b class="parameter"><tt>modifiers</tt></b>:</span></td><td>a modifier mask</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the accelerator is
valid</td></tr></tbody></table><p>The <tt class="function">gtk.accelerator_valid</tt>() function
returns <tt class="literal">TRUE</tt> if the specified
<i class="parameter"><tt>keyval</tt></i> and <i class="parameter"><tt>modifiers</tt></i>
constitute a valid keyboard accelerator. For example, the
<tt class="literal">ord('a')</tt> keyval plus
<tt class="literal">gtk.gdk.CONTROL_MASK</tt> is valid - this is a <span><b class="keycap">Control</b></span>+<span><b class="keycap">a</b></span>
accelerator. The value of <i class="parameter"><tt>modifiers</tt></i> is a combination
of the <a href="gdk-constants.html#gdk-modifier-constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accelerator-parse"></a><h3>gtk.accelerator_parse</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_parse</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accelerator</tt></b>:</span></td><td>a string representing an
accelerator</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 2-tuple containing the keyval and modifier
mask of the accelerator</td></tr></tbody></table><p>The <tt class="function">gtk.accelerator_parse</tt>() function parses
the specified <i class="parameter"><tt>accelerator</tt></i> string and returns a
2-tuple containing the keyval and modifier mask corresponding to
<i class="parameter"><tt>accelerator</tt></i>. The format looks like "<Control>a" or
"<Shift><Alt>F1" or "<Release>z" (the last one is for key release). The
parser is fairly liberal and allows lower or upper case, and also
abbreviations such as "<Ctl>" and "<Ctrl>". If the parse fails, the tuple
values will both be 0 (zero). See the <a href="class-gtkaccelgroup.html#function-gtk--accelerator-valid" title="gtk.accelerator_valid"><tt class="function">gtk.accelerator_valid</tt>()</a>
function for more details.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accelerator-name"></a><h3>gtk.accelerator_name</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_name</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt></tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accelerator_key</tt></b>:</span></td><td>a key value</td></tr><tr><td><span class="term"><b class="parameter"><tt>accelerator_mods</tt></b>:</span></td><td>a modifier mask</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string representing the accelerator or
<tt class="literal">None</tt> if not a valid accelerator</td></tr></tbody></table><p>The <tt class="function">gtk.accelerator_name</tt>() function
converts the accelerator keyval and modifier mask (specified by
<i class="parameter"><tt>accelerator_key</tt></i> and
<i class="parameter"><tt>accelerator_mods</tt></i>) into a string parseable by the
<a href="class-gtkaccelgroup.html#function-gtk--accelerator-parse" title="gtk.accelerator_parse"><tt class="function">gtk.accelerator_parse</tt>()</a>
function. For example, if you pass in <tt class="literal">ord('q')</tt> and
<tt class="literal">gtk.gdk.CONTROL_MASK</tt>, this function returns
"<Control>q".</p></div><div class="refsect2" lang="en"><a name="function-gtk--accelerator-set-default-mod-mask"></a><h3>gtk.accelerator_set_default_mod_mask</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_set_default_mod_mask</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>default_mod_mask</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>default_mod_mask</tt></b>:</span></td><td>the new default accelerator modifier
mask</td></tr></tbody></table><p>The <tt class="function">gtk.accelerator_set_default_mod_mask</tt>()
function sets the modifiers (specified by
<i class="parameter"><tt>default_mod_mask</tt></i>) that will be considered significant
for keyboard accelerators. The default mod mask is
<tt class="literal">gtk.gdk.CONTROL_MASK</tt> |
<tt class="literal">gtk.gdk.SHIFT_MASK</tt> |
<tt class="literal">gtk.gdk.MOD1_MASK</tt>, that is, <span><b class="keycap">Control</b></span>,
<span><b class="keycap">Shift</b></span>, and <span><b class="keycap">Alt</b></span>. Other modifiers will by
default be ignored by <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>.
You must include at least the three default modifiers in any value you pass
to this function. The default mod mask should be changed on application
startup, before using any accelerator groups. The value of
<i class="parameter"><tt>default_mod_mask</tt></i> is a combination of the <a href="gdk-constants.html#gdk-modifier-constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accelerator-get-default-mod-mask"></a><h3>gtk.accelerator_get_default_mod_mask</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_get_default_mod_mask</span>()</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the default accelerator modifier
mask</td></tr></tbody></table><p>The <tt class="function">gtk.accelerator_get_default_mod_mask</tt>()
function returns the default accelerator modifier mask as set by the <a href="class-gtkaccelgroup.html#function-gtk--accelerator-set-default-mod-mask" title="gtk.accelerator_set_default_mod_mask"><tt class="function">gtk.accelerator_set_default_mod_mask</tt>()</a>
function. See the <a href="class-gtkaccelgroup.html#function-gtk--accelerator-set-default-mod-mask" title="gtk.accelerator_set_default_mod_mask"><tt class="function">gtk.accelerator_set_default_mod_mask</tt>()</a>
function for more detail on modifier masks.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accelerator-get-label"></a><h3>gtk.accelerator_get_label</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accelerator_get_label</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accelerator_mods</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accelerator_key</tt></b>:</span></td><td>a key value</td></tr><tr><td><span class="term"><b class="parameter"><tt>accelerator_mods</tt></b>:</span></td><td>a modifier mask</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a string representing the
accelerator</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.6 and above.</p></div><p>The <tt class="function">gtk.accelerator_get_label</tt>() function
converts the accelerator keyval and modifier mask specified by
<i class="parameter"><tt>accelerator_key</tt></i> and
<i class="parameter"><tt>accelerator_mods</tt></i> respectively into a string which can
be used to represent the accelerator to the user. The value of
<i class="parameter"><tt>accelerator_mods</tt></i> is a combination of the <a href="gdk-constants.html#gdk-modifier-constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-add-entry"></a><h3>gtk.accel_map_add_entry</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_entry</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>a valid accelerator path</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_key</tt></b>:</span></td><td>the accelerator key</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_mods</tt></b>:</span></td><td>the accelerator modifiers</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <tt class="function">gtk.accel_map_add_entry</tt>() function
registers a new accelerator specified by <i class="parameter"><tt>accel_key</tt></i>
and <i class="parameter"><tt>accel_mods</tt></i> with the global accelerator map. The
accelerator will be associated with the accelerator path specified by
<i class="parameter"><tt>accel_path</tt></i>. This function should only be called once
per <i class="parameter"><tt>accel_path</tt></i> with the canonical
<i class="parameter"><tt>accel_key</tt></i> and <i class="parameter"><tt>accel_mods</tt></i> for
this path. To change the accelerator during runtime programatically, use the
<a href="class-gtkaccelgroup.html#function-gtk--accel-map-change-entry" title="gtk.accel_map_change_entry"><tt class="function">gtk.accel_map_change_entry</tt>()</a>
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...".</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-lookup-entry"></a><h3>gtk.accel_map_lookup_entry</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lookup_entry</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>a valid accelerator path</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 2-tuple containing the keyval and modifier
mask corresponding to <i class="parameter"><tt>accel_path</tt></i> or
<tt class="literal">None</tt> if not valid</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_lookup_entry</tt>() function
returns a 2-tuple containing the keyval and modifier mask corresponding to
the accelerator path specified by <i class="parameter"><tt>accel_path</tt></i> or
<tt class="literal">None</tt> if <i class="parameter"><tt>accel_path</tt></i> is not a valid
accelerator path.</p><p>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...".</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-change-entry"></a><h3>gtk.accel_map_change_entry</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_change_entry</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_key</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_mods</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>replace</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>a valid accelerator path</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_key</tt></b>:</span></td><td> the new accelerator key</td></tr><tr><td><span class="term"><b class="parameter"><tt>accel_mods</tt></b>:</span></td><td> the new accelerator
modifiers</td></tr><tr><td><span class="term"><b class="parameter"><tt>replace</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> other accelerators
may be deleted if conflicting</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the accelerator
could be changed</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_change_entry</tt>() function
changes the keyval and modifier mask currently associated with the
accelerator path specified by <i class="parameter"><tt>accel_path</tt></i> to the
values specified by <i class="parameter"><tt>accel_key</tt></i> and
<i class="parameter"><tt>accel_mods</tt></i> respectively. Due to conflicts with other
accelerators, a change may not always be possible. If
<i class="parameter"><tt>replace</tt></i> is <tt class="literal">TRUE</tt> 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
<tt class="literal">TRUE</tt> return value.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-load"></a><h3>gtk.accel_map_load</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>file_name</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>file_name</tt></b>:</span></td><td>the file containing accelerator
specifications</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_load</tt>() function parses
the file (specified by <i class="parameter"><tt>file_name</tt></i>) previously saved
with the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-save" title="gtk.accel_map_save"><tt class="function">gtk.accel_map_save</tt>()</a>
function for accelerator specifications, and propagates them
accordingly.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-save"></a><h3>gtk.accel_map_save</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>file_name</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>file_name</tt></b>:</span></td><td>the file to save the accelerator specifications
in</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_save</tt>() function saves
current accelerator specifications (accelerator path, key and modifiers) to
the file specified by <i class="parameter"><tt>file_name</tt></i>. The file is written
in a format suitable to be read back in by the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-load" title="gtk.accel_map_load"><tt class="function">gtk.accel_map_load</tt>()</a>
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-load-fd"></a><h3>gtk.accel_map_load_fd</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load_fd</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>fd</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>fd</tt></b>:</span></td><td>a Python file object or an integer file
descriptor</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_load_fd</tt>() function loads
the accelerator map from the open Python file object specified by
<i class="parameter"><tt>fd</tt></i>. <i class="parameter"><tt>fd</tt></i> may also be an integer
file descriptor. See the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-load" title="gtk.accel_map_load"><tt class="function">gtk.accel_map_load</tt>()</a>
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-save-fd"></a><h3>gtk.accel_map_save_fd</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save_fd</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>fd</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>fd</tt></b>:</span></td><td>a Python file object or an integer file
descriptor</td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_save_fd</tt>() function saves
the accelerator map into the open Python file object specified by fd.
<i class="parameter"><tt>fd</tt></i> may also be an integer file descriptor. See the
<a href="class-gtkaccelgroup.html#function-gtk--accel-map-save" title="gtk.accel_map_save"><tt class="function">gtk.accel_map_save</tt>()</a>
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-lock-path"></a><h3>gtk.accel_map_lock_path</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lock_path</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>a valid accelerator path</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <tt class="function">gtk.accel_map_lock_path</tt>() function
locks the accelerator path specified by
<i class="parameter"><tt>accel_path</tt></i>. If the accelerator map doesn't yet
contain an entry for <i class="parameter"><tt>accel_path</tt></i>, a new one is
created.</p><p>Locking an accelerator path prevents its accelerator from being
changed during runtime. A locked accelerator path can be unlocked by
the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-unlock-path" title="gtk.accel_map_unlock_path"><tt class="function">gtk.accel_map_unlock_path</tt>()</a>
function. Refer to the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-change-entry" title="gtk.accel_map_change_entry"><tt class="function">gtk.accel_map_change_entry</tt>()</a>
function for information about runtime accelerator changes.</p><p>If called more than once, <i class="parameter"><tt>accel_path</tt></i>
remains locked until the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-unlock-path" title="gtk.accel_map_unlock_path"><tt class="function">gtk.accel_map_unlock_path</tt>()</a>
function has been called an equivalent number of times.</p><p>Note that locking of individual accelerator paths is independent
from locking the <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
containing them. For runtime accelerator changes to be possible both
the accelerator path and its <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
have to be unlocked.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-unlock-path"></a><h3>gtk.accel_map_unlock_path</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_unlock_path</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>accel_path</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>accel_path</tt></b>:</span></td><td>a valid accelerator path</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <tt class="function">gtk.accel_map_unlock_path</tt>() function
undoes the last call to the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-lock-path" title="gtk.accel_map_lock_path"><tt class="function">gtk.accel_map_lock_path</tt>()</a>
function on the accelerator path specified by
<i class="parameter"><tt>accel_path</tt></i>. Refer to the <a href="class-gtkaccelgroup.html#function-gtk--accel-map-lock-path" title="gtk.accel_map_lock_path"><tt class="function">gtk.accel_map_lock_path</tt>()</a>
function for information about accelerator path locking.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-add-filter"></a><h3>gtk.accel_map_add_filter</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_filter</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>filter_pattern</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>filter_pattern</tt></b>:</span></td><td>a glob-style pattern</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td></td></tr></tbody></table><p>The <tt class="function">gtk.accel_map_add_filter</tt>() function
adds the filter pattern specified by <i class="parameter"><tt>filter_pattern</tt></i>
to the global list of accel path filters. The pattern specified by
<i class="parameter"><tt>filter_pattern</tt></i> contain '*' and '?' wildcards with
similar semantics as the Python <tt class="filename">glob.py</tt> and
<tt class="filename">fnmatch.py</tt> modules: '*' matches an arbitrary, possibly
empty, string, '?' matches an arbitrary character. Note that in contrast to
<tt class="filename">glob.py</tt>, 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.
This function is intended for <tt class="literal">PyGTK</tt> modules that create
their own menus, but don't want them to be saved into the applications
accelerator map dump.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-groups-from-object"></a><h3>gtk.accel_groups_from_object</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_groups_from_object</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>object</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>object</tt></i>:</span></td><td>a GObject usually a <a href="class-gtkwindow.html" title="gtk.Window"><tt class="classname">gtk.Window</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <tt class="function">gtk.accel_groups_from_object</tt>() function
returns a list of all the <a href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><tt class="classname">gtk.AccelGroup</tt></a>
objects attached to the object specified by
<i class="parameter"><tt>object</tt></i>.</p></div></div><div class="refsect1" lang="en"><a name="id3065389"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkaccelgroup--accel-activate"></a><h3>The "accel-activate" gtk.AccelGroup Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>accelgroup</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>acceleratable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_key</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_mods</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>accelgroup</tt></i>:</span></td><td>the accelgroup that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>acceleratable</tt></i>:</span></td><td>the object that the accelerator is associated
with</td></tr><tr><td><span class="term"><i class="parameter"><tt>accel_key</tt></i>:</span></td><td>the accelerator key value</td></tr><tr><td><span class="term"><i class="parameter"><tt>accel_mods</tt></i>:</span></td><td>the accelerator modifiers</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">gobject.GObject.connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the accelerator
was handled</td></tr></tbody></table><p>The "accel-activate" signal is emitted when an accelerator is
activated.</p></div><div class="refsect2" lang="en"><a name="signal-gtkaccelgroup--accel-changed"></a><h3>The "accel-changed" gtk.AccelGroup Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>accelgroup</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_key</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>accel_mods</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>closure</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>accelgroup</tt></i>:</span></td><td>the accelgroup that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>accel_key</tt></i>:</span></td><td>the key value of the
accelerator</td></tr><tr><td><span class="term"><i class="parameter"><tt>accel_mods</tt></i>:</span></td><td>the modifiers of the
accelerator</td></tr><tr><td><span class="term"><i class="parameter"><tt>closure</tt></i>:</span></td><td>the closure of the
accelerator</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "accel-changed" signal is emitted when an accelerator is
added or removed from an accelerator group.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkaboutdialog.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtkaccellabel.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.AboutDialog</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.AccelLabel</td></tr></table></div></body></html>
|
