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::Orientable 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_1Orientable.html">Orientable</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#related">Related Functions</a> </div>
52
<div class="headertitle">
53
<h1>Gtk::Orientable Class Reference</h1> </div>
55
<div class="contents">
56
<!-- doxytag: class="Gtk::Orientable" --><!-- doxytag: inherits="Glib::Interface" -->
57
<p>This interface is implemented by all widgets that can be oriented horizontally or vertically. <a href="#_details">More...</a></p>
58
<div class="dynheader">
59
Inheritance diagram for Gtk::Orientable:</div>
60
<div class="dyncontent">
61
<div class="center"><img src="classGtk_1_1Orientable__inherit__graph.png" border="0" usemap="#Gtk_1_1Orientable_inherit__map" alt="Inheritance graph"/></div>
62
<map name="Gtk_1_1Orientable_inherit__map" id="Gtk_1_1Orientable_inherit__map">
63
<area shape="rect" id="node9" href="classGtk_1_1ToolPalette.html" title="A ToolPalette allows you to add ToolItems to a palette-like container with various categories and dra..." alt="" coords="8,326,123,357"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,166,117,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>
64
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
65
<div class="dynheader">
66
Collaboration diagram for Gtk::Orientable:</div>
67
<div class="dyncontent">
68
<div class="center"><img src="classGtk_1_1Orientable__coll__graph.png" border="0" usemap="#Gtk_1_1Orientable_coll__map" alt="Collaboration graph"/></div>
69
<map name="Gtk_1_1Orientable_coll__map" id="Gtk_1_1Orientable_coll__map">
70
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,166,117,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>
71
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
73
<p><a href="classGtk_1_1Orientable-members.html">List of all members.</a></p>
74
<table class="memberdecls">
75
<tr><td colspan="2"><h2><a name="pub-methods"></a>
76
Public Member Functions</h2></td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#a40e3ba88fc7a3dba6a0596c7a8b6941b">~Orientable</a> ()</td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top">GtkOrientable* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#aff3a192c3b691efa1f4227b8e161843d">gobj</a> ()</td></tr>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aff3a192c3b691efa1f4227b8e161843d"></a><br/></td></tr>
80
<tr><td class="memItemLeft" align="right" valign="top">const GtkOrientable* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#affca54ff29e09edd51a6ce57dd93a9df">gobj</a> () const </td></tr>
81
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#affca54ff29e09edd51a6ce57dd93a9df"></a><br/></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#ad6ab22a97e3811deda0dbc1b16571162">set_orientation</a> (<a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> orientation)</td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the orientation of the <em>orientable</em>. <a href="#ad6ab22a97e3811deda0dbc1b16571162"></a><br/></td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#abac8cc298a1791471540f150b7ffac2e">get_orientation</a> () const </td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the orientation of the <em>orientable</em>. <a href="#abac8cc298a1791471540f150b7ffac2e"></a><br/></td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< <a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#afbb6a6f628d0d12749c6fdc44438dadb">property_orientation</a> ()</td></tr>
87
<tr><td class="mdescLeft"> </td><td class="mdescRight">The orientation of the orientable. <a href="#afbb6a6f628d0d12749c6fdc44438dadb"></a><br/></td></tr>
88
<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"/>
89
< <a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#a37aaf900c481e32b335b804a1b86e38a">property_orientation</a> () const </td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">The orientation of the orientable. <a href="#a37aaf900c481e32b335b804a1b86e38a"></a><br/></td></tr>
91
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
92
Static Public Member Functions</h2></td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#a8d719ce4ff64f64600625afef8c6f288">add_interface</a> (GType gtype_implementer)</td></tr>
94
<tr><td colspan="2"><h2><a name="related"></a>
95
Related Functions</h2></td></tr>
96
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
97
<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_1Orientable.html">Gtk::Orientable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Orientable.html#a5da33d954352cfdb3a3455cdc51cb79b">wrap</a> (GtkOrientable* object, bool take_copy=false)</td></tr>
98
<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="#a5da33d954352cfdb3a3455cdc51cb79b"></a><br/></td></tr>
100
<hr/><a name="_details"></a><h2>Detailed Description</h2>
101
<div class="textblock"><p>This interface is implemented by all widgets that can be oriented horizontally or vertically. </p>
102
<p>Historically, such widgets have been realized as subclasses of a common base class (e.g GtkBox/GtkHBox/GtkVBox and GtkScale/GtkHScale/GtkVScale). GtkOrientable is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets to 'flip'.</p>
103
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000078">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
104
</div><hr/><h2>Constructor & Destructor Documentation</h2>
105
<a class="anchor" id="a40e3ba88fc7a3dba6a0596c7a8b6941b"></a><!-- doxytag: member="Gtk::Orientable::~Orientable" ref="a40e3ba88fc7a3dba6a0596c7a8b6941b" args="()" -->
106
<div class="memitem">
107
<div class="memproto">
108
<table class="memname">
110
<td class="memname">virtual Gtk::Orientable::~Orientable </td>
112
<td class="paramname"></td><td>)</td>
113
<td><code> [virtual]</code></td>
121
<hr/><h2>Member Function Documentation</h2>
122
<a class="anchor" id="a8d719ce4ff64f64600625afef8c6f288"></a><!-- doxytag: member="Gtk::Orientable::add_interface" ref="a8d719ce4ff64f64600625afef8c6f288" args="(GType gtype_implementer)" -->
123
<div class="memitem">
124
<div class="memproto">
125
<table class="memname">
127
<td class="memname">static void Gtk::Orientable::add_interface </td>
129
<td class="paramtype">GType </td>
130
<td class="paramname"><em>gtype_implementer</em></td><td>)</td>
131
<td><code> [static]</code></td>
139
<a class="anchor" id="abac8cc298a1791471540f150b7ffac2e"></a><!-- doxytag: member="Gtk::Orientable::get_orientation" ref="abac8cc298a1791471540f150b7ffac2e" args="() const " -->
140
<div class="memitem">
141
<div class="memproto">
142
<table class="memname">
144
<td class="memname"><a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> Gtk::Orientable::get_orientation </td>
146
<td class="paramname"></td><td>)</td>
153
<p>Retrieves the orientation of the <em>orientable</em>. </p>
154
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000080">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
155
<dl class="return"><dt><b>Returns:</b></dt><dd>The orientation of the <em>orientable</em>. </dd></dl>
159
<a class="anchor" id="aff3a192c3b691efa1f4227b8e161843d"></a><!-- doxytag: member="Gtk::Orientable::gobj" ref="aff3a192c3b691efa1f4227b8e161843d" args="()" -->
160
<div class="memitem">
161
<div class="memproto">
162
<table class="memname">
164
<td class="memname">GtkOrientable* Gtk::Orientable::gobj </td>
166
<td class="paramname"></td><td>)</td>
167
<td><code> [inline]</code></td>
173
<p>Provides access to the underlying C GObject. </p>
175
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>
177
<p>Reimplemented in <a class="el" href="classGtk_1_1ToolPalette.html#a91e81467b7ae18f9f13e2cf80bd437b7">Gtk::ToolPalette</a>.</p>
181
<a class="anchor" id="affca54ff29e09edd51a6ce57dd93a9df"></a><!-- doxytag: member="Gtk::Orientable::gobj" ref="affca54ff29e09edd51a6ce57dd93a9df" args="() const " -->
182
<div class="memitem">
183
<div class="memproto">
184
<table class="memname">
186
<td class="memname">const GtkOrientable* Gtk::Orientable::gobj </td>
188
<td class="paramname"></td><td>)</td>
189
<td> const<code> [inline]</code></td>
195
<p>Provides access to the underlying C GObject. </p>
197
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>
199
<p>Reimplemented in <a class="el" href="classGtk_1_1ToolPalette.html#a2dcd227b3f91f500d6493e56039a91ba">Gtk::ToolPalette</a>.</p>
203
<a class="anchor" id="afbb6a6f628d0d12749c6fdc44438dadb"></a><!-- doxytag: member="Gtk::Orientable::property_orientation" ref="afbb6a6f628d0d12749c6fdc44438dadb" args="()" -->
204
<div class="memitem">
205
<div class="memproto">
206
<table class="memname">
208
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><<a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a>> Gtk::Orientable::property_orientation </td>
210
<td class="paramname"></td><td>)</td>
217
<p>The orientation of the orientable. </p>
218
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
219
<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>
223
<a class="anchor" id="a37aaf900c481e32b335b804a1b86e38a"></a><!-- doxytag: member="Gtk::Orientable::property_orientation" ref="a37aaf900c481e32b335b804a1b86e38a" args="() const " -->
224
<div class="memitem">
225
<div class="memproto">
226
<table class="memname">
228
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a>> Gtk::Orientable::property_orientation </td>
230
<td class="paramname"></td><td>)</td>
237
<p>The orientation of the orientable. </p>
238
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
239
<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>
243
<a class="anchor" id="ad6ab22a97e3811deda0dbc1b16571162"></a><!-- doxytag: member="Gtk::Orientable::set_orientation" ref="ad6ab22a97e3811deda0dbc1b16571162" args="(Orientation orientation)" -->
244
<div class="memitem">
245
<div class="memproto">
246
<table class="memname">
248
<td class="memname">void Gtk::Orientable::set_orientation </td>
250
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga84179a467b0ed4f61b4e325eb09b0b1c">Orientation</a> </td>
251
<td class="paramname"><em>orientation</em></td><td>)</td>
258
<p>Sets the orientation of the <em>orientable</em>. </p>
259
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000079">Since gtkmm 2.16:</a></b></dt><dd></dd></dl>
260
<dl><dt><b>Parameters:</b></dt><dd>
261
<table class="params">
262
<tr><td class="paramname">orientation</td><td>The orientable's new orientation. </td></tr>
269
<hr/><h2>Friends And Related Function Documentation</h2>
270
<a class="anchor" id="a5da33d954352cfdb3a3455cdc51cb79b"></a><!-- doxytag: member="Gtk::Orientable::wrap" ref="a5da33d954352cfdb3a3455cdc51cb79b" args="(GtkOrientable *object, bool take_copy=false)" -->
271
<div class="memitem">
272
<div class="memproto">
273
<table class="memname">
275
<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_1Orientable.html">Gtk::Orientable</a> > wrap </td>
277
<td class="paramtype">GtkOrientable * </td>
278
<td class="paramname"><em>object</em>, </td>
281
<td class="paramkey"></td>
283
<td class="paramtype">bool </td>
284
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
289
<td></td><td><code> [related]</code></td>
295
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
296
<dl><dt><b>Parameters:</b></dt><dd>
297
<table class="params">
298
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
299
<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>
303
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
307
<hr/>The documentation for this class was generated from the following file:<ul>
308
<li>gtkmm/orientable.h</li>
311
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:46 for gtkmm by 
312
<a href="http://www.doxygen.org/index.html">
313
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>