1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
<title>gtkmm: Gtk::AccelMap Namespace Reference</title>
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<script type="text/javascript" src="jquery.js"></script>
9
<script type="text/javascript" src="dynsections.js"></script>
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15
<table cellspacing="0" cellpadding="0">
17
<tr style="height: 56px;">
18
<td style="padding-left: 0.5em;">
19
<div id="projectname">gtkmm
20
 <span id="projectnumber">3.5.13</span>
27
<!-- end header part -->
28
<!-- Generated by Doxygen 1.8.1.1 -->
29
<div id="navrow1" class="tabs">
31
<li><a href="index.html"><span>Main Page</span></a></li>
32
<li><a href="pages.html"><span>Related Pages</span></a></li>
33
<li><a href="modules.html"><span>Modules</span></a></li>
34
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
35
<li><a href="annotated.html"><span>Classes</span></a></li>
38
<div id="navrow2" class="tabs2">
40
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
41
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
44
<div id="nav-path" class="navpath">
46
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a></li><li class="navelem"><a class="el" href="namespaceGtk_1_1AccelMap.html">AccelMap</a></li> </ul>
51
<a href="#func-members">Functions</a> </div>
52
<div class="headertitle">
53
<div class="title">Gtk::AccelMap Namespace Reference</div> </div>
55
<div class="contents">
56
<table class="memberdecls">
57
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
58
Functions</h2></td></tr>
59
<tr class="memitem:a6313a0f99aebe342c08f2d2d0f9416ad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#a6313a0f99aebe342c08f2d2d0f9416ad">add_entry</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path, guint accel_key, <a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> accel_mods)</td></tr>
60
<tr class="memdesc:a6313a0f99aebe342c08f2d2d0f9416ad"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new accelerator with the global accelerator map. <a href="#a6313a0f99aebe342c08f2d2d0f9416ad"></a><br/></td></tr>
61
<tr class="memitem:a95ea03719ffcda0d038252d3886f935b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#a95ea03719ffcda0d038252d3886f935b">change_entry</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path, guint accel_key, <a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> accel_mods, bool <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01182.html#ga77aa7f436223611f545f84715a30ffeb">replace</a>)</td></tr>
62
<tr class="memdesc:a95ea03719ffcda0d038252d3886f935b"><td class="mdescLeft"> </td><td class="mdescRight">Changes the accel_key and accel_mods currently associated with accel_path. <a href="#a95ea03719ffcda0d038252d3886f935b"></a><br/></td></tr>
63
<tr class="memitem:ab08ddf040f6014f34398ef1f5ff61d20"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#ab08ddf040f6014f34398ef1f5ff61d20">load</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& filename)</td></tr>
64
<tr class="memdesc:ab08ddf040f6014f34398ef1f5ff61d20"><td class="mdescLeft"> </td><td class="mdescRight">Parses a file previously saved with <a class="el" href="namespaceGtk_1_1AccelMap.html#abcf3439b02031c060e7984f919604aaa" title="Saves current accelerator specifications (accelerator path, key and modifiers) to filename...">save()</a> for accelerator specifications, and propagates them accordingly. <a href="#ab08ddf040f6014f34398ef1f5ff61d20"></a><br/></td></tr>
65
<tr class="memitem:abcf3439b02031c060e7984f919604aaa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#abcf3439b02031c060e7984f919604aaa">save</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& filename)</td></tr>
66
<tr class="memdesc:abcf3439b02031c060e7984f919604aaa"><td class="mdescLeft"> </td><td class="mdescRight">Saves current accelerator specifications (accelerator path, key and modifiers) to filename. <a href="#abcf3439b02031c060e7984f919604aaa"></a><br/></td></tr>
67
<tr class="memitem:aab88799290240d3b9f95ea5a8db296a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#aab88799290240d3b9f95ea5a8db296a0">lock_path</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path)</td></tr>
68
<tr class="memdesc:aab88799290240d3b9f95ea5a8db296a0"><td class="mdescLeft"> </td><td class="mdescRight">Locks the given accelerator path. <a href="#aab88799290240d3b9f95ea5a8db296a0"></a><br/></td></tr>
69
<tr class="memitem:a34e0669e9f2eb96abeaba309d751f535"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#a34e0669e9f2eb96abeaba309d751f535">unlock_path</a> (const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path)</td></tr>
70
<tr class="memdesc:a34e0669e9f2eb96abeaba309d751f535"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the given accelerator path. <a href="#a34e0669e9f2eb96abeaba309d751f535"></a><br/></td></tr>
71
<tr class="memitem:a2b71d89fdafdf9b71ef7ba1dedf5e70c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#a2b71d89fdafdf9b71ef7ba1dedf5e70c">lookup_entry</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& accel_path)</td></tr>
72
<tr class="memdesc:a2b71d89fdafdf9b71ef7ba1dedf5e70c"><td class="mdescLeft"> </td><td class="mdescRight">Looks up the accelerator entry for accel_path. <a href="#a2b71d89fdafdf9b71ef7ba1dedf5e70c"></a><br/></td></tr>
73
<tr class="memitem:a65ed240c5058b980c7047c519b3a3a37"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGtk_1_1AccelMap.html#a65ed240c5058b980c7047c519b3a3a37">lookup_entry</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& accel_path, <a class="el" href="classGtk_1_1AccelKey.html">Gtk::AccelKey</a>& key)</td></tr>
74
<tr class="memdesc:a65ed240c5058b980c7047c519b3a3a37"><td class="mdescLeft"> </td><td class="mdescRight">Looks up the accelerator entry for accel_path and fills in key. <a href="#a65ed240c5058b980c7047c519b3a3a37"></a><br/></td></tr>
76
<hr/><h2>Function Documentation</h2>
77
<a class="anchor" id="a6313a0f99aebe342c08f2d2d0f9416ad"></a>
79
<div class="memproto">
80
<table class="memname">
82
<td class="memname">void Gtk::AccelMap::add_entry </td>
84
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
85
<td class="paramname"><em>accel_path</em>, </td>
88
<td class="paramkey"></td>
90
<td class="paramtype">guint </td>
91
<td class="paramname"><em>accel_key</em>, </td>
94
<td class="paramkey"></td>
96
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td>
97
<td class="paramname"><em>accel_mods</em> </td>
105
</div><div class="memdoc">
107
<p>Registers a new accelerator with the global accelerator map. </p>
108
<p>This function should only be called once per accel_path with the canonical accel_key and accel_mods for this path. To change the accelerator during runtime programatically, use <a class="el" href="namespaceGtk_1_1AccelMap.html#a95ea03719ffcda0d038252d3886f935b" title="Changes the accel_key and accel_mods currently associated with accel_path.">change_entry()</a>. 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>
109
<dl class="params"><dt>Parameters:</dt><dd>
110
<table class="params">
111
<tr><td class="paramname">accel_path</td><td>valid accelerator path </td></tr>
112
<tr><td class="paramname">accel_key</td><td>the accelerator key </td></tr>
113
<tr><td class="paramname">accel_mods</td><td>the accelerator modifiers </td></tr>
120
<a class="anchor" id="a95ea03719ffcda0d038252d3886f935b"></a>
121
<div class="memitem">
122
<div class="memproto">
123
<table class="memname">
125
<td class="memname">bool Gtk::AccelMap::change_entry </td>
127
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
128
<td class="paramname"><em>accel_path</em>, </td>
131
<td class="paramkey"></td>
133
<td class="paramtype">guint </td>
134
<td class="paramname"><em>accel_key</em>, </td>
137
<td class="paramkey"></td>
139
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td>
140
<td class="paramname"><em>accel_mods</em>, </td>
143
<td class="paramkey"></td>
145
<td class="paramtype">bool </td>
146
<td class="paramname"><em>replace</em> </td>
154
</div><div class="memdoc">
156
<p>Changes the accel_key and accel_mods currently associated with accel_path. </p>
157
<p>Due to conflicts with other accelerators, a change may not always be possible, replace indicates whether 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 true return value.</p>
158
<dl class="params"><dt>Parameters:</dt><dd>
159
<table class="params">
160
<tr><td class="paramname">accel_path</td><td>a valid accelerator path </td></tr>
161
<tr><td class="paramname">accel_key</td><td>the new accelerator key </td></tr>
162
<tr><td class="paramname">accel_mods</td><td>the new accelerator modifiers </td></tr>
163
<tr><td class="paramname">replace</td><td>true if other accelerators may be deleted upon conflicts </td></tr>
167
<dl class="section return"><dt>Returns:</dt><dd>true if the accelerator could be changed, false otherwise </dd></dl>
171
<a class="anchor" id="ab08ddf040f6014f34398ef1f5ff61d20"></a>
172
<div class="memitem">
173
<div class="memproto">
174
<table class="memname">
176
<td class="memname">void Gtk::AccelMap::load </td>
178
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
179
<td class="paramname"><em>filename</em></td><td>)</td>
183
</div><div class="memdoc">
185
<p>Parses a file previously saved with <a class="el" href="namespaceGtk_1_1AccelMap.html#abcf3439b02031c060e7984f919604aaa" title="Saves current accelerator specifications (accelerator path, key and modifiers) to filename...">save()</a> for accelerator specifications, and propagates them accordingly. </p>
186
<dl class="params"><dt>Parameters:</dt><dd>
187
<table class="params">
188
<tr><td class="paramname">filename</td><td>a file containing accelerator specifications </td></tr>
195
<a class="anchor" id="aab88799290240d3b9f95ea5a8db296a0"></a>
196
<div class="memitem">
197
<div class="memproto">
198
<table class="memname">
200
<td class="memname">void Gtk::AccelMap::lock_path </td>
202
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
203
<td class="paramname"><em>accel_path</em></td><td>)</td>
207
</div><div class="memdoc">
209
<p>Locks the given accelerator path. </p>
210
<p>Locking an accelerator path prevents its accelerator from being changed during runtime. A locked accelerator path can be unlocked by <a class="el" href="namespaceGtk_1_1AccelMap.html#a34e0669e9f2eb96abeaba309d751f535" title="Unlocks the given accelerator path.">unlock_path()</a>. Refer to <a class="el" href="namespaceGtk_1_1AccelMap.html#a95ea03719ffcda0d038252d3886f935b" title="Changes the accel_key and accel_mods currently associated with accel_path.">change_entry()</a> about runtime accelerator changes.</p>
211
<p>Note that locking of individual accelerator paths is independent from locking the #GtkAccelGroup containing them. For runtime accelerator changes to be possible both the accelerator path and its <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">AccelGroup</a> have to be unlocked.</p>
212
<dl class="params"><dt>Parameters:</dt><dd>
213
<table class="params">
214
<tr><td class="paramname">accel_path</td><td>a valid accelerator path</td></tr>
218
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000321">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
222
<a class="anchor" id="a2b71d89fdafdf9b71ef7ba1dedf5e70c"></a>
223
<div class="memitem">
224
<div class="memproto">
225
<table class="memname">
227
<td class="memname">bool Gtk::AccelMap::lookup_entry </td>
229
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
230
<td class="paramname"><em>accel_path</em></td><td>)</td>
234
</div><div class="memdoc">
236
<p>Looks up the accelerator entry for accel_path. </p>
237
<dl class="params"><dt>Parameters:</dt><dd>
238
<table class="params">
239
<tr><td class="paramname">accel_path</td><td>A valid accelerator path. </td></tr>
243
<dl class="section return"><dt>Returns:</dt><dd>true if accel_path is known, false otherwise</dd></dl>
244
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000405">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
248
<a class="anchor" id="a65ed240c5058b980c7047c519b3a3a37"></a>
249
<div class="memitem">
250
<div class="memproto">
251
<table class="memname">
253
<td class="memname">bool Gtk::AccelMap::lookup_entry </td>
255
<td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
256
<td class="paramname"><em>accel_path</em>, </td>
259
<td class="paramkey"></td>
261
<td class="paramtype"><a class="el" href="classGtk_1_1AccelKey.html">Gtk::AccelKey</a>& </td>
262
<td class="paramname"><em>key</em> </td>
270
</div><div class="memdoc">
272
<p>Looks up the accelerator entry for accel_path and fills in key. </p>
273
<dl class="params"><dt>Parameters:</dt><dd>
274
<table class="params">
275
<tr><td class="paramname">accel_path</td><td>A valid accelerator path. </td></tr>
276
<tr><td class="paramname">key</td><td>The accelerator key to be filled in. </td></tr>
280
<dl class="section return"><dt>Returns:</dt><dd>true if accel_path is known, false otherwise</dd></dl>
281
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000406">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
285
<a class="anchor" id="abcf3439b02031c060e7984f919604aaa"></a>
286
<div class="memitem">
287
<div class="memproto">
288
<table class="memname">
290
<td class="memname">void Gtk::AccelMap::save </td>
292
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
293
<td class="paramname"><em>filename</em></td><td>)</td>
297
</div><div class="memdoc">
299
<p>Saves current accelerator specifications (accelerator path, key and modifiers) to filename. </p>
300
<p>The file is written in a format suitable to be read back in by <a class="el" href="namespaceGtk_1_1AccelMap.html#ab08ddf040f6014f34398ef1f5ff61d20" title="Parses a file previously saved with save() for accelerator specifications, and propagates them accord...">load()</a>.</p>
301
<dl class="params"><dt>Parameters:</dt><dd>
302
<table class="params">
303
<tr><td class="paramname">filename</td><td>the file to contain accelerator specifications </td></tr>
310
<a class="anchor" id="a34e0669e9f2eb96abeaba309d751f535"></a>
311
<div class="memitem">
312
<div class="memproto">
313
<table class="memname">
315
<td class="memname">void Gtk::AccelMap::unlock_path </td>
317
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00315.html#ga32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
318
<td class="paramname"><em>accel_path</em></td><td>)</td>
322
</div><div class="memdoc">
324
<p>Unlocks the given accelerator path. </p>
325
<p>Refer to gtk_accel_map_lock_path() about accelerator path locking.</p>
326
<dl class="params"><dt>Parameters:</dt><dd>
327
<table class="params">
328
<tr><td class="paramname">accel_path</td><td>a valid accelerator path</td></tr>
332
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000322">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
336
</div><!-- contents -->
337
<!-- start footer part -->
338
<hr class="footer"/><address class="footer"><small>
339
Generated by  <a href="http://www.doxygen.org/index.html">
340
<img class="footer" src="doxygen.png" alt="doxygen"/>
added
removed
docs/reference/html/namespaceGtk_1_1AccelMap.html
