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
<title>gtkmm: Gtk::UIManager Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1UIManager.html">UIManager</a> </li>
49
<a href="#pub-types">Public Types</a> |
50
<a href="#pub-methods">Public Member Functions</a> |
51
<a href="#pub-static-methods">Static Public Member Functions</a> |
52
<a href="#pro-methods">Protected Member Functions</a> |
53
<a href="#related">Related Functions</a> </div>
54
<div class="headertitle">
55
<h1>Gtk::UIManager Class Reference</h1> </div>
57
<div class="contents">
58
<!-- doxytag: class="Gtk::UIManager" --><!-- doxytag: inherits="Glib::Object" -->
59
<p>Constructing menus and toolbars from an XML description. <a href="#_details">More...</a></p>
60
<div class="dynheader">
61
Inheritance diagram for Gtk::UIManager:</div>
62
<div class="dyncontent">
63
<div class="center"><img src="classGtk_1_1UIManager__inherit__graph.png" border="0" usemap="#Gtk_1_1UIManager_inherit__map" alt="Inheritance graph"/></div>
64
<map name="Gtk_1_1UIManager_inherit__map" id="Gtk_1_1UIManager_inherit__map">
65
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
66
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
67
<div class="dynheader">
68
Collaboration diagram for Gtk::UIManager:</div>
69
<div class="dyncontent">
70
<div class="center"><img src="classGtk_1_1UIManager__coll__graph.png" border="0" usemap="#Gtk_1_1UIManager_coll__map" alt="Collaboration graph"/></div>
71
<map name="Gtk_1_1UIManager_coll__map" id="Gtk_1_1UIManager_coll__map">
72
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
73
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
75
<p><a href="classGtk_1_1UIManager-members.html">List of all members.</a></p>
76
<table class="memberdecls">
77
<tr><td colspan="2"><h2><a name="pub-types"></a>
78
Public Types</h2></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">typedef guint </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a></td></tr>
80
<tr><td colspan="2"><h2><a name="pub-methods"></a>
81
Public Member Functions</h2></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a3193cf4841782d2efb3836ad87f2bbb8">~UIManager</a> ()</td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top">GtkUIManager* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#adcbc82741d92ed865d1d63eddabb7d99">gobj</a> ()</td></tr>
84
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#adcbc82741d92ed865d1d63eddabb7d99"></a><br/></td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top">const GtkUIManager* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#aae9a90e30c01a024da550dddd9d86363">gobj</a> () const </td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aae9a90e30c01a024da550dddd9d86363"></a><br/></td></tr>
87
<tr><td class="memItemLeft" align="right" valign="top">GtkUIManager* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a49c2a2f2d2b9c7db91cfce222c6d9139">gobj_copy</a> ()</td></tr>
88
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a49c2a2f2d2b9c7db91cfce222c6d9139"></a><br/></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#aaaa2dd331a1a300e21e8b61b1e9f6c46">set_add_tearoffs</a> (bool add_tearoffs=true)</td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the "add_tearoffs" property, which controls whether menus generated by this <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> will have tearoff menu items. <a href="#aaaa2dd331a1a300e21e8b61b1e9f6c46"></a><br/></td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a199dfed5c1bdae63887ee2bed7c559fd">get_add_tearoffs</a> () const </td></tr>
92
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether menus generated by this <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> will have tearoff menu items. <a href="#a199dfed5c1bdae63887ee2bed7c559fd"></a><br/></td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a50cc8ee94cb48ddef6516883a0dd9047">insert_action_group</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> >& action_group, int pos=0)</td></tr>
94
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts an action group into the list of action groups associated with <em>self</em>. <a href="#a50cc8ee94cb48ddef6516883a0dd9047"></a><br/></td></tr>
95
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a13551c32d6aa054c8c6771086727c576">remove_action_group</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> >& action_group)</td></tr>
96
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes an action group from the list of action groups associated with <em>self</em>. <a href="#a13551c32d6aa054c8c6771086727c576"></a><br/></td></tr>
97
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
98
< <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#ab0fcfc16bf3763645b083848d5f5f33b">get_action_groups</a> ()</td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of action groups associated with <em>self</em>. <a href="#ab0fcfc16bf3763645b083848d5f5f33b"></a><br/></td></tr>
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
101
< const <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a6d8e6a1ac268dbbd7fd28d9fbe1c5aa4">get_action_groups</a> () const </td></tr>
102
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of action groups associated with <em>self</em>. <a href="#a6d8e6a1ac268dbbd7fd28d9fbe1c5aa4"></a><br/></td></tr>
103
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1AccelGroup.html">AccelGroup</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a56f55fb4e8428dbc65c49cf1229775c4">get_accel_group</a> ()</td></tr>
104
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a> associated with <em>self</em>. <a href="#a56f55fb4e8428dbc65c49cf1229775c4"></a><br/></td></tr>
105
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGtk_1_1AccelGroup.html">AccelGroup</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a42211d42cb736b8f2b5b0d0d20f85e05">get_accel_group</a> () const </td></tr>
106
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a> associated with <em>self</em>. <a href="#a42211d42cb736b8f2b5b0d0d20f85e05"></a><br/></td></tr>
107
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Widget.html">Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a93357a4791e1740610fadb0ba088cbf3">get_widget</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path)</td></tr>
108
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up a widget by following a path. <a href="#a93357a4791e1740610fadb0ba088cbf3"></a><br/></td></tr>
109
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a38de43f04c160b1ddf238da0f0309cc0">get_widget</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path) const </td></tr>
110
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up a widget by following a path. <a href="#a38de43f04c160b1ddf238da0f0309cc0"></a><br/></td></tr>
111
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>< <a class="el" href="classGtk_1_1Widget.html">Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#aaf34fa7155944190cf80432e7bccbd52">get_toplevels</a> (<a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> types)</td></tr>
112
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains a list of all toplevel widgets of the requested types. <a href="#aaf34fa7155944190cf80432e7bccbd52"></a><br/></td></tr>
113
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a>< const <a class="el" href="classGtk_1_1Widget.html">Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a5e340833b5766122d0901dc98e42bc0b">get_toplevels</a> (<a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> types) const </td></tr>
114
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains a list of all toplevel widgets of the requested types. <a href="#a5e340833b5766122d0901dc98e42bc0b"></a><br/></td></tr>
115
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Action.html">Action</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a5486fde7529fd2f6e0cfbea2780e5d32">get_action</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path)</td></tr>
116
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up an action by following a path. <a href="#a5486fde7529fd2f6e0cfbea2780e5d32"></a><br/></td></tr>
117
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGtk_1_1Action.html">Action</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#ab4b3f27d94dc1363ec10915cffa7f3a7">get_action</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path) const </td></tr>
118
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up an action by following a path. <a href="#ab4b3f27d94dc1363ec10915cffa7f3a7"></a><br/></td></tr>
119
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a403582b15c37408abaa868692d6a7abd">add_ui_from_string</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& buffer)</td></tr>
120
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string containing a UI definition and merges it with the current contents. <a href="#a403582b15c37408abaa868692d6a7abd"></a><br/></td></tr>
121
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#ad1377c506a357a7587d5e2bb5377881c">add_ui_from_file</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& filename)</td></tr>
122
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a file containing a and merges it with the current contents of <em>self</em>. <a href="#ad1377c506a357a7587d5e2bb5377881c"></a><br/></td></tr>
123
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a0a23ac89ab23915b675446cc1c10db1f">add_ui</a> (<a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> merge_id, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& action, <a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01565.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>=Gtk::UI_MANAGER_AUTO, bool top=true)</td></tr>
124
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a UI element to the current contents of <em>self</em>. <a href="#a0a23ac89ab23915b675446cc1c10db1f"></a><br/></td></tr>
125
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a19b05ae50b353b39b60f467008c0c827">add_ui_separator</a> (<a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> merge_id, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name="", <a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01565.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>=Gtk::UI_MANAGER_AUTO, bool top=true)</td></tr>
126
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a separator UI element to the current contents. <a href="#a19b05ae50b353b39b60f467008c0c827"></a><br/></td></tr>
127
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a0611594aa9d4df6febe90dbb9fe2fd21">remove_ui</a> (<a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> merge_id)</td></tr>
128
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmerges the part of <em>selfs</em> content identified by <em>merge_id</em>. <a href="#a0611594aa9d4df6febe90dbb9fe2fd21"></a><br/></td></tr>
129
<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_1UIManager.html#ad85b3e2cb26b4535d71a57ac81f61918">get_ui</a> () const </td></tr>
130
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a of the merged UI. <a href="#ad85b3e2cb26b4535d71a57ac81f61918"></a><br/></td></tr>
131
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#aa3a3f4e8bdd7488eab875e9bbfd2ae15">ensure_update</a> ()</td></tr>
132
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes sure that all pending updates to the UI have been completed. <a href="#aa3a3f4e8bdd7488eab875e9bbfd2ae15"></a><br/></td></tr>
133
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#ac5cb767d3ba718492972e7f9c5f02fb7">new_merge_id</a> ()</td></tr>
134
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui(). <a href="#ac5cb767d3ba718492972e7f9c5f02fb7"></a><br/></td></tr>
135
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, <br class="typebreak"/>
136
<a class="el" href="classGtk_1_1Widget.html">Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a92f803fbd7048cdfeb94d0b395435292">signal_add_widget</a> ()</td></tr>
137
<tr><td class="mdescLeft"> </td><td class="mdescRight">The add_widget signal is emitted for each generated menubar and toolbar. <a href="#a92f803fbd7048cdfeb94d0b395435292"></a><br/></td></tr>
138
<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_1UIManager.html#ab670a3d562a988c0ed866faaae5e4223">signal_actions_changed</a> ()</td></tr>
139
<tr><td class="mdescLeft"> </td><td class="mdescRight">The "actions-changed" signal is emitted whenever the set of actions changes. <a href="#ab670a3d562a988c0ed866faaae5e4223"></a><br/></td></tr>
140
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void, <br class="typebreak"/>
141
const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Action.html">Action</a> ><br class="typebreak"/>
142
&, <a class="el" href="classGtk_1_1Widget.html">Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a0fd9d67e67983ee5dd914812a7153e95">signal_connect_proxy</a> ()</td></tr>
143
<tr><td class="mdescLeft"> </td><td class="mdescRight">The connect_proxy signal is emitted after connecting a proxy to an action in the group. <a href="#a0fd9d67e67983ee5dd914812a7153e95"></a><br/></td></tr>
144
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void, <br class="typebreak"/>
145
const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Action.html">Action</a> ><br class="typebreak"/>
146
&, <a class="el" href="classGtk_1_1Widget.html">Widget</a>* > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#aa133acc14dd552ad2df62b21ea7e4ebb">signal_disconnect_proxy</a> ()</td></tr>
147
<tr><td class="mdescLeft"> </td><td class="mdescRight">The disconnect_proxy signal is emitted after disconnecting a proxy from an action in the group. <a href="#aa133acc14dd552ad2df62b21ea7e4ebb"></a><br/></td></tr>
148
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, <br class="typebreak"/>
149
const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Action.html">Action</a> >& > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a13c399f0521ccc99a09611879038cee9">signal_pre_activate</a> ()</td></tr>
150
<tr><td class="mdescLeft"> </td><td class="mdescRight">The pre_activate signal is emitted just before the <em>action</em> is activated. <a href="#a13c399f0521ccc99a09611879038cee9"></a><br/></td></tr>
151
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void, <br class="typebreak"/>
152
const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Action.html">Action</a> >& > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a0243e755d2a8da7d658000c1b20f221d">signal_post_activate</a> ()</td></tr>
153
<tr><td class="mdescLeft"> </td><td class="mdescRight">The post_activate signal is emitted just after the <em>action</em> is activated. <a href="#a0243e755d2a8da7d658000c1b20f221d"></a><br/></td></tr>
154
<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_1UIManager.html#abaecd90445fa40cf1b7923845d03f70a">property_add_tearoffs</a> ()</td></tr>
155
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether tearoff menu items should be added to menus. <a href="#abaecd90445fa40cf1b7923845d03f70a"></a><br/></td></tr>
156
<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"/>
157
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#abac08a288b27cc0f284aedfbc7289d98">property_add_tearoffs</a> () const </td></tr>
158
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether tearoff menu items should be added to menus. <a href="#abac08a288b27cc0f284aedfbc7289d98"></a><br/></td></tr>
159
<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"/>
160
< <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_1UIManager.html#aba5843176409db66c211911cce9d6eb8">property_ui</a> () const </td></tr>
161
<tr><td class="mdescLeft"> </td><td class="mdescRight">An XML string describing the merged UI. <a href="#aba5843176409db66c211911cce9d6eb8"></a><br/></td></tr>
162
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
163
Static Public Member Functions</h2></td></tr>
164
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1UIManager.html">UIManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#af2a1f8d72acc2070660cf6d37dfb37a5">create</a> ()</td></tr>
165
<tr><td colspan="2"><h2><a name="pro-methods"></a>
166
Protected Member Functions</h2></td></tr>
167
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a2e1be63e14b8cd4b5b0dbb1e74757b3f">UIManager</a> ()</td></tr>
168
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a543fc31062484f6f230320f3d6f939e8">on_add_widget</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>* widget)</td></tr>
169
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#a79662f2d8e965519097b791f2af96ce3">on_actions_changed</a> ()</td></tr>
170
<tr><td colspan="2"><h2><a name="related"></a>
171
Related Functions</h2></td></tr>
172
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
173
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1UIManager.html">Gtk::UIManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1UIManager.html#ad36176bdb92cd8f85fc7c0fcd5868e9a">wrap</a> (GtkUIManager* object, bool take_copy=false)</td></tr>
174
<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="#ad36176bdb92cd8f85fc7c0fcd5868e9a"></a><br/></td></tr>
176
<hr/><a name="_details"></a><h2>Detailed Description</h2>
177
<div class="textblock"><p>Constructing menus and toolbars from an XML description. </p>
178
<p>A <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> constructs a user interface (menus and toolbars) from one or more UI definitions, which reference actions from one or more action groups.</p>
179
<dl class="user"><dt><b>UI Definitions</b></dt><dd></dd></dl>
180
<p>The UI definitions are specified in an XML format which can be roughly described by the following DTD. </p>
181
<div class="fragment"><pre class="fragment"> <!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
182
<!ELEMENT menubar (menuitem|separator|placeholder|menu)* >
183
<!ELEMENT menu (menuitem|separator|placeholder|menu)* >
184
<!ELEMENT popup (menuitem|separator|placeholder|menu)* >
185
<!ELEMENT toolbar (toolitem|separator|placeholder)* >
186
<!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
187
<!ELEMENT menuitem EMPTY >
188
<!ELEMENT toolitem (menu?) >
189
<!ELEMENT separator EMPTY >
190
<!ELEMENT accelerator EMPTY >
191
<!ATTLIST menubar name #IMPLIED action #IMPLIED >
192
<!ATTLIST toolbar name #IMPLIED action #IMPLIED >
193
<!ATTLIST popup name #IMPLIED action #IMPLIED >
194
<!ATTLIST placeholder name #IMPLIED
196
<!ATTLIST separator name #IMPLIED
198
expand (<span class="keyword">true</span>|<span class="keyword">false</span>) <span class="preprocessor">#IMPLIED ></span>
199
<span class="preprocessor"></span> <!ATTLIST menu name #IMPLIED
201
position (top|bot) <span class="preprocessor">#IMPLIED ></span>
202
<span class="preprocessor"></span> <!ATTLIST menuitem name #IMPLIED
204
position (top|bot) <span class="preprocessor">#IMPLIED ></span>
205
<span class="preprocessor"></span> <!ATTLIST toolitem name #IMPLIED
207
position (top|bot) <span class="preprocessor">#IMPLIED ></span>
208
<span class="preprocessor"></span> <!ATTLIST accelerator name #IMPLIED
209
action #REQUIRED >
210
</pre></div><p>There are some additional restrictions beyond those specified in the DTD, e.g. every toolitem must have a toolbar in its anchestry and every menuitem must have a + menubar or popup in its anchestry. Since a GMarkup parser is used to parse the UI description, it must not only be valid XML, but valid GMarkup.</p>
211
<p>If a name is not specified, it defaults to the action. If an action is not specified either, the element name is used. The name and action attributes must not contain '/' characters after parsing (since that would mess up path lookup) and must be usable as XML attributes when enclosed in doublequotes, thus they must not '"' characters or references to the " entity.</p>
212
<dl class="user"><dt><b>Example: UI Definition</b></dt><dd><div class="fragment"><pre class="fragment"> <ui>
214
<menu name=<span class="stringliteral">"FileMenu"</span> action=<span class="stringliteral">"FileMenuAction"</span>>
215
<menuitem name=<span class="stringliteral">"New"</span> action=<span class="stringliteral">"New2Action"</span> />
216
<placeholder name=<span class="stringliteral">"FileMenuAdditions"</span> />
218
<menu name=<span class="stringliteral">"JustifyMenu"</span> action=<span class="stringliteral">"JustifyMenuAction"</span>>
219
<menuitem name=<span class="stringliteral">"Left"</span> action=<span class="stringliteral">"justify-left"</span>/>
220
<menuitem name=<span class="stringliteral">"Centre"</span> action=<span class="stringliteral">"justify-center"</span>/>
221
<menuitem name=<span class="stringliteral">"Right"</span> action=<span class="stringliteral">"justify-right"</span>/>
222
<menuitem name=<span class="stringliteral">"Fill"</span> action=<span class="stringliteral">"justify-fill"</span>/>
225
<toolbar action=<span class="stringliteral">"toolbar1"</span>>
226
<placeholder name=<span class="stringliteral">"JustifyToolItems"</span>>
228
<toolitem name=<span class="stringliteral">"Left"</span> action=<span class="stringliteral">"justify-left"</span>/>
229
<toolitem name=<span class="stringliteral">"Centre"</span> action=<span class="stringliteral">"justify-center"</span>/>
230
<toolitem name=<span class="stringliteral">"Right"</span> action=<span class="stringliteral">"justify-right"</span>/>
231
<toolitem name=<span class="stringliteral">"Fill"</span> action=<span class="stringliteral">"justify-fill"</span>/>
236
</pre></div></dd></dl>
237
<p>The constructed widget hierarchy is very similar to the element tree of the XML, with the exception that placeholders are merged into their parents. The correspondence of XML elements to widgets should be almost obvious:</p>
239
<li>menubar a <a class="el" href="classGtk_1_1MenuBar.html" title="A standard menu bar which usually holds Gtk::Menu submenu items.">Gtk::MenuBar</a></li>
240
<li>toolbar a <a class="el" href="classGtk_1_1Toolbar.html" title="Bars of buttons and other widgets.">Gtk::Toolbar</a></li>
241
<li>popup a toplevel <a class="el" href="classGtk_1_1Menu.html" title="A drop-down menu consisting of Gtk::MenuItem objects which can be navigated and activated by the user...">Gtk::Menu</a></li>
242
<li>menu a <a class="el" href="classGtk_1_1Menu.html" title="A drop-down menu consisting of Gtk::MenuItem objects which can be navigated and activated by the user...">Gtk::Menu</a> attached to a menuitem</li>
243
<li>menuitem a <a class="el" href="classGtk_1_1MenuItem.html" title="Child item for menus.">Gtk::MenuItem</a> subclass, the exact type depends on the action</li>
244
<li>toolitem a <a class="el" href="classGtk_1_1ToolItem.html">Gtk::ToolItem</a> subclass, the exact type depends on the action. Note that toolitem elements may contain a menu element, but only if their associated action specifies a <a class="el" href="classGtk_1_1MenuToolButton.html" title="A Gtk::ToolItem containing a toggle button.">Gtk::MenuToolButton</a> as proxy.</li>
245
<li>separator a <a class="el" href="classGtk_1_1SeparatorMenuItem.html" title="A separator used to group items within a menu.">Gtk::SeparatorMenuItem</a> or <a class="el" href="classGtk_1_1SeparatorToolItem.html" title="A toolbar item that separates groups of other toolbar items.">Gtk::SeparatorToolItem</a></li>
246
<li>accelerator a keyboard accelerator</li>
248
<p>The "position" attribute determines where a constructed widget is positioned wrt. to its siblings in the partially constructed tree. If it is "top", the widget is prepended, otherwise it is appended.</p>
249
<dl class="user"><dt><b>UI Merging</b></dt><dd></dd></dl>
250
<p>The most remarkable feature of <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> is that it can overlay a set of menuitems and toolitems over another one, and demerge them later.</p>
251
<p>Merging is done based on the names of the XML elements. Each element is identified by a path which consists of the names of its anchestors, separated by slashes. For example, the menuitem named "Left" in the example above has the path /ui/menubar/JustifyMenu/Left and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.</p>
252
<dl class="user"><dt><b>Accelerators</b></dt><dd></dd></dl>
253
<p>Every action has an accelerator path. Accelerators are installed together with menuitem proxies, but they can also be explicitly added with <accelerator> elements in the UI definition. This makes it possible to have accelerators for actions even if they have no visible proxies.</p>
254
<dl class="user"><dt><b>Smart Separators</b></dt><dd></dd></dl>
255
<p>The separators created by <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> are "smart", i.e. they do not show up in the UI unless they end up between two visible menu or tool items. Separators which are located at the very beginning or end of the menu or toolbar containing them, or multiple separators next to each other, are hidden. This is a useful feature, since the merging of UI elements from multiple sources can make it hard or impossible to determine in advance whether a separator will end up in such an unfortunate position.</p>
256
<p>For separators in toolbars, you can set expand="true" to turn them from a small, visible separator to an expanding, invisible one. Toolitems following an expanding separator are effectively right-aligned.</p>
257
<dl class="user"><dt><b>Empty Menus</b></dt><dd></dd></dl>
258
<p>Submenus pose similar problems to separators inconnection with merging. It is impossible to know in advance whether they will end up empty after merging. <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> offers two ways to treat empty submenus:</p>
260
<li>make them disappear by hiding the menu item they're attached to</li>
261
<li>add an insensitive "Empty" item</li>
263
<p>The behaviour is chosen based on the "hide_if_empty" property of the action to which the submenu is associated.</p>
264
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000307">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
265
</div><hr/><h2>Member Typedef Documentation</h2>
266
<a class="anchor" id="a0682fad15edb0f4418487e555aa6805d"></a><!-- doxytag: member="Gtk::UIManager::ui_merge_id" ref="a0682fad15edb0f4418487e555aa6805d" args="" -->
267
<div class="memitem">
268
<div class="memproto">
269
<table class="memname">
271
<td class="memname">typedef guint <a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">Gtk::UIManager::ui_merge_id</a></td>
279
<hr/><h2>Constructor & Destructor Documentation</h2>
280
<a class="anchor" id="a3193cf4841782d2efb3836ad87f2bbb8"></a><!-- doxytag: member="Gtk::UIManager::~UIManager" ref="a3193cf4841782d2efb3836ad87f2bbb8" args="()" -->
281
<div class="memitem">
282
<div class="memproto">
283
<table class="memname">
285
<td class="memname">virtual Gtk::UIManager::~UIManager </td>
287
<td class="paramname"></td><td>)</td>
288
<td><code> [virtual]</code></td>
296
<a class="anchor" id="a2e1be63e14b8cd4b5b0dbb1e74757b3f"></a><!-- doxytag: member="Gtk::UIManager::UIManager" ref="a2e1be63e14b8cd4b5b0dbb1e74757b3f" args="()" -->
297
<div class="memitem">
298
<div class="memproto">
299
<table class="memname">
301
<td class="memname">Gtk::UIManager::UIManager </td>
303
<td class="paramname"></td><td>)</td>
304
<td><code> [protected]</code></td>
312
<hr/><h2>Member Function Documentation</h2>
313
<a class="anchor" id="a0a23ac89ab23915b675446cc1c10db1f"></a><!-- doxytag: member="Gtk::UIManager::add_ui" ref="a0a23ac89ab23915b675446cc1c10db1f" args="(ui_merge_id merge_id, const Glib::ustring &path, const Glib::ustring &name, const Glib::ustring &action, UIManagerItemType type=Gtk::UI_MANAGER_AUTO, bool top=true)" -->
314
<div class="memitem">
315
<div class="memproto">
316
<table class="memname">
318
<td class="memname">void Gtk::UIManager::add_ui </td>
320
<td class="paramtype"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td>
321
<td class="paramname"><em>merge_id</em>, </td>
324
<td class="paramkey"></td>
326
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
327
<td class="paramname"><em>path</em>, </td>
330
<td class="paramkey"></td>
332
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
333
<td class="paramname"><em>name</em>, </td>
336
<td class="paramkey"></td>
338
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
339
<td class="paramname"><em>action</em>, </td>
342
<td class="paramkey"></td>
344
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> </td>
345
<td class="paramname"><em>type</em> = <code>Gtk::UI_MANAGER_AUTO</code>, </td>
348
<td class="paramkey"></td>
350
<td class="paramtype">bool </td>
351
<td class="paramname"><em>top</em> = <code>true</code> </td>
362
<p>Adds a UI element to the current contents of <em>self</em>. </p>
363
<p>If <em>type</em> is Gtk::UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by <em>path</em>. Otherwise <em>type</em> must indicate an element that can be inserted at the place determined by <em>path</em>.</p>
364
<p><em>see</em> <a class="el" href="classGtk_1_1UIManager.html#a19b05ae50b353b39b60f467008c0c827" title="Adds a separator UI element to the current contents.">add_ui_separator()</a>.</p>
365
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000324">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
366
<dl><dt><b>Parameters:</b></dt><dd>
367
<table class="params">
368
<tr><td class="paramname">merge_id</td><td>The merge id for the merged UI, see gtk_ui_manager_new_merge_id(). </td></tr>
369
<tr><td class="paramname">path</td><td>A path. </td></tr>
370
<tr><td class="paramname">name</td><td>The name for the added UI element. </td></tr>
371
<tr><td class="paramname">action</td><td>The name of the action to be proxied, if this is not a separator. </td></tr>
372
<tr><td class="paramname">type</td><td>The type of UI element to add. </td></tr>
373
<tr><td class="paramname">top</td><td>If <code>true</code>, the UI element is added before its siblings, otherwise it is added after its siblings. </td></tr>
380
<a class="anchor" id="ad1377c506a357a7587d5e2bb5377881c"></a><!-- doxytag: member="Gtk::UIManager::add_ui_from_file" ref="ad1377c506a357a7587d5e2bb5377881c" args="(const Glib::ustring &filename)" -->
381
<div class="memitem">
382
<div class="memproto">
383
<table class="memname">
385
<td class="memname"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> Gtk::UIManager::add_ui_from_file </td>
387
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
388
<td class="paramname"><em>filename</em></td><td>)</td>
395
<p>Parses a file containing a and merges it with the current contents of <em>self</em>. </p>
396
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000323">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
397
<dl><dt><b>Parameters:</b></dt><dd>
398
<table class="params">
399
<tr><td class="paramname">filename</td><td>The name of the file to parse. </td></tr>
403
<dl class="return"><dt><b>Returns:</b></dt><dd>The merge id for the merged UI. The merge id can be used to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0. </dd></dl>
407
<a class="anchor" id="a403582b15c37408abaa868692d6a7abd"></a><!-- doxytag: member="Gtk::UIManager::add_ui_from_string" ref="a403582b15c37408abaa868692d6a7abd" args="(const Glib::ustring &buffer)" -->
408
<div class="memitem">
409
<div class="memproto">
410
<table class="memname">
412
<td class="memname"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> Gtk::UIManager::add_ui_from_string </td>
414
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
415
<td class="paramname"><em>buffer</em></td><td>)</td>
422
<p>Parses a string containing a UI definition and merges it with the current contents. </p>
423
<p>An enclosing <ui> element is added if it is missing.</p>
424
<dl><dt><b>Parameters:</b></dt><dd>
425
<table class="params">
426
<tr><td class="paramname">buffer</td><td>the string to parse </td></tr>
430
<dl class="return"><dt><b>Returns:</b></dt><dd>The merge id for the merged UI. The merge id can be used to unmerge the UI with <a class="el" href="classGtk_1_1UIManager.html#a0611594aa9d4df6febe90dbb9fe2fd21" title="Unmerges the part of selfs content identified by merge_id.">remove_ui()</a>. If an error occurred, the return value is 0. </dd></dl>
431
<dl><dt><b>Exceptions:</b></dt><dd>
432
<table class="exception">
433
<tr><td class="paramname">exception</td><td></td></tr>
437
<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>
441
<a class="anchor" id="a19b05ae50b353b39b60f467008c0c827"></a><!-- doxytag: member="Gtk::UIManager::add_ui_separator" ref="a19b05ae50b353b39b60f467008c0c827" args="(ui_merge_id merge_id, const Glib::ustring &path, const Glib::ustring &name="", UIManagerItemType type=Gtk::UI_MANAGER_AUTO, bool top=true)" -->
442
<div class="memitem">
443
<div class="memproto">
444
<table class="memname">
446
<td class="memname">void Gtk::UIManager::add_ui_separator </td>
448
<td class="paramtype"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td>
449
<td class="paramname"><em>merge_id</em>, </td>
452
<td class="paramkey"></td>
454
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
455
<td class="paramname"><em>path</em>, </td>
458
<td class="paramkey"></td>
460
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
461
<td class="paramname"><em>name</em> = <code>""</code>, </td>
464
<td class="paramkey"></td>
466
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> </td>
467
<td class="paramname"><em>type</em> = <code>Gtk::UI_MANAGER_AUTO</code>, </td>
470
<td class="paramkey"></td>
472
<td class="paramtype">bool </td>
473
<td class="paramname"><em>top</em> = <code>true</code> </td>
484
<p>Adds a separator UI element to the current contents. </p>
485
<p>If <em>type</em> is Gtk::UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or separator if such an element can be inserted at the place determined by <em>path</em> . Otherwise <em>type</em> must indicate an element that can be inserted at the place determined by <em>path</em>.</p>
486
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGtk_1_1UIManager.html#a0a23ac89ab23915b675446cc1c10db1f" title="Adds a UI element to the current contents of self.">add_ui()</a>.</dd></dl>
487
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000325">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
488
<dl><dt><b>Parameters:</b></dt><dd>
489
<table class="params">
490
<tr><td class="paramname">merge_id</td><td>The merge id for the merged UI, see gtk_ui_manager_new_merge_id(). </td></tr>
491
<tr><td class="paramname">path</td><td>A path. </td></tr>
492
<tr><td class="paramname">name</td><td>The name for the added UI element. </td></tr>
493
<tr><td class="paramname">type</td><td>The type of UI element to add. </td></tr>
494
<tr><td class="paramname">top</td><td>If <code>true</code>, the UI element is added before its siblings, otherwise it is added after its siblings. </td></tr>
501
<a class="anchor" id="af2a1f8d72acc2070660cf6d37dfb37a5"></a><!-- doxytag: member="Gtk::UIManager::create" ref="af2a1f8d72acc2070660cf6d37dfb37a5" args="()" -->
502
<div class="memitem">
503
<div class="memproto">
504
<table class="memname">
506
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1UIManager.html">UIManager</a>> Gtk::UIManager::create </td>
508
<td class="paramname"></td><td>)</td>
509
<td><code> [static]</code></td>
517
<a class="anchor" id="aa3a3f4e8bdd7488eab875e9bbfd2ae15"></a><!-- doxytag: member="Gtk::UIManager::ensure_update" ref="aa3a3f4e8bdd7488eab875e9bbfd2ae15" args="()" -->
518
<div class="memitem">
519
<div class="memproto">
520
<table class="memname">
522
<td class="memname">void Gtk::UIManager::ensure_update </td>
524
<td class="paramname"></td><td>)</td>
531
<p>Makes sure that all pending updates to the UI have been completed. </p>
532
<p>This may occasionally be necessary, since <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> updates the UI in an idle function. A typical example where this function is useful is to enforce that the menubar and toolbar have been added to the main window before showing it: |[ gtk_container_add (GTK_CONTAINER (window), vbox); g_signal_connect (merge, "add-widget", G_CALLBACK (add_widget), vbox); gtk_ui_manager_add_ui_from_file (merge, "my-menus"); gtk_ui_manager_add_ui_from_file (merge, "my-toolbars"); gtk_ui_manager_ensure_update (merge); gtk_widget_show (window); ]|</p>
533
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000328">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
537
<a class="anchor" id="a56f55fb4e8428dbc65c49cf1229775c4"></a><!-- doxytag: member="Gtk::UIManager::get_accel_group" ref="a56f55fb4e8428dbc65c49cf1229775c4" args="()" -->
538
<div class="memitem">
539
<div class="memproto">
540
<table class="memname">
542
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1AccelGroup.html">AccelGroup</a>> Gtk::UIManager::get_accel_group </td>
544
<td class="paramname"></td><td>)</td>
551
<p>Returns the <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a> associated with <em>self</em>. </p>
552
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000314">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
553
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a>. </dd></dl>
557
<a class="anchor" id="a42211d42cb736b8f2b5b0d0d20f85e05"></a><!-- doxytag: member="Gtk::UIManager::get_accel_group" ref="a42211d42cb736b8f2b5b0d0d20f85e05" args="() const " -->
558
<div class="memitem">
559
<div class="memproto">
560
<table class="memname">
562
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGtk_1_1AccelGroup.html">AccelGroup</a>> Gtk::UIManager::get_accel_group </td>
564
<td class="paramname"></td><td>)</td>
571
<p>Returns the <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a> associated with <em>self</em>. </p>
572
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000315">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
573
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classGtk_1_1AccelGroup.html" title="A Gtk::AccelGroup represents a group of keyboard accelerators, typically attached to a toplevel Gtk::...">Gtk::AccelGroup</a>. </dd></dl>
577
<a class="anchor" id="a5486fde7529fd2f6e0cfbea2780e5d32"></a><!-- doxytag: member="Gtk::UIManager::get_action" ref="a5486fde7529fd2f6e0cfbea2780e5d32" args="(const Glib::ustring &path)" -->
578
<div class="memitem">
579
<div class="memproto">
580
<table class="memname">
582
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Action.html">Action</a>> Gtk::UIManager::get_action </td>
584
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
585
<td class="paramname"><em>path</em></td><td>)</td>
592
<p>Looks up an action by following a path. </p>
593
<p>See gtk_ui_manager_get_widget() for more information about paths.</p>
594
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000320">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
595
<dl><dt><b>Parameters:</b></dt><dd>
596
<table class="params">
597
<tr><td class="paramname">path</td><td>A path. </td></tr>
601
<dl class="return"><dt><b>Returns:</b></dt><dd>The action whose proxy widget is found by following the path, or <code>0</code> if no widget was found. </dd></dl>
605
<a class="anchor" id="ab4b3f27d94dc1363ec10915cffa7f3a7"></a><!-- doxytag: member="Gtk::UIManager::get_action" ref="ab4b3f27d94dc1363ec10915cffa7f3a7" args="(const Glib::ustring &path) const " -->
606
<div class="memitem">
607
<div class="memproto">
608
<table class="memname">
610
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGtk_1_1Action.html">Action</a>> Gtk::UIManager::get_action </td>
612
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
613
<td class="paramname"><em>path</em></td><td>)</td>
620
<p>Looks up an action by following a path. </p>
621
<p>See gtk_ui_manager_get_widget() for more information about paths.</p>
622
<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>
623
<dl><dt><b>Parameters:</b></dt><dd>
624
<table class="params">
625
<tr><td class="paramname">path</td><td>A path. </td></tr>
629
<dl class="return"><dt><b>Returns:</b></dt><dd>The action whose proxy widget is found by following the path, or <code>0</code> if no widget was found. </dd></dl>
633
<a class="anchor" id="ab0fcfc16bf3763645b083848d5f5f33b"></a><!-- doxytag: member="Gtk::UIManager::get_action_groups" ref="ab0fcfc16bf3763645b083848d5f5f33b" args="()" -->
634
<div class="memitem">
635
<div class="memproto">
636
<table class="memname">
638
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a>> > Gtk::UIManager::get_action_groups </td>
640
<td class="paramname"></td><td>)</td>
647
<p>Returns the list of action groups associated with <em>self</em>. </p>
648
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000312">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
649
<dl class="return"><dt><b>Returns:</b></dt><dd>A List of action groups. The list is owned by GTK+ and should not be modified. </dd></dl>
653
<a class="anchor" id="a6d8e6a1ac268dbbd7fd28d9fbe1c5aa4"></a><!-- doxytag: member="Gtk::UIManager::get_action_groups" ref="a6d8e6a1ac268dbbd7fd28d9fbe1c5aa4" args="() const " -->
654
<div class="memitem">
655
<div class="memproto">
656
<table class="memname">
658
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a>> > Gtk::UIManager::get_action_groups </td>
660
<td class="paramname"></td><td>)</td>
667
<p>Returns the list of action groups associated with <em>self</em>. </p>
668
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000313">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
669
<dl class="return"><dt><b>Returns:</b></dt><dd>A List of action groups. The list is owned by GTK+ and should not be modified. </dd></dl>
673
<a class="anchor" id="a199dfed5c1bdae63887ee2bed7c559fd"></a><!-- doxytag: member="Gtk::UIManager::get_add_tearoffs" ref="a199dfed5c1bdae63887ee2bed7c559fd" args="() const " -->
674
<div class="memitem">
675
<div class="memproto">
676
<table class="memname">
678
<td class="memname">bool Gtk::UIManager::get_add_tearoffs </td>
680
<td class="paramname"></td><td>)</td>
687
<p>Returns whether menus generated by this <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> will have tearoff menu items. </p>
688
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000309">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
689
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether tearoff menu items are added. </dd></dl>
693
<a class="anchor" id="a5e340833b5766122d0901dc98e42bc0b"></a><!-- doxytag: member="Gtk::UIManager::get_toplevels" ref="a5e340833b5766122d0901dc98e42bc0b" args="(UIManagerItemType types) const " -->
694
<div class="memitem">
695
<div class="memproto">
696
<table class="memname">
698
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a><const <a class="el" href="classGtk_1_1Widget.html">Widget</a>*> Gtk::UIManager::get_toplevels </td>
700
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> </td>
701
<td class="paramname"><em>types</em></td><td>)</td>
708
<p>Obtains a list of all toplevel widgets of the requested types. </p>
709
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000319">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
710
<dl><dt><b>Parameters:</b></dt><dd>
711
<table class="params">
712
<tr><td class="paramname">types</td><td>Specifies the types of toplevel widgets to include. Allowed types are Gtk::UI_MANAGER_MENUBAR, Gtk::UI_MANAGER_TOOLBAR and Gtk::UI_MANAGER_POPUP. </td></tr>
716
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly-allocated SList of all toplevel widgets of the requested types. Free the returned list with Glib::slist_free(). </dd></dl>
720
<a class="anchor" id="aaf34fa7155944190cf80432e7bccbd52"></a><!-- doxytag: member="Gtk::UIManager::get_toplevels" ref="aaf34fa7155944190cf80432e7bccbd52" args="(UIManagerItemType types)" -->
721
<div class="memitem">
722
<div class="memproto">
723
<table class="memname">
725
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SListHandle.html">Glib::SListHandle</a><<a class="el" href="classGtk_1_1Widget.html">Widget</a>*> Gtk::UIManager::get_toplevels </td>
727
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga91226ea137a67080d9b487225aa41d7b">UIManagerItemType</a> </td>
728
<td class="paramname"><em>types</em></td><td>)</td>
735
<p>Obtains a list of all toplevel widgets of the requested types. </p>
736
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000318">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
737
<dl><dt><b>Parameters:</b></dt><dd>
738
<table class="params">
739
<tr><td class="paramname">types</td><td>Specifies the types of toplevel widgets to include. Allowed types are Gtk::UI_MANAGER_MENUBAR, Gtk::UI_MANAGER_TOOLBAR and Gtk::UI_MANAGER_POPUP. </td></tr>
743
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly-allocated SList of all toplevel widgets of the requested types. Free the returned list with Glib::slist_free(). </dd></dl>
747
<a class="anchor" id="ad85b3e2cb26b4535d71a57ac81f61918"></a><!-- doxytag: member="Gtk::UIManager::get_ui" ref="ad85b3e2cb26b4535d71a57ac81f61918" args="() const " -->
748
<div class="memitem">
749
<div class="memproto">
750
<table class="memname">
752
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::UIManager::get_ui </td>
754
<td class="paramname"></td><td>)</td>
761
<p>Creates a of the merged UI. </p>
762
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000327">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
763
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly allocated string containing an XML representation of the merged UI. </dd></dl>
767
<a class="anchor" id="a93357a4791e1740610fadb0ba088cbf3"></a><!-- doxytag: member="Gtk::UIManager::get_widget" ref="a93357a4791e1740610fadb0ba088cbf3" args="(const Glib::ustring &path)" -->
768
<div class="memitem">
769
<div class="memproto">
770
<table class="memname">
772
<td class="memname"><a class="el" href="classGtk_1_1Widget.html">Widget</a>* Gtk::UIManager::get_widget </td>
774
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
775
<td class="paramname"><em>path</em></td><td>)</td>
782
<p>Looks up a widget by following a path. </p>
783
<p>The path consists of the names specified in the XML description of the UI. separated by '/'. Elements which don't have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.</p>
784
<p>Note that the widget found by following a path that ends in a <menu> element is the menuitem to which the menu is attached, not the menu itself.</p>
785
<p>Also note that the widgets constructed by a ui manager are not tied to the lifecycle of the ui manager. If you add the widgets returned by this function to some container or explicitly ref them, they will survive the destruction of the ui manager.</p>
786
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000316">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
787
<dl><dt><b>Parameters:</b></dt><dd>
788
<table class="params">
789
<tr><td class="paramname">path</td><td>A path. </td></tr>
793
<dl class="return"><dt><b>Returns:</b></dt><dd>The widget found by following the path, or <code>0</code> if no widget was found. </dd></dl>
797
<a class="anchor" id="a38de43f04c160b1ddf238da0f0309cc0"></a><!-- doxytag: member="Gtk::UIManager::get_widget" ref="a38de43f04c160b1ddf238da0f0309cc0" args="(const Glib::ustring &path) const " -->
798
<div class="memitem">
799
<div class="memproto">
800
<table class="memname">
802
<td class="memname">const <a class="el" href="classGtk_1_1Widget.html">Widget</a>* Gtk::UIManager::get_widget </td>
804
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
805
<td class="paramname"><em>path</em></td><td>)</td>
812
<p>Looks up a widget by following a path. </p>
813
<p>The path consists of the names specified in the XML description of the UI. separated by '/'. Elements which don't have a name or action attribute in the XML (e.g. <popup>) can be addressed by their XML element name (e.g. "popup"). The root element ("/ui") can be omitted in the path.</p>
814
<p>Note that the widget found by following a path that ends in a <menu> element is the menuitem to which the menu is attached, not the menu itself.</p>
815
<p>Also note that the widgets constructed by a ui manager are not tied to the lifecycle of the ui manager. If you add the widgets returned by this function to some container or explicitly ref them, they will survive the destruction of the ui manager.</p>
816
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000317">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
817
<dl><dt><b>Parameters:</b></dt><dd>
818
<table class="params">
819
<tr><td class="paramname">path</td><td>A path. </td></tr>
823
<dl class="return"><dt><b>Returns:</b></dt><dd>The widget found by following the path, or <code>0</code> if no widget was found. </dd></dl>
827
<a class="anchor" id="adcbc82741d92ed865d1d63eddabb7d99"></a><!-- doxytag: member="Gtk::UIManager::gobj" ref="adcbc82741d92ed865d1d63eddabb7d99" args="()" -->
828
<div class="memitem">
829
<div class="memproto">
830
<table class="memname">
832
<td class="memname">GtkUIManager* Gtk::UIManager::gobj </td>
834
<td class="paramname"></td><td>)</td>
835
<td><code> [inline]</code></td>
841
<p>Provides access to the underlying C GObject. </p>
843
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
847
<a class="anchor" id="aae9a90e30c01a024da550dddd9d86363"></a><!-- doxytag: member="Gtk::UIManager::gobj" ref="aae9a90e30c01a024da550dddd9d86363" args="() const " -->
848
<div class="memitem">
849
<div class="memproto">
850
<table class="memname">
852
<td class="memname">const GtkUIManager* Gtk::UIManager::gobj </td>
854
<td class="paramname"></td><td>)</td>
855
<td> const<code> [inline]</code></td>
861
<p>Provides access to the underlying C GObject. </p>
863
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
867
<a class="anchor" id="a49c2a2f2d2b9c7db91cfce222c6d9139"></a><!-- doxytag: member="Gtk::UIManager::gobj_copy" ref="a49c2a2f2d2b9c7db91cfce222c6d9139" args="()" -->
868
<div class="memitem">
869
<div class="memproto">
870
<table class="memname">
872
<td class="memname">GtkUIManager* Gtk::UIManager::gobj_copy </td>
874
<td class="paramname"></td><td>)</td>
881
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
885
<a class="anchor" id="a50cc8ee94cb48ddef6516883a0dd9047"></a><!-- doxytag: member="Gtk::UIManager::insert_action_group" ref="a50cc8ee94cb48ddef6516883a0dd9047" args="(const Glib::RefPtr< ActionGroup > &action_group, int pos=0)" -->
886
<div class="memitem">
887
<div class="memproto">
888
<table class="memname">
890
<td class="memname">void Gtk::UIManager::insert_action_group </td>
892
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> >& </td>
893
<td class="paramname"><em>action_group</em>, </td>
896
<td class="paramkey"></td>
898
<td class="paramtype">int </td>
899
<td class="paramname"><em>pos</em> = <code>0</code> </td>
910
<p>Inserts an action group into the list of action groups associated with <em>self</em>. </p>
911
<p>Actions in earlier groups hide actions with the same name in later groups.</p>
912
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000310">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
913
<dl><dt><b>Parameters:</b></dt><dd>
914
<table class="params">
915
<tr><td class="paramname">action_group</td><td>The action group to be inserted. </td></tr>
916
<tr><td class="paramname">pos</td><td>The position at which the group will be inserted. </td></tr>
923
<a class="anchor" id="ac5cb767d3ba718492972e7f9c5f02fb7"></a><!-- doxytag: member="Gtk::UIManager::new_merge_id" ref="ac5cb767d3ba718492972e7f9c5f02fb7" args="()" -->
924
<div class="memitem">
925
<div class="memproto">
926
<table class="memname">
928
<td class="memname"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> Gtk::UIManager::new_merge_id </td>
930
<td class="paramname"></td><td>)</td>
937
<p>Returns an unused merge id, suitable for use with gtk_ui_manager_add_ui(). </p>
938
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000329">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
939
<dl class="return"><dt><b>Returns:</b></dt><dd>An unused merge id. </dd></dl>
943
<a class="anchor" id="a79662f2d8e965519097b791f2af96ce3"></a><!-- doxytag: member="Gtk::UIManager::on_actions_changed" ref="a79662f2d8e965519097b791f2af96ce3" args="()" -->
944
<div class="memitem">
945
<div class="memproto">
946
<table class="memname">
948
<td class="memname">virtual void Gtk::UIManager::on_actions_changed </td>
950
<td class="paramname"></td><td>)</td>
951
<td><code> [protected, virtual]</code></td>
959
<a class="anchor" id="a543fc31062484f6f230320f3d6f939e8"></a><!-- doxytag: member="Gtk::UIManager::on_add_widget" ref="a543fc31062484f6f230320f3d6f939e8" args="(Widget *widget)" -->
960
<div class="memitem">
961
<div class="memproto">
962
<table class="memname">
964
<td class="memname">virtual void Gtk::UIManager::on_add_widget </td>
966
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>* </td>
967
<td class="paramname"><em>widget</em></td><td>)</td>
968
<td><code> [protected, virtual]</code></td>
976
<a class="anchor" id="abaecd90445fa40cf1b7923845d03f70a"></a><!-- doxytag: member="Gtk::UIManager::property_add_tearoffs" ref="abaecd90445fa40cf1b7923845d03f70a" args="()" -->
977
<div class="memitem">
978
<div class="memproto">
979
<table class="memname">
981
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::UIManager::property_add_tearoffs </td>
983
<td class="paramname"></td><td>)</td>
990
<p>Whether tearoff menu items should be added to menus. </p>
991
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
992
<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>
996
<a class="anchor" id="abac08a288b27cc0f284aedfbc7289d98"></a><!-- doxytag: member="Gtk::UIManager::property_add_tearoffs" ref="abac08a288b27cc0f284aedfbc7289d98" args="() const " -->
997
<div class="memitem">
998
<div class="memproto">
999
<table class="memname">
1001
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::UIManager::property_add_tearoffs </td>
1003
<td class="paramname"></td><td>)</td>
1008
<div class="memdoc">
1010
<p>Whether tearoff menu items should be added to menus. </p>
1011
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
1012
<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>
1016
<a class="anchor" id="aba5843176409db66c211911cce9d6eb8"></a><!-- doxytag: member="Gtk::UIManager::property_ui" ref="aba5843176409db66c211911cce9d6eb8" args="() const " -->
1017
<div class="memitem">
1018
<div class="memproto">
1019
<table class="memname">
1021
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::UIManager::property_ui </td>
1023
<td class="paramname"></td><td>)</td>
1028
<div class="memdoc">
1030
<p>An XML string describing the merged UI. </p>
1031
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
1032
<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>
1036
<a class="anchor" id="a13551c32d6aa054c8c6771086727c576"></a><!-- doxytag: member="Gtk::UIManager::remove_action_group" ref="a13551c32d6aa054c8c6771086727c576" args="(const Glib::RefPtr< ActionGroup > &action_group)" -->
1037
<div class="memitem">
1038
<div class="memproto">
1039
<table class="memname">
1041
<td class="memname">void Gtk::UIManager::remove_action_group </td>
1043
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1ActionGroup.html">ActionGroup</a> >& </td>
1044
<td class="paramname"><em>action_group</em></td><td>)</td>
1049
<div class="memdoc">
1051
<p>Removes an action group from the list of action groups associated with <em>self</em>. </p>
1052
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000311">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
1053
<dl><dt><b>Parameters:</b></dt><dd>
1054
<table class="params">
1055
<tr><td class="paramname">action_group</td><td>The action group to be removed. </td></tr>
1062
<a class="anchor" id="a0611594aa9d4df6febe90dbb9fe2fd21"></a><!-- doxytag: member="Gtk::UIManager::remove_ui" ref="a0611594aa9d4df6febe90dbb9fe2fd21" args="(ui_merge_id merge_id)" -->
1063
<div class="memitem">
1064
<div class="memproto">
1065
<table class="memname">
1067
<td class="memname">void Gtk::UIManager::remove_ui </td>
1069
<td class="paramtype"><a class="el" href="classGtk_1_1UIManager.html#a0682fad15edb0f4418487e555aa6805d">ui_merge_id</a> </td>
1070
<td class="paramname"><em>merge_id</em></td><td>)</td>
1075
<div class="memdoc">
1077
<p>Unmerges the part of <em>selfs</em> content identified by <em>merge_id</em>. </p>
1078
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000326">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
1079
<dl><dt><b>Parameters:</b></dt><dd>
1080
<table class="params">
1081
<tr><td class="paramname">merge_id</td><td>A merge id as returned by gtk_ui_manager_add_ui_from_string(). </td></tr>
1088
<a class="anchor" id="aaaa2dd331a1a300e21e8b61b1e9f6c46"></a><!-- doxytag: member="Gtk::UIManager::set_add_tearoffs" ref="aaaa2dd331a1a300e21e8b61b1e9f6c46" args="(bool add_tearoffs=true)" -->
1089
<div class="memitem">
1090
<div class="memproto">
1091
<table class="memname">
1093
<td class="memname">void Gtk::UIManager::set_add_tearoffs </td>
1095
<td class="paramtype">bool </td>
1096
<td class="paramname"><em>add_tearoffs</em> = <code>true</code></td><td>)</td>
1101
<div class="memdoc">
1103
<p>Sets the "add_tearoffs" property, which controls whether menus generated by this <a class="el" href="classGtk_1_1UIManager.html" title="Constructing menus and toolbars from an XML description.">Gtk::UIManager</a> will have tearoff menu items. </p>
1104
<p>Note that this only affects regular menus. Generated popup menus never have tearoff menu items.</p>
1105
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000308">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
1106
<dl><dt><b>Parameters:</b></dt><dd>
1107
<table class="params">
1108
<tr><td class="paramname">add_tearoffs</td><td>Whether tearoff menu items are added. </td></tr>
1115
<a class="anchor" id="ab670a3d562a988c0ed866faaae5e4223"></a><!-- doxytag: member="Gtk::UIManager::signal_actions_changed" ref="ab670a3d562a988c0ed866faaae5e4223" args="()" -->
1116
<div class="memitem">
1117
<div class="memproto">
1118
<table class="memname">
1120
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::UIManager::signal_actions_changed </td>
1122
<td class="paramname"></td><td>)</td>
1127
<div class="memdoc">
1129
<p>The "actions-changed" signal is emitted whenever the set of actions changes. </p>
1130
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_actions_changed()</code> </dd></dl>
1134
<a class="anchor" id="a92f803fbd7048cdfeb94d0b395435292"></a><!-- doxytag: member="Gtk::UIManager::signal_add_widget" ref="a92f803fbd7048cdfeb94d0b395435292" args="()" -->
1135
<div class="memitem">
1136
<div class="memproto">
1137
<table class="memname">
1139
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void,<a class="el" href="classGtk_1_1Widget.html">Widget</a>* > Gtk::UIManager::signal_add_widget </td>
1141
<td class="paramname"></td><td>)</td>
1146
<div class="memdoc">
1148
<p>The add_widget signal is emitted for each generated menubar and toolbar. </p>
1149
<p>It is not emitted for generated popup menus, which can be obtained by <a class="el" href="classGtk_1_1UIManager.html#a93357a4791e1740610fadb0ba088cbf3" title="Looks up a widget by following a path.">get_widget()</a>.</p>
1150
<dl><dt><b>Parameters:</b></dt><dd>
1151
<table class="params">
1152
<tr><td class="paramname">widget</td><td>the added widget</td></tr>
1156
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_add_widget(Widget* widget)</code> </dd></dl>
1160
<a class="anchor" id="a0fd9d67e67983ee5dd914812a7153e95"></a><!-- doxytag: member="Gtk::UIManager::signal_connect_proxy" ref="a0fd9d67e67983ee5dd914812a7153e95" args="()" -->
1161
<div class="memitem">
1162
<div class="memproto">
1163
<table class="memname">
1165
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void,const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Action.html">Action</a>>&,<a class="el" href="classGtk_1_1Widget.html">Widget</a>* > Gtk::UIManager::signal_connect_proxy </td>
1167
<td class="paramname"></td><td>)</td>
1172
<div class="memdoc">
1174
<p>The connect_proxy signal is emitted after connecting a proxy to an action in the group. </p>
1175
<p>This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.</p>
1176
<dl><dt><b>Parameters:</b></dt><dd>
1177
<table class="params">
1178
<tr><td class="paramname">action</td><td>the action </td></tr>
1179
<tr><td class="paramname">widget</td><td>the proxy</td></tr>
1183
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_connect_proxy(const Glib::RefPtr<Action>& action, Widget* widget)</code> </dd></dl>
1187
<a class="anchor" id="aa133acc14dd552ad2df62b21ea7e4ebb"></a><!-- doxytag: member="Gtk::UIManager::signal_disconnect_proxy" ref="aa133acc14dd552ad2df62b21ea7e4ebb" args="()" -->
1188
<div class="memitem">
1189
<div class="memproto">
1190
<table class="memname">
1192
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy2.html">Glib::SignalProxy2</a>< void,const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Action.html">Action</a>>&,<a class="el" href="classGtk_1_1Widget.html">Widget</a>* > Gtk::UIManager::signal_disconnect_proxy </td>
1194
<td class="paramname"></td><td>)</td>
1199
<div class="memdoc">
1201
<p>The disconnect_proxy signal is emitted after disconnecting a proxy from an action in the group. </p>
1202
<dl><dt><b>Parameters:</b></dt><dd>
1203
<table class="params">
1204
<tr><td class="paramname">action</td><td>the action </td></tr>
1205
<tr><td class="paramname">widget</td><td>the proxy</td></tr>
1209
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_disconnect_proxy(const Glib::RefPtr<Action>& action, Widget* widget)</code> </dd></dl>
1213
<a class="anchor" id="a0243e755d2a8da7d658000c1b20f221d"></a><!-- doxytag: member="Gtk::UIManager::signal_post_activate" ref="a0243e755d2a8da7d658000c1b20f221d" args="()" -->
1214
<div class="memitem">
1215
<div class="memproto">
1216
<table class="memname">
1218
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void,const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Action.html">Action</a>>& > Gtk::UIManager::signal_post_activate </td>
1220
<td class="paramname"></td><td>)</td>
1225
<div class="memdoc">
1227
<p>The post_activate signal is emitted just after the <em>action</em> is activated. </p>
1228
<p>This is intended for applications to get notification just after any action is activated.</p>
1229
<dl><dt><b>Parameters:</b></dt><dd>
1230
<table class="params">
1231
<tr><td class="paramname">action</td><td>the action</td></tr>
1235
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_post_activate(const Glib::RefPtr<Action>& action)</code> </dd></dl>
1239
<a class="anchor" id="a13c399f0521ccc99a09611879038cee9"></a><!-- doxytag: member="Gtk::UIManager::signal_pre_activate" ref="a13c399f0521ccc99a09611879038cee9" args="()" -->
1240
<div class="memitem">
1241
<div class="memproto">
1242
<table class="memname">
1244
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy1.html">Glib::SignalProxy1</a>< void,const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGtk_1_1Action.html">Action</a>>& > Gtk::UIManager::signal_pre_activate </td>
1246
<td class="paramname"></td><td>)</td>
1251
<div class="memdoc">
1253
<p>The pre_activate signal is emitted just before the <em>action</em> is activated. </p>
1254
<p>This is intended for applications to get notification just before any action is activated.</p>
1255
<dl><dt><b>Parameters:</b></dt><dd>
1256
<table class="params">
1257
<tr><td class="paramname">action</td><td>the action</td></tr>
1261
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_pre_activate(const Glib::RefPtr<Action>& action)</code> </dd></dl>
1265
<hr/><h2>Friends And Related Function Documentation</h2>
1266
<a class="anchor" id="ad36176bdb92cd8f85fc7c0fcd5868e9a"></a><!-- doxytag: member="Gtk::UIManager::wrap" ref="ad36176bdb92cd8f85fc7c0fcd5868e9a" args="(GtkUIManager *object, bool take_copy=false)" -->
1267
<div class="memitem">
1268
<div class="memproto">
1269
<table class="memname">
1271
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1UIManager.html">Gtk::UIManager</a> > wrap </td>
1273
<td class="paramtype">GtkUIManager * </td>
1274
<td class="paramname"><em>object</em>, </td>
1277
<td class="paramkey"></td>
1279
<td class="paramtype">bool </td>
1280
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
1285
<td></td><td><code> [related]</code></td>
1289
<div class="memdoc">
1291
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
1292
<dl><dt><b>Parameters:</b></dt><dd>
1293
<table class="params">
1294
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
1295
<tr><td class="paramname">take_copy</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>
1299
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
1303
<hr/>The documentation for this class was generated from the following file:<ul>
1304
<li>gtkmm/uimanager.h</li>
1307
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:48 for gtkmm by 
1308
<a href="http://www.doxygen.org/index.html">
1309
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1UIManager.html
