1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.AccelMap</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkaccellabel.html" title="gtk.AccelLabel"><link rel="next" href="class-gtkaccessible.html" title="gtk.Accessible"></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.AccelMap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkaccellabel.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkaccessible.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkaccelmap"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.AccelMap</h2><p>gtk.AccelMap — Loadable keyboard accelerator specifications (new in PyGTK
2
2.10)</p></div><div class="refsect1" lang="en"><a name="id3171215"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AccelMap</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.AccelMap</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.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="prev" href="class-gtkaccellabel.html" title="gtk.AccelLabel"><link rel="next" href="class-gtkaccessible.html" title="gtk.Accessible"></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.AccelMap</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkaccellabel.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkaccessible.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.AccelMap"><a name="class-gtkaccelmap"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.AccelMap</h2><p>gtk.AccelMap — Loadable keyboard accelerator specifications (new in PyGTK
2
2.10)</p></div><div class="refsect1" title="Synopsis"><a name="id3394738"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.AccelMap</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
</pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
5
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>replace</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-foreach" title="gtk.accel_map_foreach">gtk.accel_map_foreach</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-foreach-unfiltered" title="gtk.accel_map_foreach_unfiltered">gtk.accel_map_foreach_unfiltered</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-get" title="gtk.accel_map_get">gtk.accel_map_get</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-load" title="gtk.accel_map_load">gtk.accel_map_load</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-save" title="gtk.accel_map_save">gtk.accel_map_save</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>fd</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>fd</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkaccelmap.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"><strong class="parameter"><code>filter_pattern</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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"><em class="parameter"><code>object</code></em></span></span>)</code>
6
</pre></div><div class="refsect1" lang="en"><a name="id2851703"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
</pre></div><div class="refsect1" title="Ancestry"><a name="id3145168"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
+-- <a class="link" href="class-gtkaccelmap.html" title="gtk.AccelMap">gtk.AccelMap</a>
8
</pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkaccelmap"></a><h2>gtk.AccelMap Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkaccelmap.html#signal-gtkaccelmap--changed" title='The "changed" gtk.AccelMap Signal'>changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_key</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_mods</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3173424"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id2946613"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--accel-map-add-entry"></a><h3>gtk.accel_map_add_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_key</code></strong> :</span></p></td><td>the accelerator key</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_mods</code></strong> :</span></p></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 <code class="function">gtk.accel_map_add_entry</code>() function
8
</pre></div><div class="refsect1" title="gtk.AccelMap Signal Prototypes"><a name="signal-prototypes-gtkaccelmap"></a><h2>gtk.AccelMap Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkaccelmap.html#signal-gtkaccelmap--changed" title='The "changed" gtk.AccelMap Signal'>changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_key</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_mods</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3160529"></a><h2>Description</h2><p></p></div><div class="refsect1" title="Functions"><a name="id3128190"></a><h2>Functions</h2><div class="refsect2" title="gtk.accel_map_add_entry"><a name="function-gtk--accel-map-add-entry"></a><h3>gtk.accel_map_add_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_key</code></strong> :</span></p></td><td>the accelerator key</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_mods</code></strong> :</span></p></td><td>the accelerator modifiers</td></tr></tbody></table><div class="note" title="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 <code class="function">gtk.accel_map_add_entry</code>() function
9
9
registers a new accelerator specified by <em class="parameter"><code>accel_key</code></em>
10
10
and <em class="parameter"><code>accel_mods</code></em> with the global accelerator map. The
11
11
accelerator will be associated with the accelerator path specified by
23
23
accelerator triggers, i.e. for accelerators on menu items, choose the item's
24
24
menu path, e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". So a
25
25
full valid accelerator path may look like:
26
"<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><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lookup_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the keyval and modifier
26
"<Gimp-Toolbox>/File/Dialogs/Tool Options...".</p></div><div class="refsect2" title="gtk.accel_map_lookup_entry"><a name="function-gtk--accel-map-lookup-entry"></a><h3>gtk.accel_map_lookup_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lookup_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the keyval and modifier
27
27
mask corresponding to <em class="parameter"><code>accel_path</code></em> or
28
28
<code class="literal">None</code> if not valid</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_lookup_entry</code>() function
29
29
returns a 2-tuple containing the keyval and modifier mask corresponding to
37
37
is most appropriately chosen by the action the accelerator triggers, i.e.
38
38
for accelerators on menu items, choose the item's menu path, e.g. "File/Save
39
39
As", "Image/View/Zoom" or "Edit/Select All". So a full valid accelerator
40
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><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_change_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>replace</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_key</code></strong> :</span></p></td><td> the new accelerator key</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_mods</code></strong> :</span></p></td><td> the new accelerator
40
path may look like: "<Gimp-Toolbox>/File/Dialogs/Tool Options...".</p></div><div class="refsect2" title="gtk.accel_map_change_entry"><a name="function-gtk--accel-map-change-entry"></a><h3>gtk.accel_map_change_entry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_change_entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_key</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_mods</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>replace</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_key</code></strong> :</span></p></td><td> the new accelerator key</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>accel_mods</code></strong> :</span></p></td><td> the new accelerator
41
41
modifiers</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>replace</code></strong> :</span></p></td><td>if <code class="literal">True</code> other accelerators
42
42
may be deleted if conflicting</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the accelerator
43
43
could be changed</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_change_entry</code>() function
50
50
accelerators may be deleted to resolve such conflicts. A change will only
51
51
occur if all conflicts could be resolved (which might not be the case if
52
52
conflicting accelerators are locked). Successful changes are indicated by a
53
<code class="literal">True</code> return value.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-foreach"></a><h3>gtk.accel_map_foreach</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_foreach</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>foreach_func</code></strong> :</span></p></td><td>function to be executed for each accel map
53
<code class="literal">True</code> return value.</p></div><div class="refsect2" title="gtk.accel_map_foreach"><a name="function-gtk--accel-map-foreach"></a><h3>gtk.accel_map_foreach</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_foreach</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>foreach_func</code></strong> :</span></p></td><td>function to be executed for each accel map
54
54
entry which is not filtered out</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>data</code></strong> :</span></p></td><td>data to be passed into
55
<em class="parameter"><code>foreach_func</code></em></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.10 and above.</p></div><p>Loops over the entries in the accelerator map whose accel path
55
<em class="parameter"><code>foreach_func</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>Loops over the entries in the accelerator map whose accel path
56
56
doesn't match any of the filters added with the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-add-filter" title="gtk.accel_map_add_filter"><code class="function">gtk.accel_map_add_filter</code>()</a>
57
57
function, and executes <em class="parameter"><code>foreach_func</code></em> on
58
58
each. The signature of <em class="parameter"><code>foreach_func</code></em> is:</p><pre class="programlisting">
65
65
during an accelerator map dump). <em class="parameter"><code>user_data</code></em> is
66
66
<em class="parameter"><code>data</code></em> if <em class="parameter"><code>data</code></em> was
67
67
specified. See the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-add-entry" title="gtk.accel_map_add_entry"><code class="function">gtk.accel_map_add_entry</code>()</a>
68
function for more information.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-foreach-unfiltered"></a><h3>gtk.accel_map_foreach_unfiltered</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_foreach_unfiltered</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>foreach_func</code></strong> :</span></p></td><td>function to be executed for each accel map
68
function for more information.</p></div><div class="refsect2" title="gtk.accel_map_foreach_unfiltered"><a name="function-gtk--accel-map-foreach-unfiltered"></a><h3>gtk.accel_map_foreach_unfiltered</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_foreach_unfiltered</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>foreach_func</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>data</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>foreach_func</code></strong> :</span></p></td><td>function to be executed for each accel map
69
69
entry</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>data</code></strong> :</span></p></td><td>data to be passed into
70
<em class="parameter"><code>foreach_func</code></em></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.10 and above.</p></div><p>Loops over all entries in the accelerator map, and executes
70
<em class="parameter"><code>foreach_func</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>Loops over all entries in the accelerator map, and executes
71
71
<em class="parameter"><code>foreach_func</code></em> on each. The signature of
72
72
<em class="parameter"><code>foreach_func</code></em> is:</p><pre class="programlisting">
73
73
def foreach_func(accel_path, accel_key, accel_mode, changed, user_data):
79
79
an accelerator map dump). <em class="parameter"><code>user_data</code></em> is
80
80
<em class="parameter"><code>data</code></em> if <em class="parameter"><code>data</code></em> was
81
81
specified. See the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-add-entry" title="gtk.accel_map_add_entry"><code class="function">gtk.accel_map_add_entry</code>()</a>
82
function for more information.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-get"></a><h3>gtk.accel_map_get</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_get</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the global <a class="link" href="class-gtkaccelmap.html" title="gtk.AccelMap"><code class="classname">gtk.AccelMap</code></a>
83
object</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.10 and above.</p></div><p>Gets the singleton global <a class="link" href="class-gtkaccelmap.html" title="gtk.AccelMap"><code class="classname">gtk.AccelMap</code></a>
82
function for more information.</p></div><div class="refsect2" title="gtk.accel_map_get"><a name="function-gtk--accel-map-get"></a><h3>gtk.accel_map_get</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_get</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the global <a class="link" href="class-gtkaccelmap.html" title="gtk.AccelMap"><code class="classname">gtk.AccelMap</code></a>
83
object</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>Gets the singleton global <a class="link" href="class-gtkaccelmap.html" title="gtk.AccelMap"><code class="classname">gtk.AccelMap</code></a>
84
84
object. This object is useful only for notification of changes to the
85
85
accelerator map via the "changed" signal. it has no methods or
86
properties.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-load"></a><h3>gtk.accel_map_load</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>file_name</code></strong> :</span></p></td><td>the file containing accelerator
86
properties.</p></div><div class="refsect2" title="gtk.accel_map_load"><a name="function-gtk--accel-map-load"></a><h3>gtk.accel_map_load</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>file_name</code></strong> :</span></p></td><td>the file containing accelerator
87
87
specifications</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_load</code>() function parses
88
88
the file (specified by <em class="parameter"><code>file_name</code></em>) previously saved
89
89
with the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-save" title="gtk.accel_map_save"><code class="function">gtk.accel_map_save</code>()</a>
90
90
function for accelerator specifications, and propagates them
91
accordingly.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-save"></a><h3>gtk.accel_map_save</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>file_name</code></strong> :</span></p></td><td>the file to save the accelerator specifications
91
accordingly.</p></div><div class="refsect2" title="gtk.accel_map_save"><a name="function-gtk--accel-map-save"></a><h3>gtk.accel_map_save</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>file_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>file_name</code></strong> :</span></p></td><td>the file to save the accelerator specifications
92
92
in</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_save</code>() function saves
93
93
current accelerator specifications (accelerator path, key and modifiers) to
94
94
the file specified by <em class="parameter"><code>file_name</code></em>. The file is written
95
95
in a format suitable to be read back in by the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-load" title="gtk.accel_map_load"><code class="function">gtk.accel_map_load</code>()</a>
96
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-load-fd"></a><h3>gtk.accel_map_load_fd</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load_fd</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fd</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fd</code></strong> :</span></p></td><td>a Python file object or an integer file
96
function.</p></div><div class="refsect2" title="gtk.accel_map_load_fd"><a name="function-gtk--accel-map-load-fd"></a><h3>gtk.accel_map_load_fd</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_load_fd</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fd</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fd</code></strong> :</span></p></td><td>a Python file object or an integer file
97
97
descriptor</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_load_fd</code>() function loads
98
98
the accelerator map from the open Python file object specified by
99
99
<em class="parameter"><code>fd</code></em>. <em class="parameter"><code>fd</code></em> may also be an integer
100
100
file descriptor. See the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-load" title="gtk.accel_map_load"><code class="function">gtk.accel_map_load</code>()</a>
101
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-save-fd"></a><h3>gtk.accel_map_save_fd</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save_fd</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fd</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fd</code></strong> :</span></p></td><td>a Python file object or an integer file
101
function.</p></div><div class="refsect2" title="gtk.accel_map_save_fd"><a name="function-gtk--accel-map-save-fd"></a><h3>gtk.accel_map_save_fd</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_save_fd</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fd</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fd</code></strong> :</span></p></td><td>a Python file object or an integer file
102
102
descriptor</td></tr></tbody></table><p>The <code class="function">gtk.accel_map_save_fd</code>() function saves
103
103
the accelerator map into the open Python file object specified by fd.
104
104
<em class="parameter"><code>fd</code></em> may also be an integer file descriptor. See the
105
105
<a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-save" title="gtk.accel_map_save"><code class="function">gtk.accel_map_save</code>()</a>
106
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--accel-map-lock-path"></a><h3>gtk.accel_map_lock_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lock_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></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 <code class="function">gtk.accel_map_lock_path</code>() function
106
function.</p></div><div class="refsect2" title="gtk.accel_map_lock_path"><a name="function-gtk--accel-map-lock-path"></a><h3>gtk.accel_map_lock_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_lock_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr></tbody></table><div class="note" title="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 <code class="function">gtk.accel_map_lock_path</code>() function
107
107
locks the accelerator path specified by
108
108
<em class="parameter"><code>accel_path</code></em>. If the accelerator map doesn't yet
109
109
contain an entry for <em class="parameter"><code>accel_path</code></em>, a new one is
117
117
from locking the <a class="link" href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><code class="classname">gtk.AccelGroup</code></a>
118
118
containing them. For runtime accelerator changes to be possible both
119
119
the accelerator path and its <a class="link" href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><code class="classname">gtk.AccelGroup</code></a>
120
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><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_unlock_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></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 <code class="function">gtk.accel_map_unlock_path</code>() function
120
have to be unlocked.</p></div><div class="refsect2" title="gtk.accel_map_unlock_path"><a name="function-gtk--accel-map-unlock-path"></a><h3>gtk.accel_map_unlock_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_unlock_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>accel_path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>accel_path</code></strong> :</span></p></td><td>a valid accelerator path</td></tr></tbody></table><div class="note" title="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 <code class="function">gtk.accel_map_unlock_path</code>() function
121
121
undoes the last call to the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-lock-path" title="gtk.accel_map_lock_path"><code class="function">gtk.accel_map_lock_path</code>()</a>
122
122
function on the accelerator path specified by
123
123
<em class="parameter"><code>accel_path</code></em>. Refer to the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-lock-path" title="gtk.accel_map_lock_path"><code class="function">gtk.accel_map_lock_path</code>()</a>
124
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><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_filter</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filter_pattern</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>filter_pattern</code></strong> :</span></p></td><td>a glob-style pattern</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td></td></tr></tbody></table><p>The <code class="function">gtk.accel_map_add_filter</code>() function
124
function for information about accelerator path locking.</p></div><div class="refsect2" title="gtk.accel_map_add_filter"><a name="function-gtk--accel-map-add-filter"></a><h3>gtk.accel_map_add_filter</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.accel_map_add_filter</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filter_pattern</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>filter_pattern</code></strong> :</span></p></td><td>a glob-style pattern</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td></td></tr></tbody></table><p>The <code class="function">gtk.accel_map_add_filter</code>() function
125
125
adds the filter pattern specified by
126
126
<em class="parameter"><code>filter_pattern</code></em> to the global list of accel path
127
127
filters. The pattern specified by
136
136
the filters are skipped by the <a class="link" href="class-gtkaccelmap.html#function-gtk--accel-map-foreach" title="gtk.accel_map_foreach"><code class="function">gtk.accel_map_foreach</code>()</a>
137
137
function. This function is intended for <code class="literal">PyGTK</code>
138
138
modules that create their own menus, but don't want them to be saved
139
into the applications accelerator map dump.</p></div></div><div class="refsect1" lang="en"><a name="id2856751"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkaccelmap--changed"></a><h3>The "changed" gtk.AccelMap Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_key</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_mods</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td><td>the global accel map object</td></tr><tr><td><p><span class="term"><em class="parameter"><code>accel_path</code></em> :</span></p></td><td>the path of the accelerator that
139
into the applications accelerator map dump.</p></div></div><div class="refsect1" title="Signals"><a name="id3071881"></a><h2>Signals</h2><div class="refsect2" title='The "changed" gtk.AccelMap Signal'><a name="signal-gtkaccelmap--changed"></a><h3>The "changed" gtk.AccelMap Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>object</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_key</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>accel_mods</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td><td>the global accel map object</td></tr><tr><td><p><span class="term"><em class="parameter"><code>accel_path</code></em> :</span></p></td><td>the path of the accelerator that
140
140
changed</td></tr><tr><td><p><span class="term"><em class="parameter"><code>accel_key</code></em> :</span></p></td><td>the key value for the new
141
141
accelerator</td></tr><tr><td><p><span class="term"><em class="parameter"><code>accel_mods</code></em> :</span></p></td><td>the modifier mask for the new
142
142
accelerator</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
143
143
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
144
144
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
145
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>Notifies of a change in the global accelerator map. The path is
145
any)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>Notifies of a change in the global accelerator map. The path is
146
146
also used as the detail for the signal, so it is possible to connect
147
147
to changed::<em class="replaceable"><code>accel_path</code></em>.</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-gtkaccellabel.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-gtkaccessible.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.AccelLabel </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Accessible</td></tr></table></div></body></html>
added
removed
docs/html/class-gtkaccelmap.html
