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::SeparatorToolItem 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">3.0.1</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_1SeparatorToolItem.html">SeparatorToolItem</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#related">Related Functions</a> </div>
51
<div class="headertitle">
52
<h1>Gtk::SeparatorToolItem Class Reference<div class="ingroups"><a class="el" href="group__Widgets.html">Widgets</a></div></h1> </div>
54
<div class="contents">
55
<!-- doxytag: class="Gtk::SeparatorToolItem" --><!-- doxytag: inherits="Gtk::ToolItem" -->
56
<p>A toolbar item that separates groups of other toolbar items. <a href="#_details">More...</a></p>
57
<div class="dynheader">
58
Inheritance diagram for Gtk::SeparatorToolItem:</div>
59
<div class="dyncontent">
60
<div class="center"><img src="classGtk_1_1SeparatorToolItem__inherit__graph.png" border="0" usemap="#Gtk_1_1SeparatorToolItem_inherit__map" alt="Inheritance graph"/></div>
61
<map name="Gtk_1_1SeparatorToolItem_inherit__map" id="Gtk_1_1SeparatorToolItem_inherit__map">
62
<area shape="rect" id="node2" href="classGtk_1_1ToolItem.html" title="Gtk::ToolItem" alt="" coords="259,566,360,597"/><area shape="rect" id="node4" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="229,486,299,517"/><area shape="rect" id="node6" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="189,406,296,437"/><area shape="rect" id="node8" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="152,326,243,357"/><area shape="rect" id="node10" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="7,246,95,277"/><area shape="rect" id="node12" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,166,96,197"/><area shape="rect" id="node14" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,86,171,117"/><area shape="rect" id="node20" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="120,166,224,197"/><area shape="rect" id="node16" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,6,164,37"/><area shape="rect" id="node18" href="classGtk_1_1Buildable.html" title="A base class for objects that can be built by Gtk::Builder." alt="" coords="119,246,223,277"/><area shape="rect" id="node25" href="classGtk_1_1Activatable.html" title="Activatable widgets can be connected to a Gtk::Action and reflect the state of the action..." alt="" coords="321,326,436,357"/><area shape="rect" id="node23" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="247,246,369,277"/></map>
63
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
64
<div class="dynheader">
65
Collaboration diagram for Gtk::SeparatorToolItem:</div>
66
<div class="dyncontent">
67
<div class="center"><img src="classGtk_1_1SeparatorToolItem__coll__graph.png" border="0" usemap="#Gtk_1_1SeparatorToolItem_coll__map" alt="Collaboration graph"/></div>
68
<map name="Gtk_1_1SeparatorToolItem_coll__map" id="Gtk_1_1SeparatorToolItem_coll__map">
69
<area shape="rect" id="node2" href="classGtk_1_1ToolItem.html" title="Gtk::ToolItem" alt="" coords="259,566,360,597"/><area shape="rect" id="node4" href="classGtk_1_1Bin.html" title="A container with just one child." alt="" coords="229,486,299,517"/><area shape="rect" id="node6" href="classGtk_1_1Container.html" title="Abstract container class." alt="" coords="189,406,296,437"/><area shape="rect" id="node8" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)" alt="" coords="152,326,243,357"/><area shape="rect" id="node10" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="7,246,95,277"/><area shape="rect" id="node12" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="5,166,96,197"/><area shape="rect" id="node14" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="51,86,171,117"/><area shape="rect" id="node20" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="120,166,224,197"/><area shape="rect" id="node16" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="57,6,164,37"/><area shape="rect" id="node18" href="classGtk_1_1Buildable.html" title="A base class for objects that can be built by Gtk::Builder." alt="" coords="119,246,223,277"/><area shape="rect" id="node25" href="classGtk_1_1Activatable.html" title="Activatable widgets can be connected to a Gtk::Action and reflect the state of the action..." alt="" coords="321,326,436,357"/><area shape="rect" id="node23" href="classAtk_1_1Implementor.html" title="Atk::Implementor" alt="" coords="247,246,369,277"/></map>
70
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
72
<p><a href="classGtk_1_1SeparatorToolItem-members.html">List of all members.</a></p>
73
<table class="memberdecls">
74
<tr><td colspan="2"><h2><a name="pub-methods"></a>
75
Public Member Functions</h2></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#a83cdeafb1e47ff62d741dc827bab2dc7">~SeparatorToolItem</a> ()</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">GtkSeparatorToolItem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#af88c8baefe7909b8544bda83705220ee">gobj</a> ()</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#af88c8baefe7909b8544bda83705220ee"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">const GtkSeparatorToolItem* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#aac14dc8f944446718d36d491409c839d">gobj</a> () const </td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#aac14dc8f944446718d36d491409c839d"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#aae94d511716e5c30272ac2ef971145d4">SeparatorToolItem</a> ()</td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#ad2c43eff6973b44cf8f7900ae14c720b">get_draw</a> () const </td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether <em>item</em> is drawn as a line, or just blank. <a href="#ad2c43eff6973b44cf8f7900ae14c720b"></a><br/></td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#ad00c20f3021f99fcd2e005d8e78cbca6">set_draw</a> (bool draw=true)</td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether <em>item</em> is drawn as a vertical line, or just blank. <a href="#ad00c20f3021f99fcd2e005d8e78cbca6"></a><br/></td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#ae1622e79f2128bcd658768439ed4861b">property_draw</a> ()</td></tr>
87
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the separator is drawn, or just blank. <a href="#ae1622e79f2128bcd658768439ed4861b"></a><br/></td></tr>
88
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
89
< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#a238e9720c26c28332b58b3f8665e7a7d">property_draw</a> () const </td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the separator is drawn, or just blank. <a href="#a238e9720c26c28332b58b3f8665e7a7d"></a><br/></td></tr>
91
<tr><td colspan="2"><h2><a name="related"></a>
92
Related Functions</h2></td></tr>
93
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1SeparatorToolItem.html">Gtk::SeparatorToolItem</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1SeparatorToolItem.html#a1a932571cbd914a68fd3dc75dc582829">wrap</a> (GtkSeparatorToolItem* object, bool take_copy=false)</td></tr>
95
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a1a932571cbd914a68fd3dc75dc582829"></a><br/></td></tr>
97
<hr/><a name="_details"></a><h2>Detailed Description</h2>
98
<div class="textblock"><p>A toolbar item that separates groups of other toolbar items. </p>
99
<p>A <a class="el" href="classGtk_1_1SeparatorToolItem.html" title="A toolbar item that separates groups of other toolbar items.">Gtk::SeparatorToolItem</a> is a <a class="el" href="classGtk_1_1ToolItem.html">Gtk::ToolItem</a> that separates groups of other Gtk::ToolItems. Depending on the theme, it will often look like a vertical line on horizontally docked toolbars. If the property "expand" is <code>true</code> and the property "draw" is <code>false</code>, a <a class="el" href="classGtk_1_1SeparatorToolItem.html" title="A toolbar item that separates groups of other toolbar items.">Gtk::SeparatorToolItem</a> will act as a "spring" that forces other items to the ends of the toolbar. </p>
100
</div><hr/><h2>Constructor & Destructor Documentation</h2>
101
<a class="anchor" id="a83cdeafb1e47ff62d741dc827bab2dc7"></a><!-- doxytag: member="Gtk::SeparatorToolItem::~SeparatorToolItem" ref="a83cdeafb1e47ff62d741dc827bab2dc7" args="()" -->
102
<div class="memitem">
103
<div class="memproto">
104
<table class="memname">
106
<td class="memname">virtual Gtk::SeparatorToolItem::~SeparatorToolItem </td>
108
<td class="paramname"></td><td>)</td>
109
<td><code> [virtual]</code></td>
117
<a class="anchor" id="aae94d511716e5c30272ac2ef971145d4"></a><!-- doxytag: member="Gtk::SeparatorToolItem::SeparatorToolItem" ref="aae94d511716e5c30272ac2ef971145d4" args="()" -->
118
<div class="memitem">
119
<div class="memproto">
120
<table class="memname">
122
<td class="memname">Gtk::SeparatorToolItem::SeparatorToolItem </td>
124
<td class="paramname"></td><td>)</td>
133
<hr/><h2>Member Function Documentation</h2>
134
<a class="anchor" id="ad2c43eff6973b44cf8f7900ae14c720b"></a><!-- doxytag: member="Gtk::SeparatorToolItem::get_draw" ref="ad2c43eff6973b44cf8f7900ae14c720b" args="() const " -->
135
<div class="memitem">
136
<div class="memproto">
137
<table class="memname">
139
<td class="memname">bool Gtk::SeparatorToolItem::get_draw </td>
141
<td class="paramname"></td><td>)</td>
148
<p>Returns whether <em>item</em> is drawn as a line, or just blank. </p>
149
<p>See <a class="el" href="classGtk_1_1SeparatorToolItem.html#ad00c20f3021f99fcd2e005d8e78cbca6" title="Whether item is drawn as a vertical line, or just blank.">set_draw()</a>.</p>
150
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000220">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
151
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>item</em> is drawn as a line, or just blank. </dd></dl>
155
<a class="anchor" id="aac14dc8f944446718d36d491409c839d"></a><!-- doxytag: member="Gtk::SeparatorToolItem::gobj" ref="aac14dc8f944446718d36d491409c839d" args="() const " -->
156
<div class="memitem">
157
<div class="memproto">
158
<table class="memname">
160
<td class="memname">const GtkSeparatorToolItem* Gtk::SeparatorToolItem::gobj </td>
162
<td class="paramname"></td><td>)</td>
163
<td> const<code> [inline]</code></td>
169
<p>Provides access to the underlying C GtkObject. </p>
171
<p>Reimplemented from <a class="el" href="classGtk_1_1ToolItem.html#a956e41fdb82ef7abc0651f26c57274dd">Gtk::ToolItem</a>.</p>
175
<a class="anchor" id="af88c8baefe7909b8544bda83705220ee"></a><!-- doxytag: member="Gtk::SeparatorToolItem::gobj" ref="af88c8baefe7909b8544bda83705220ee" args="()" -->
176
<div class="memitem">
177
<div class="memproto">
178
<table class="memname">
180
<td class="memname">GtkSeparatorToolItem* Gtk::SeparatorToolItem::gobj </td>
182
<td class="paramname"></td><td>)</td>
183
<td><code> [inline]</code></td>
189
<p>Provides access to the underlying C GtkObject. </p>
191
<p>Reimplemented from <a class="el" href="classGtk_1_1ToolItem.html#a14a91aa75fdf0d7377288f407f80ef79">Gtk::ToolItem</a>.</p>
195
<a class="anchor" id="a238e9720c26c28332b58b3f8665e7a7d"></a><!-- doxytag: member="Gtk::SeparatorToolItem::property_draw" ref="a238e9720c26c28332b58b3f8665e7a7d" args="() const " -->
196
<div class="memitem">
197
<div class="memproto">
198
<table class="memname">
200
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><bool> Gtk::SeparatorToolItem::property_draw </td>
202
<td class="paramname"></td><td>)</td>
209
<p>Whether the separator is drawn, or just blank. </p>
210
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
211
<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>
215
<a class="anchor" id="ae1622e79f2128bcd658768439ed4861b"></a><!-- doxytag: member="Gtk::SeparatorToolItem::property_draw" ref="ae1622e79f2128bcd658768439ed4861b" args="()" -->
216
<div class="memitem">
217
<div class="memproto">
218
<table class="memname">
220
<td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><bool> Gtk::SeparatorToolItem::property_draw </td>
222
<td class="paramname"></td><td>)</td>
229
<p>Whether the separator is drawn, or just blank. </p>
230
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
231
<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>
235
<a class="anchor" id="ad00c20f3021f99fcd2e005d8e78cbca6"></a><!-- doxytag: member="Gtk::SeparatorToolItem::set_draw" ref="ad00c20f3021f99fcd2e005d8e78cbca6" args="(bool draw=true)" -->
236
<div class="memitem">
237
<div class="memproto">
238
<table class="memname">
240
<td class="memname">void Gtk::SeparatorToolItem::set_draw </td>
242
<td class="paramtype">bool </td>
243
<td class="paramname"><em>draw</em> = <code>true</code></td><td>)</td>
250
<p>Whether <em>item</em> is drawn as a vertical line, or just blank. </p>
251
<p>Setting this to <code>false</code> along with <a class="el" href="classGtk_1_1ToolItem.html#a1c18c67797b1e635b0f8b7e55b2fdcea" title="Sets whether tool_item is allocated extra space when there is more room on the toolbar then needed fo...">Gtk::ToolItem::set_expand()</a> is useful to create an item that forces following items to the end of the toolbar.</p>
252
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000221">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
253
<dl><dt><b>Parameters:</b></dt><dd>
254
<table class="params">
255
<tr><td class="paramname">draw</td><td>Whether <em>item</em> is drawn as a vertical line. </td></tr>
262
<hr/><h2>Friends And Related Function Documentation</h2>
263
<a class="anchor" id="a1a932571cbd914a68fd3dc75dc582829"></a><!-- doxytag: member="Gtk::SeparatorToolItem::wrap" ref="a1a932571cbd914a68fd3dc75dc582829" args="(GtkSeparatorToolItem *object, bool take_copy=false)" -->
264
<div class="memitem">
265
<div class="memproto">
266
<table class="memname">
268
<td class="memname"><a class="el" href="classGtk_1_1SeparatorToolItem.html">Gtk::SeparatorToolItem</a>* wrap </td>
270
<td class="paramtype">GtkSeparatorToolItem * </td>
271
<td class="paramname"><em>object</em>, </td>
274
<td class="paramkey"></td>
276
<td class="paramtype">bool </td>
277
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
282
<td></td><td><code> [related]</code></td>
288
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
289
<dl><dt><b>Parameters:</b></dt><dd>
290
<table class="params">
291
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
292
<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>
296
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
300
<hr/>The documentation for this class was generated from the following file:<ul>
301
<li>gtkmm/separatortoolitem.h</li>
304
<hr class="footer"/><address class="footer"><small>Generated on Mon May 9 2011 10:20:10 for gtkmm by 
305
<a href="http://www.doxygen.org/index.html">
306
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>