<!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::AccelKey Class 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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtkmm <span id="projectnumber">2.24.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
<li class="navelem"><a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>Gtk::AccelKey Class Reference<div class="ingroups"><a class="el" href="group__Menus.html">Menu classes</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::AccelKey" -->
<p>Defines accelerator key combinations. <a href="#_details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Gtk::AccelKey:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1AccelKey__coll__graph.png" border="0" usemap="#Gtk_1_1AccelKey_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1AccelKey_coll__map" id="Gtk_1_1AccelKey_coll__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html" title="Glib::ustring" alt="" coords="9,5,108,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1AccelKey-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a1a3ff31a0cb67142659342eb9896feb3">AccelKey</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#ac615d97162fa1814e7e0b6342c1bd622">AccelKey</a> (guint accel_key, <a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> accel_mods, 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"><a class="el" href="classGtk_1_1AccelKey.html" title="Defines accelerator key combinations.">AccelKey</a> constructor. <a href="#ac615d97162fa1814e7e0b6342c1bd622"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#aaa4ca433f961ba40ee5a501f2b818d5b">AccelKey</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& accelerator, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& accel_path=<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classGtk_1_1AccelKey.html" title="Defines accelerator key combinations.">AccelKey</a> constructor. <a href="#aaa4ca433f961ba40ee5a501f2b818d5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a26e7c5af7f5bdfa1948d03c418c1755e">AccelKey</a> (const <a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#abe7f9eebbe73ed3a30bc5942b3027eac">operator=</a> (const <a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#aa3b1e0719428cce25aad0c88d9d4818b">is_null</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a75f3a07ffe5b3ec113e88ba4f9c37f6c">get_key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accelerator key. <a href="#a75f3a07ffe5b3ec113e88ba4f9c37f6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a63f99a124e77cb4601c10857560bf020">get_mod</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accelerator modifier. <a href="#a63f99a124e77cb4601c10857560bf020"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a1d6d84467e3920a6af204f511dceb6d0">get_path</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accelerator path. <a href="#a1d6d84467e3920a6af204f511dceb6d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a2ec5c2905850275fbd2a6f39402366fe">get_abbrev</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the accelerator representation for labels. <a href="#a2ec5c2905850275fbd2a6f39402366fe"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#ad29fd938a58696299af2fc3a5403940d">key_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a884a3b68a6860a609b0cbc9b988dfd03">mod_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1AccelKey.html#a115c69bb0f29e66757db3dfd3ae78fa6">path_</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines accelerator key combinations. </p>
<p>For instance, pressing Control-Q to activate the File|Quit menu item. Typedefed as Gtk::Menu::AccelKey</p>
<p>By defining accelerator paths you can allow the user of your application to change accelerators himself. An example of an accelerator might be "<MainWindow>/File/Open". Modified accelerators may be saved </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="namespaceGtk_1_1AccelMap.html">Gtk::AccelMap</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1a3ff31a0cb67142659342eb9896feb3"></a><!-- doxytag: member="Gtk::AccelKey::AccelKey" ref="a1a3ff31a0cb67142659342eb9896feb3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::AccelKey::AccelKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac615d97162fa1814e7e0b6342c1bd622"></a><!-- doxytag: member="Gtk::AccelKey::AccelKey" ref="ac615d97162fa1814e7e0b6342c1bd622" args="(guint accel_key, Gdk::ModifierType accel_mods, const Glib::ustring &accel_path="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::AccelKey::AccelKey </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">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> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classGtk_1_1AccelKey.html" title="Defines accelerator key combinations.">AccelKey</a> constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">accel_key</td><td>For instance, 'q' </td></tr>
<tr><td class="paramname">accel_mods</td><td>For instance, Gdk::CONTROL_MASK </td></tr>
<tr><td class="paramname">accel_path</td><td>For instance, "<MainWindow>/File/Open" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaa4ca433f961ba40ee5a501f2b818d5b"></a><!-- doxytag: member="Gtk::AccelKey::AccelKey" ref="aaa4ca433f961ba40ee5a501f2b818d5b" args="(const Glib::ustring &accelerator, const Glib::ustring &accel_path=Glib::ustring())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::AccelKey::AccelKey </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>accelerator</em>, </td>
</tr>
<tr>
<td class="paramkey"></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> = <code><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classGtk_1_1AccelKey.html" title="Defines accelerator key combinations.">AccelKey</a> constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">accelerator</td><td>For instance, "<control>q" - Use <control>, <shift>, <alt> and <release>. Use F1, F2, etc, for function keys. </td></tr>
<tr><td class="paramname">accel_path</td><td>For instance, "<MainWindow>/File/Open" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a26e7c5af7f5bdfa1948d03c418c1755e"></a><!-- doxytag: member="Gtk::AccelKey::AccelKey" ref="a26e7c5af7f5bdfa1948d03c418c1755e" args="(const AccelKey &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::AccelKey::AccelKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2ec5c2905850275fbd2a6f39402366fe"></a><!-- doxytag: member="Gtk::AccelKey::get_abbrev" ref="a2ec5c2905850275fbd2a6f39402366fe" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::AccelKey::get_abbrev </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the accelerator representation for labels. </p>
</div>
</div>
<a class="anchor" id="a75f3a07ffe5b3ec113e88ba4f9c37f6c"></a><!-- doxytag: member="Gtk::AccelKey::get_key" ref="a75f3a07ffe5b3ec113e88ba4f9c37f6c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint Gtk::AccelKey::get_key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the accelerator key. </p>
</div>
</div>
<a class="anchor" id="a63f99a124e77cb4601c10857560bf020"></a><!-- doxytag: member="Gtk::AccelKey::get_mod" ref="a63f99a124e77cb4601c10857560bf020" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> Gtk::AccelKey::get_mod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the accelerator modifier. </p>
</div>
</div>
<a class="anchor" id="a1d6d84467e3920a6af204f511dceb6d0"></a><!-- doxytag: member="Gtk::AccelKey::get_path" ref="a1d6d84467e3920a6af204f511dceb6d0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::AccelKey::get_path </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the accelerator path. </p>
</div>
</div>
<a class="anchor" id="aa3b1e0719428cce25aad0c88d9d4818b"></a><!-- doxytag: member="Gtk::AccelKey::is_null" ref="aa3b1e0719428cce25aad0c88d9d4818b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::AccelKey::is_null </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abe7f9eebbe73ed3a30bc5942b3027eac"></a><!-- doxytag: member="Gtk::AccelKey::operator=" ref="abe7f9eebbe73ed3a30bc5942b3027eac" args="(const AccelKey &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& Gtk::AccelKey::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1AccelKey.html">AccelKey</a>& </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ad29fd938a58696299af2fc3a5403940d"></a><!-- doxytag: member="Gtk::AccelKey::key_" ref="ad29fd938a58696299af2fc3a5403940d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint <a class="el" href="classGtk_1_1AccelKey.html#ad29fd938a58696299af2fc3a5403940d">Gtk::AccelKey::key_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a884a3b68a6860a609b0cbc9b988dfd03"></a><!-- doxytag: member="Gtk::AccelKey::mod_" ref="a884a3b68a6860a609b0cbc9b988dfd03" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">Gdk::ModifierType</a> <a class="el" href="classGtk_1_1AccelKey.html#a884a3b68a6860a609b0cbc9b988dfd03">Gtk::AccelKey::mod_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a115c69bb0f29e66757db3dfd3ae78fa6"></a><!-- doxytag: member="Gtk::AccelKey::path_" ref="a115c69bb0f29e66757db3dfd3ae78fa6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> <a class="el" href="classGtk_1_1AccelKey.html#a115c69bb0f29e66757db3dfd3ae78fa6">Gtk::AccelKey::path_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/accelkey.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 25 2013 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
