1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::Ext::Splitter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="namespaceWt_1_1Ext.html">Ext</a>::<a class="el" href="classWt_1_1Ext_1_1Splitter.html">Splitter</a>
</div>
</div>
<div class="contents">
<h1>Wt::Ext::Splitter Class Reference<br>
<small>
[<a class="el" href="group__ext.html">Ext widgets</a>]</small>
</h1><!-- doxytag: class="Wt::Ext::Splitter" --><!-- doxytag: inherits="Wt::WContainerWidget" -->A container widget with resize handles between its children.
<a href="#_details">More...</a>
<p>
<code>#include <Wt/Ext/Splitter></code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::Ext::Splitter:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1Ext_1_1Splitter__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1Splitter__inherit__map" alt="Inheritance graph"></center>
<map name="Wt_1_1Ext_1_1Splitter__inherit__map">
<area shape="rect" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets." alt="" coords="5,304,157,331"><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="11,229,152,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="20,155,143,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="33,80,129,107"><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="33,5,129,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classWt_1_1Ext_1_1Splitter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="535dfe78024536478b2372a3e9680172"></a><!-- doxytag: member="Wt::Ext::Splitter::Splitter" ref="535dfe78024536478b2372a3e9680172" args="(WContainerWidget *parent=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#535dfe78024536478b2372a3e9680172">Splitter</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new horizontal splitter. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="982eb1ec72d98f3c7a1dd1d50b5806c7"></a><!-- doxytag: member="Wt::Ext::Splitter::Splitter" ref="982eb1ec72d98f3c7a1dd1d50b5806c7" args="(Orientation orientation, WContainerWidget *parent=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#982eb1ec72d98f3c7a1dd1d50b5806c7">Splitter</a> (<a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new splitter with the given orientation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2ac583c831b2b4d96d8c47cd59dc051"></a><!-- doxytag: member="Wt::Ext::Splitter::setOrientation" ref="b2ac583c831b2b4d96d8c47cd59dc051" args="(Orientation orientation)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#b2ac583c831b2b4d96d8c47cd59dc051">setOrientation</a> (<a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the orientation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67e40b48d24dc405ec9873700b8e73ce"></a><!-- doxytag: member="Wt::Ext::Splitter::orientation" ref="67e40b48d24dc405ec9873700b8e73ce" args="() const " -->
<a class="el" href="namespaceWt.html#2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#67e40b48d24dc405ec9873700b8e73ce">orientation</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the orientation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d253324efbe507459f1b9753e299e870">setHandleWidth</a> (int width)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the width of the resize handles (in pixels). <a href="#d253324efbe507459f1b9753e299e870"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d15e9a76781f6b9b0f6842d79473310b">handleWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the width of the resize handles. <a href="#d15e9a76781f6b9b0f6842d79473310b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1Ext_1_1SplitterHandle.html">SplitterHandle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#9a1963027cc762d7a6565311ddb74ed1">handle</a> (int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the handle to the left (or above) the widget at the given <em>index</em>. <a href="#9a1963027cc762d7a6565311ddb74ed1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#3f776ab5a6c84ebfa1d4896b475fec7a">addWidget</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a child widget to this container. <a href="#3f776ab5a6c84ebfa1d4896b475fec7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#4495c1d701edd2181dbc1bf071442363">insertWidget</a> (int index, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts a child widget in this container at given index. <a href="#4495c1d701edd2181dbc1bf071442363"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d156963c4ad3d725e0d8b4bd2969b2f7">insertBefore</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *widget, <a class="el" href="classWt_1_1WWidget.html">WWidget</a> *before)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts a child widget in this container, before another widget. <a href="#d156963c4ad3d725e0d8b4bd2969b2f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::vector< <a class="el" href="classWt_1_1WWidget.html">WWidget</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#88f67b1fa84e213c5e527beff8ed6225">children</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns contained widgets. <a href="#88f67b1fa84e213c5e527beff8ed6225"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A container widget with resize handles between its children.
<p>
Provides a container in which widgets are laid out either horizontally (side by side, Horizontal orientation), or vertically (Vertical orientation).<p>
Widgets are separated by a <a class="el" href="classWt_1_1Ext_1_1SplitterHandle.html" title="A handle inside a splitter.">SplitterHandle</a> which the user may use to resize widgets. For this to work properly, you need to properly specify widths, and minimum- and maximum widths for the widgets:<p>
<ul>
<li>
They MUST have their width (or height) set using <a class="el" href="classWt_1_1WWidget.html#5bebad8f1582b8bebf01a9ed0ee11972" title="Resizes the widget.">WWidget::resize()</a>, in <a class="el" href="classWt_1_1WLength.html#908caf5d6be7e244e24598e6d22cd4c00b1fa4c1bd7adb92e1a04d62b96d30ba" title="Pixel, relative to canvas resolution.">WLength::Pixel</a> units. You cannot specify the size through CSS!<p>
</li>
<li>
Optionally, the may have a minimum width (or minimum height) set using <a class="el" href="classWt_1_1WWidget.html#092c7d1ecfde7f004ef120389d91775d" title="Sets a minimum size.">WWidget::setMinimumSize()</a> and <a class="el" href="classWt_1_1WWidget.html#f023064cf8007bda6baeb5277d79bbd9" title="Sets a maximum size.">WWidget::setMaximumSize()</a>. Again, you cannot specify these properties through CSS!<p>
</li>
<li>
Probably you will want to insert each widget in a <a class="el" href="classWt_1_1WScrollArea.html" title="A widget that adds scrolling capabilities to its content.">WScrollArea</a>, or set the CSS overflow attribute to hidden (which clips anything that goes outside) or auto (to add scroll bars). </li>
</ul>
<p>
<em>Note: removing or adding widgets after initial render is not yet supported.</em> <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d253324efbe507459f1b9753e299e870"></a><!-- doxytag: member="Wt::Ext::Splitter::setHandleWidth" ref="d253324efbe507459f1b9753e299e870" args="(int width)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::Splitter::setHandleWidth </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>width</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the width of the resize handles (in pixels).
<p>
The default width is 4 pixels.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d15e9a76781f6b9b0f6842d79473310b" title="Return the width of the resize handles.">handleWidth()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d15e9a76781f6b9b0f6842d79473310b"></a><!-- doxytag: member="Wt::Ext::Splitter::handleWidth" ref="d15e9a76781f6b9b0f6842d79473310b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::Ext::Splitter::handleWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the width of the resize handles.
<p>
The default width is 4 pixels.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d253324efbe507459f1b9753e299e870" title="Set the width of the resize handles (in pixels).">setHandleWidth()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="9a1963027cc762d7a6565311ddb74ed1"></a><!-- doxytag: member="Wt::Ext::Splitter::handle" ref="9a1963027cc762d7a6565311ddb74ed1" args="(int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Ext_1_1SplitterHandle.html">SplitterHandle</a> * Wt::Ext::Splitter::handle </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the handle to the left (or above) the widget at the given <em>index</em>.
<p>
There is no handle to the left of the widget at index 0, and 0 will be returned.
</div>
</div><p>
<a class="anchor" name="3f776ab5a6c84ebfa1d4896b475fec7a"></a><!-- doxytag: member="Wt::Ext::Splitter::addWidget" ref="3f776ab5a6c84ebfa1d4896b475fec7a" args="(WWidget *widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::Splitter::addWidget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"> <em>widget</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a child widget to this container.
<p>
This is equivalent to passing this container as the parent when constructing the child. The widget is appended to the list of children, and thus also layed-out at the end.
<p>Reimplemented from <a class="el" href="classWt_1_1WContainerWidget.html#2cfe66d9b62940f889e99538a9f478d2">Wt::WContainerWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="4495c1d701edd2181dbc1bf071442363"></a><!-- doxytag: member="Wt::Ext::Splitter::insertWidget" ref="4495c1d701edd2181dbc1bf071442363" args="(int index, WWidget *widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::Splitter::insertWidget </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"> <em>widget</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Inserts a child widget in this container at given index.
<p>
The <em>widget</em> is inserted at the given <code>index</code>, and subsequent widgets are shifted.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#d156963c4ad3d725e0d8b4bd2969b2f7" title="Inserts a child widget in this container, before another widget.">insertBefore(WWidget *widget, WWidget *before)</a>; </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WContainerWidget.html#15ffcecaf10e6f04ec5667d2b3f0d919">Wt::WContainerWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="d156963c4ad3d725e0d8b4bd2969b2f7"></a><!-- doxytag: member="Wt::Ext::Splitter::insertBefore" ref="d156963c4ad3d725e0d8b4bd2969b2f7" args="(WWidget *widget, WWidget *before)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::Splitter::insertBefore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"> <em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"> <em>before</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Inserts a child widget in this container, before another widget.
<p>
The <em>widget</em> is inserted at the place of the <code>before</code> widget, and subsequent widgets are shifted.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#4495c1d701edd2181dbc1bf071442363" title="Inserts a child widget in this container at given index.">insertWidget(int index, WWidget *widget)</a>; </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WContainerWidget.html#1439877a32c4b082f312fee81d139665">Wt::WContainerWidget</a>.</p>
</div>
</div><p>
<a class="anchor" name="88f67b1fa84e213c5e527beff8ed6225"></a><!-- doxytag: member="Wt::Ext::Splitter::children" ref="88f67b1fa84e213c5e527beff8ed6225" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector<<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *>& Wt::Ext::Splitter::children </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns contained widgets.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WContainerWidget.html#2cfe66d9b62940f889e99538a9f478d2" title="Adds a child widget to this container.">WContainerWidget::addWidget()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#6f32718bcdfa546f012c795f80f319e3">Wt::WWebWidget</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:08 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>
|