<!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::MenuShell 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.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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1MenuShell.html">MenuShell</a>
</div>
</div>
<div class="contents">
<h1>Gtk::MenuShell Class Reference<br/>
<small>
[<a class="el" href="group__Widgets.html">Widgets</a>, <a class="el" href="group__Containers.html">Container Widgets</a>, <a class="el" href="group__Menus.html">Menu classes</a>]</small>
</h1><!-- doxytag: class="Gtk::MenuShell" --><!-- doxytag: inherits="Gtk::Container" -->
<p>The abstract base class for <a class="el" href="classGtk_1_1Menu.html" title="A drop-down menu consisting of Gtk::MenuItem objects which can be navigated and activated...">Gtk::Menu</a> and <a class="el" href="classGtk_1_1MenuBar.html" title="A standard menu bar which usually holds Gtk::Menu submenu items.">Gtk::MenuBar</a>. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGtk_1_1Container.html">Gtk::Container</a>.</p>
<p>Inherited by <a class="el" href="classGtk_1_1Menu.html">Gtk::Menu</a>, and <a class="el" href="classGtk_1_1MenuBar.html">Gtk::MenuBar</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::MenuShell:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1MenuShell__coll__graph.png" border="0" usemap="#Gtk_1_1MenuShell_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1MenuShell_coll__map" id="Gtk_1_1MenuShell_coll__map">
<area shape="rect" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="873,37,977,67"/><area shape="rect" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="1840,72,1909,101"/><area shape="rect" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)." alt="" coords="661,37,752,67"/><area shape="rect" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="505,5,593,35"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="340,5,431,35"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="163,31,283,60"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="333,59,437,88"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="5,31,112,60"/><area shape="rect" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="489,59,609,88"/><area shape="rect" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled..." alt="" coords="2345,84,2441,113"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< AccelGroup \>" alt="" coords="1784,125,1965,155"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html" title="Glib::RefPtr\< T_CppObject \>" alt="" coords="831,125,1020,155"/><area shape="rect" href="classGtk_1_1Menu__Helpers_1_1MenuList.html" title="Gtk::Menu_Helpers::MenuList" alt="" coords="2296,160,2491,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1HelperList.html" title="Glib::HelperList\< MenuItem, const Element, Glib::List_Cpp_Iterator\< GtkMenuItem, MenuItem \> \>" alt="" coords="1579,179,2171,208"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1HelperList.html" title="Glib::HelperList\< class, class, class \>" alt="" coords="804,179,1047,208"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1MenuShell-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">Menu_Helpers::MenuList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a8d79bb921d0a3ffca5e4c9d8f77648a2">MenuList</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ab7117e65877843c10ad7d5b705a770e7">~MenuShell</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkMenuShell* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#abb7c2641f9e3624f3225dcf76d8b994c">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#abb7c2641f9e3624f3225dcf76d8b994c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkMenuShell* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a4417adfb6a301e40a0040517c43e69c7">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a4417adfb6a301e40a0040517c43e69c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a24d5b1a4a61941006e544a4f5a230917">append</a> (<a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& menu_item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a5aa0142b2f86f511ac5f98ce892d03bd">prepend</a> (<a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& menu_item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#aa3243bef17ebc3ed18b3885194e7d9a3">insert</a> (<a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& menu_item, int position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ac38fde346621b24154540f83243956fd">select_item</a> (<a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& menu_item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ab90ff16ed2fcba9aa3460569d45f1c1a">deselect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a6e5136fc61381ae6f2e529906066680a">activate_item</a> (<a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& menu_item, bool force_deactivate=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a882dab72c89e462a879a6b6179464cc2">select_first</a> (bool search_sensitive=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select the first visible or selectable child of the menu shell; don't select tearoff items unless the only item is a tearoff item. <a href="#a882dab72c89e462a879a6b6179464cc2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a9b6af9110758ce34856b005b19a7a2fb">deactivate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#abc8e49ce84e81319c81bdc58020245c0">cancel</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancels the selection within the menu shell. <a href="#abc8e49ce84e81319c81bdc58020245c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a14c8a5dcb0d5afa8b1ab93ae149cf603">signal_deactivate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#afe3aa91d39c133487f5ee87afdf3e255">signal_selection_done</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< gboolean, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a29358f68b2c16afdab5147f7021368e8">signal_move_selected</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">MenuList</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a3be08eb46038a65ca6c9b5b35f310672">items</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">MenuList</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#aa65f89396cb05203e8ef565a2cd0ea1d">items</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ab871eaa94a1566f520beb132ba3794c4">accelerate</a> (<a class="el" href="classGtk_1_1Window.html">Window</a>& window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes menu accelerators. <a href="#ab871eaa94a1566f520beb132ba3794c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ab854722984e3fc3e85d2ad7c7ba20c2f">accelerate</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& parent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes menu accelerators. <a href="#ab854722984e3fc3e85d2ad7c7ba20c2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a959971445f815ecfcc2f3d3cda24708a">get_take_focus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the menu shell will take the keyboard focus on popup. <a href="#a959971445f815ecfcc2f3d3cda24708a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#ac076143bf45a4c69cd65965a7779a963">set_take_focus</a> (bool take_focus=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If <em>take_focus</em> is <code>true</code> (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus. <a href="#ac076143bf45a4c69cd65965a7779a963"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a98a38ba541cff7ba9f990e24adeb6642">property_take_focus</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A boolean that determines whether the menu grabs the keyboard focus. <a href="#a98a38ba541cff7ba9f990e24adeb6642"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a4119fb422a09241e3e88a6cc1431ee06">property_take_focus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A boolean that determines whether the menu grabs the keyboard focus. <a href="#a4119fb422a09241e3e88a6cc1431ee06"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#aeceb71b253394dbc8ca282feb8ae8e58">on_deactivate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a407cbaed85670dc36c35a67cdefd015b">on_selection_done</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a6af3cf3fd23271ebe15daa3210339bfe">MenuShell</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1MenuShell.html">Gtk::MenuShell</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1MenuShell.html#a5a3342e817b330a6b353d25c37ea2359">wrap</a> (GtkMenuShell* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a5a3342e817b330a6b353d25c37ea2359"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The abstract base class for <a class="el" href="classGtk_1_1Menu.html" title="A drop-down menu consisting of Gtk::MenuItem objects which can be navigated and activated...">Gtk::Menu</a> and <a class="el" href="classGtk_1_1MenuBar.html" title="A standard menu bar which usually holds Gtk::Menu submenu items.">Gtk::MenuBar</a>. </p>
<p>It is a container of <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a> objects arranged in a list which can be navigated, selected, and activated by the user to perform application functions. It can have a submenu associated with it, allowing for nested hierarchical menus. You can use <a class="el" href="classGtk_1_1MenuShell.html#a24d5b1a4a61941006e544a4f5a230917">append()</a>, <a class="el" href="classGtk_1_1MenuShell.html#a5aa0142b2f86f511ac5f98ce892d03bd">prepend()</a> and <a class="el" href="classGtk_1_1MenuShell.html#aa3243bef17ebc3ed18b3885194e7d9a3">insert()</a> to add <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a> widgets, but you will probably find it more convenient to use the STL-style <a class="el" href="classGtk_1_1MenuShell.html#a3be08eb46038a65ca6c9b5b35f310672">items()</a> interface with the Gtk::Menu_Helpers::MenuElem() class. </p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a8d79bb921d0a3ffca5e4c9d8f77648a2"></a><!-- doxytag: member="Gtk::MenuShell::MenuList" ref="a8d79bb921d0a3ffca5e4c9d8f77648a2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">Menu_Helpers::MenuList</a> <a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">Gtk::MenuShell::MenuList</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab7117e65877843c10ad7d5b705a770e7"></a><!-- doxytag: member="Gtk::MenuShell::~MenuShell" ref="ab7117e65877843c10ad7d5b705a770e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::MenuShell::~MenuShell </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6af3cf3fd23271ebe15daa3210339bfe"></a><!-- doxytag: member="Gtk::MenuShell::MenuShell" ref="a6af3cf3fd23271ebe15daa3210339bfe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::MenuShell::MenuShell </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab854722984e3fc3e85d2ad7c7ba20c2f"></a><!-- doxytag: member="Gtk::MenuShell::accelerate" ref="ab854722984e3fc3e85d2ad7c7ba20c2f" args="(Widget &parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::accelerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"> <em>parent</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes menu accelerators. </p>
<p>Does the same as the <a class="el" href="classGtk_1_1MenuShell.html#ab871eaa94a1566f520beb132ba3794c4" title="Initializes menu accelerators.">accelerate(Window& window)</a> method. But you can use any parent widget where the menu is used. This method then gets the toplevel window using <a class="el" href="classGtk_1_1Widget.html#ab91722dd77223c450b8dfaa45af59c1a" title="This function returns the topmost widget in the container hierarchy widget is a part...">Widget::get_toplevel()</a> and uses this window for registering the menu accelerators.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td>Parent widget used as starting point for searching the toplevel window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab871eaa94a1566f520beb132ba3794c4"></a><!-- doxytag: member="Gtk::MenuShell::accelerate" ref="ab871eaa94a1566f520beb132ba3794c4" args="(Window &window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::accelerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Window.html">Window</a>& </td>
<td class="paramname"> <em>window</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes menu accelerators. </p>
<p>This method initializes the menu accelerators. Therefore an <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached...">AccelGroup</a> object is needed which is stored in each <a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled...">Window</a> object in the Gtkmm library implementation.</p>
<p>When using <a class="el" href="classGtk_1_1MenuBar.html" title="A standard menu bar which usually holds Gtk::Menu submenu items.">MenuBar</a> and <a class="el" href="classGtk_1_1OptionMenu.html" title="A widget used to choose from a list of valid choices.">OptionMenu</a> objects this method is called automatically when the menus are realized. Because most likely the <a class="el" href="classGtk_1_1MenuBar.html" title="A standard menu bar which usually holds Gtk::Menu submenu items.">MenuBar</a> and <a class="el" href="classGtk_1_1OptionMenu.html" title="A widget used to choose from a list of valid choices.">OptionMenu</a> is attached to a window at this time and the window object can be found automatically.</p>
<p>Important note when using popup menus: If you are using accelerated menu entries inside a popup menu you have to call the <a class="el" href="classGtk_1_1MenuShell.html#ab871eaa94a1566f520beb132ba3794c4" title="Initializes menu accelerators.">accelerate()</a> method manually. This is because the popup menu is not connected to any window and the accelerators should be initialized even before the popup menu is shown. The right place to call the <a class="el" href="classGtk_1_1MenuShell.html#ab871eaa94a1566f520beb132ba3794c4" title="Initializes menu accelerators.">accelerate()</a> method is right after the popup menu has been build.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em> </td><td><a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled...">Window</a> where the menu is shown. Inside this window the <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached...">AccelGroup</a> object is stored that will be used to initialize the accelerators. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6e5136fc61381ae6f2e529906066680a"></a><!-- doxytag: member="Gtk::MenuShell::activate_item" ref="a6e5136fc61381ae6f2e529906066680a" args="(MenuItem &menu_item, bool force_deactivate=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::activate_item </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& </td>
<td class="paramname"> <em>menu_item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>force_deactivate</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a24d5b1a4a61941006e544a4f5a230917"></a><!-- doxytag: member="Gtk::MenuShell::append" ref="a24d5b1a4a61941006e544a4f5a230917" args="(MenuItem &menu_item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& </td>
<td class="paramname"> <em>menu_item</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abc8e49ce84e81319c81bdc58020245c0"></a><!-- doxytag: member="Gtk::MenuShell::cancel" ref="abc8e49ce84e81319c81bdc58020245c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::cancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels the selection within the menu shell. </p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000211">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a9b6af9110758ce34856b005b19a7a2fb"></a><!-- doxytag: member="Gtk::MenuShell::deactivate" ref="a9b6af9110758ce34856b005b19a7a2fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::deactivate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab90ff16ed2fcba9aa3460569d45f1c1a"></a><!-- doxytag: member="Gtk::MenuShell::deselect" ref="ab90ff16ed2fcba9aa3460569d45f1c1a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::deselect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a959971445f815ecfcc2f3d3cda24708a"></a><!-- doxytag: member="Gtk::MenuShell::get_take_focus" ref="a959971445f815ecfcc2f3d3cda24708a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::MenuShell::get_take_focus </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if the menu shell will take the keyboard focus on popup. </p>
<dl class="since_2_8"><dt><b><a class="el" href="since_2_8.html#_since_2_8000032">Since gtkmm 2.8:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the menu shell will take the keyboard focus on popup. </dd></dl>
</div>
</div>
<a class="anchor" id="a4417adfb6a301e40a0040517c43e69c7"></a><!-- doxytag: member="Gtk::MenuShell::gobj" ref="a4417adfb6a301e40a0040517c43e69c7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkMenuShell* Gtk::MenuShell::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Container.html#ab80be58ac27710f10f329120587e7d60">Gtk::Container</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1Menu.html#a943271a828e8bfa829c6bf4ed0060203">Gtk::Menu</a>, <a class="el" href="classGtk_1_1MenuBar.html#a3e7df05b207812ee2abca13e8c0f26e3">Gtk::MenuBar</a>, and <a class="el" href="classGtk_1_1RecentChooserMenu.html#ac8d86c1bbe5f6997e524f28db4cb95b5">Gtk::RecentChooserMenu</a>.</p>
</div>
</div>
<a class="anchor" id="abb7c2641f9e3624f3225dcf76d8b994c"></a><!-- doxytag: member="Gtk::MenuShell::gobj" ref="abb7c2641f9e3624f3225dcf76d8b994c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkMenuShell* Gtk::MenuShell::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Container.html#a1b45ff015f4b09b143699bad9d4e423d">Gtk::Container</a>.</p>
<p>Reimplemented in <a class="el" href="classGtk_1_1Menu.html#a08434c6b137ce53eb939b09d577aa9bb">Gtk::Menu</a>, <a class="el" href="classGtk_1_1MenuBar.html#a3c2333c3c7c03939590bb2e41b4aaa63">Gtk::MenuBar</a>, and <a class="el" href="classGtk_1_1RecentChooserMenu.html#ae3863ae813b85f9b9ac6f4075370a55e">Gtk::RecentChooserMenu</a>.</p>
</div>
</div>
<a class="anchor" id="aa3243bef17ebc3ed18b3885194e7d9a3"></a><!-- doxytag: member="Gtk::MenuShell::insert" ref="aa3243bef17ebc3ed18b3885194e7d9a3" args="(MenuItem &menu_item, int position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& </td>
<td class="paramname"> <em>menu_item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>position</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa65f89396cb05203e8ef565a2cd0ea1d"></a><!-- doxytag: member="Gtk::MenuShell::items" ref="aa65f89396cb05203e8ef565a2cd0ea1d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">MenuList</a>& Gtk::MenuShell::items </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3be08eb46038a65ca6c9b5b35f310672"></a><!-- doxytag: member="Gtk::MenuShell::items" ref="a3be08eb46038a65ca6c9b5b35f310672" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Menu__Helpers_1_1MenuList.html">MenuList</a>& Gtk::MenuShell::items </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aeceb71b253394dbc8ca282feb8ae8e58"></a><!-- doxytag: member="Gtk::MenuShell::on_deactivate" ref="aeceb71b253394dbc8ca282feb8ae8e58" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::MenuShell::on_deactivate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a407cbaed85670dc36c35a67cdefd015b"></a><!-- doxytag: member="Gtk::MenuShell::on_selection_done" ref="a407cbaed85670dc36c35a67cdefd015b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gtk::MenuShell::on_selection_done </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5aa0142b2f86f511ac5f98ce892d03bd"></a><!-- doxytag: member="Gtk::MenuShell::prepend" ref="a5aa0142b2f86f511ac5f98ce892d03bd" args="(MenuItem &menu_item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::prepend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& </td>
<td class="paramname"> <em>menu_item</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4119fb422a09241e3e88a6cc1431ee06"></a><!-- doxytag: member="Gtk::MenuShell::property_take_focus" ref="a4119fb422a09241e3e88a6cc1431ee06" 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_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::MenuShell::property_take_focus </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A boolean that determines whether the menu grabs the keyboard focus. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a98a38ba541cff7ba9f990e24adeb6642"></a><!-- doxytag: member="Gtk::MenuShell::property_take_focus" ref="a98a38ba541cff7ba9f990e24adeb6642" 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_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::MenuShell::property_take_focus </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A boolean that determines whether the menu grabs the keyboard focus. </p>
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a882dab72c89e462a879a6b6179464cc2"></a><!-- doxytag: member="Gtk::MenuShell::select_first" ref="a882dab72c89e462a879a6b6179464cc2" args="(bool search_sensitive=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::select_first </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>search_sensitive</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Select the first visible or selectable child of the menu shell; don't select tearoff items unless the only item is a tearoff item. </p>
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000100">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>search_sensitive</em> </td><td>If <code>true</code>, search for the first selectable menu item, otherwise select nothing if the first item isn't sensitive. This should be <code>false</code> if the menu is being popped up initially. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac38fde346621b24154540f83243956fd"></a><!-- doxytag: member="Gtk::MenuShell::select_item" ref="ac38fde346621b24154540f83243956fd" args="(MenuItem &menu_item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::select_item </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1MenuItem.html">MenuItem</a>& </td>
<td class="paramname"> <em>menu_item</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac076143bf45a4c69cd65965a7779a963"></a><!-- doxytag: member="Gtk::MenuShell::set_take_focus" ref="ac076143bf45a4c69cd65965a7779a963" args="(bool take_focus=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::MenuShell::set_take_focus </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_focus</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If <em>take_focus</em> is <code>true</code> (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus. </p>
<p>Setting <em>take_focus</em> to <code>false</code> is useful only for special applications like virtual keyboard implementations which should not take keyboard focus.</p>
<p>The <em>take_focus</em> state of a menu or menu bar is automatically propagated to submenus whenever a submenu is popped up, so you don't have to worry about recursively setting it for your entire menu hierarchy. Only when programmatically picking a submenu and popping it up manually, the <em>take_focus</em> property of the submenu needs to be set explicitely.</p>
<p>Note that setting it to <code>false</code> has side-effects:</p>
<p>If the focus is in some other app, it keeps the focus and keynav in the menu doesn't work. Consequently, keynav on the menu will only work if the focus is on some toplevel owned by the onscreen keyboard.</p>
<p>To avoid confusing the user, menus with <em>take_focus</em> set to <code>false</code> should not display mnemonics or accelerators, since it cannot be guaranteed that they will work.</p>
<p>See also gdk_keyboard_grab()</p>
<dl class="since_2_8"><dt><b><a class="el" href="since_2_8.html#_since_2_8000033">Since gtkmm 2.8:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>take_focus</em> </td><td><code>true</code> if the menu shell should take the keyboard focus on popup. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a14c8a5dcb0d5afa8b1ab93ae149cf603"></a><!-- doxytag: member="Gtk::MenuShell::signal_deactivate" ref="a14c8a5dcb0d5afa8b1ab93ae149cf603" 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_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::MenuShell::signal_deactivate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_deactivate()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a29358f68b2c16afdab5147f7021368e8"></a><!-- doxytag: member="Gtk::MenuShell::signal_move_selected" ref="a29358f68b2c16afdab5147f7021368e8" 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_1SignalProxy1.html">Glib::SignalProxy1</a>< gboolean,int > Gtk::MenuShell::signal_move_selected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>gboolean on_my_move_selected(int distance)</code> </dd></dl>
</div>
</div>
<a class="anchor" id="afe3aa91d39c133487f5ee87afdf3e255"></a><!-- doxytag: member="Gtk::MenuShell::signal_selection_done" ref="afe3aa91d39c133487f5ee87afdf3e255" 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_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::MenuShell::signal_selection_done </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_selection_done()</code> </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5a3342e817b330a6b353d25c37ea2359"></a><!-- doxytag: member="Gtk::MenuShell::wrap" ref="a5a3342e817b330a6b353d25c37ea2359" args="(GtkMenuShell *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1MenuShell.html">Gtk::MenuShell</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkMenuShell * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/menushell.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:55 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
>
463
