<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtkmm: Gtk::AccelMap Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="namespaceGtk_1_1AccelMap.html">AccelMap</a>
</div>
</div>
<div class="contents">
<h1>Gtk::AccelMap Namespace Reference</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path, guint accel_key, <a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> accel_mods)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Registers a new accelerator with the global accelerator map. <a href="#a6313a0f99aebe342c08f2d2d0f9416ad"></a><br/></td></tr>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01161.html#gadb9e65d36bcd4869cb9d63af97524602">replace</a>)</td></tr>
<tr><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>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& filename)</td></tr>
<tr><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...">save()</a> for accelerator specifications, and propagates them accordingly. <a href="#ab08ddf040f6014f34398ef1f5ff61d20"></a><br/></td></tr>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& filename)</td></tr>
<tr><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>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Locks the given accelerator path. <a href="#aab88799290240d3b9f95ea5a8db296a0"></a><br/></td></tr>
<tr><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" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& accel_path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the given accelerator path. <a href="#a34e0669e9f2eb96abeaba309d751f535"></a><br/></td></tr>
<tr><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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& accel_path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up the accelerator entry for accel_path. <a href="#a2b71d89fdafdf9b71ef7ba1dedf5e70c"></a><br/></td></tr>
<tr><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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& accel_path, <a class="el" href="classGtk_1_1AccelKey.html">Gtk::AccelKey</a>& key)</td></tr>
<tr><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>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a6313a0f99aebe342c08f2d2d0f9416ad"></a><!-- doxytag: member="Gtk::AccelMap::add_entry" ref="a6313a0f99aebe342c08f2d2d0f9416ad" args="(const std::string &accel_path, guint accel_key, Gdk::ModifierType accel_mods)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::AccelMap::add_entry </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint </td>
<td class="paramname"> <em>accel_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td>
<td class="paramname"> <em>accel_mods</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers a new accelerator with the global accelerator map. </p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>valid accelerator path </td></tr>
<tr><td valign="top"></td><td valign="top"><em>accel_key</em> </td><td>the accelerator key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>accel_mods</em> </td><td>the accelerator modifiers </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a95ea03719ffcda0d038252d3886f935b"></a><!-- doxytag: member="Gtk::AccelMap::change_entry" ref="a95ea03719ffcda0d038252d3886f935b" args="(const std::string &accel_path, guint accel_key, Gdk::ModifierType accel_mods, bool replace)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::AccelMap::change_entry </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint </td>
<td class="paramname"> <em>accel_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td>
<td class="paramname"> <em>accel_mods</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>replace</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Changes the accel_key and accel_mods currently associated with accel_path. </p>
<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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>a valid accelerator path </td></tr>
<tr><td valign="top"></td><td valign="top"><em>accel_key</em> </td><td>the new accelerator key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>accel_mods</em> </td><td>the new accelerator modifiers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replace</em> </td><td>true if other accelerators may be deleted upon conflicts </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the accelerator could be changed, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="ab08ddf040f6014f34398ef1f5ff61d20"></a><!-- doxytag: member="Gtk::AccelMap::load" ref="ab08ddf040f6014f34398ef1f5ff61d20" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::AccelMap::load </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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...">save()</a> for accelerator specifications, and propagates them accordingly. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>a file containing accelerator specifications </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aab88799290240d3b9f95ea5a8db296a0"></a><!-- doxytag: member="Gtk::AccelMap::lock_path" ref="aab88799290240d3b9f95ea5a8db296a0" args="(const std::string &accel_path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::AccelMap::lock_path </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>accel_path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Locks the given accelerator path. </p>
<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>
<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...">AccelGroup</a> have to be unlocked.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>a valid accelerator path</td></tr>
</table>
</dd>
</dl>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000340">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a65ed240c5058b980c7047c519b3a3a37"></a><!-- doxytag: member="Gtk::AccelMap::lookup_entry" ref="a65ed240c5058b980c7047c519b3a3a37" args="(const Glib::ustring &accel_path, Gtk::AccelKey &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::AccelMap::lookup_entry </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>accel_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGtk_1_1AccelKey.html">Gtk::AccelKey</a>& </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Looks up the accelerator entry for accel_path and fills in key. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The accelerator key to be filled in. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if accel_path is known, false otherwise</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000390">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a2b71d89fdafdf9b71ef7ba1dedf5e70c"></a><!-- doxytag: member="Gtk::AccelMap::lookup_entry" ref="a2b71d89fdafdf9b71ef7ba1dedf5e70c" args="(const Glib::ustring &accel_path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::AccelMap::lookup_entry </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>accel_path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Looks up the accelerator entry for accel_path. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>A valid accelerator path. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if accel_path is known, false otherwise</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000389">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="abcf3439b02031c060e7984f919604aaa"></a><!-- doxytag: member="Gtk::AccelMap::save" ref="abcf3439b02031c060e7984f919604aaa" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::AccelMap::save </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves current accelerator specifications (accelerator path, key and modifiers) to filename. </p>
<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...">load()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>the file to contain accelerator specifications </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a34e0669e9f2eb96abeaba309d751f535"></a><!-- doxytag: member="Gtk::AccelMap::unlock_path" ref="a34e0669e9f2eb96abeaba309d751f535" args="(const std::string &accel_path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::AccelMap::unlock_path </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01116.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>accel_path</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unlocks the given accelerator path. </p>
<p>Refer to gtk_accel_map_lock_path() about accelerator path locking.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>accel_path</em> </td><td>a valid accelerator path</td></tr>
</table>
</dd>
</dl>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000341">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:11 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
1117
