<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Wt: Wt::Ext::Splitter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Wt  <span id="projectnumber">3.2.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <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> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li> <li class="navelem"><a class="el" href="namespaceWt_1_1Ext.html">Ext</a> </li> <li class="navelem"><a class="el" href="classWt_1_1Ext_1_1Splitter.html">Splitter</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Wt::Ext::Splitter Class Reference<div class="ingroups"><a class="el" href="group__ext.html">Ext widgets (Wt::Ext, deprecated)</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Wt::Ext::Splitter" --><!-- doxytag: inherits="Wt::WContainerWidget" --> <p>A container widget with resize handles between its children. <a href="classWt_1_1Ext_1_1Splitter.html#details">More...</a></p> <p><code>#include <Wt/Ext/Splitter></code></p> <div class="dynheader"> Inheritance diagram for Wt::Ext::Splitter:</div> <div class="dyncontent"> <div class="center"><img src="classWt_1_1Ext_1_1Splitter__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1Splitter_inherit__map" alt="Inheritance graph"/></div> <map name="Wt_1_1Ext_1_1Splitter_inherit__map" id="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,160,331"/><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="11,229,155,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="19,155,147,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="33,80,132,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="35,5,131,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classWt_1_1Ext_1_1Splitter-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a535dfe78024536478b2372a3e9680172"></a><!-- doxytag: member="Wt::Ext::Splitter::Splitter" ref="a535dfe78024536478b2372a3e9680172" args="(WContainerWidget *parent=0)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a535dfe78024536478b2372a3e9680172">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" align="right" valign="top"><a class="anchor" id="a982eb1ec72d98f3c7a1dd1d50b5806c7"></a><!-- doxytag: member="Wt::Ext::Splitter::Splitter" ref="a982eb1ec72d98f3c7a1dd1d50b5806c7" args="(Orientation orientation, WContainerWidget *parent=0)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a982eb1ec72d98f3c7a1dd1d50b5806c7">Splitter</a> (<a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">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" align="right" valign="top"><a class="anchor" id="ab2ac583c831b2b4d96d8c47cd59dc051"></a><!-- doxytag: member="Wt::Ext::Splitter::setOrientation" ref="ab2ac583c831b2b4d96d8c47cd59dc051" args="(Orientation orientation)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ab2ac583c831b2b4d96d8c47cd59dc051">setOrientation</a> (<a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> orientation)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the orientation. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67e40b48d24dc405ec9873700b8e73ce"></a><!-- doxytag: member="Wt::Ext::Splitter::orientation" ref="a67e40b48d24dc405ec9873700b8e73ce" args="() const " --> <a class="el" href="namespaceWt.html#a2a8d45559e16a0185bf61bfad0a67912">Orientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a67e40b48d24dc405ec9873700b8e73ce">orientation</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the orientation. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad253324efbe507459f1b9753e299e870">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="#ad253324efbe507459f1b9753e299e870"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad15e9a76781f6b9b0f6842d79473310b">handleWidth</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the width of the resize handles. <a href="#ad15e9a76781f6b9b0f6842d79473310b"></a><br/></td></tr> <tr><td class="memItemLeft" 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#a9a1963027cc762d7a6565311ddb74ed1">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="#a9a1963027cc762d7a6565311ddb74ed1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a3f776ab5a6c84ebfa1d4896b475fec7a">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="#a3f776ab5a6c84ebfa1d4896b475fec7a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a4495c1d701edd2181dbc1bf071442363">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="#a4495c1d701edd2181dbc1bf071442363"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad156963c4ad3d725e0d8b4bd2969b2f7">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="#ad156963c4ad3d725e0d8b4bd2969b2f7"></a><br/></td></tr> <tr><td class="memItemLeft" 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#a88f67b1fa84e213c5e527beff8ed6225">children</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns contained widgets. <a href="#a88f67b1fa84e213c5e527beff8ed6225"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A container widget with resize handles between its children. </p> <p>Provides a container in which widgets are laid out either horizontally (side by side, Horizontal orientation), or vertically (Vertical orientation).</p> <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> <p class="startli">They MUST have their width (or height) set using <a class="el" href="classWt_1_1WWidget.html#a5bebad8f1582b8bebf01a9ed0ee11972" title="Resizes the widget.">WWidget::resize()</a>, in <a class="el" href="classWt_1_1WLength.html#a908caf5d6be7e244e24598e6d22cd4c0a0b1fa4c1bd7adb92e1a04d62b96d30ba" title="Pixel, relative to canvas resolution.">WLength::Pixel</a> units. You cannot specify the size through CSS!</p> <p class="endli"></p> </li> <li> <p class="startli">Optionally, the may have a minimum width (or minimum height) set using <a class="el" href="classWt_1_1WWidget.html#a092c7d1ecfde7f004ef120389d91775d" title="Sets a minimum size.">WWidget::setMinimumSize()</a> and <a class="el" href="classWt_1_1WWidget.html#af023064cf8007bda6baeb5277d79bbd9" title="Sets a maximum size.">WWidget::setMaximumSize()</a>. Again, you cannot specify these properties through CSS!</p> <p class="endli"></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> </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a3f776ab5a6c84ebfa1d4896b475fec7a"></a><!-- doxytag: member="Wt::Ext::Splitter::addWidget" ref="a3f776ab5a6c84ebfa1d4896b475fec7a" 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> <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> <p>Reimplemented from <a class="el" href="classWt_1_1WContainerWidget.html#a2cfe66d9b62940f889e99538a9f478d2">Wt::WContainerWidget</a>.</p> </div> </div> <a class="anchor" id="a88f67b1fa84e213c5e527beff8ed6225"></a><!-- doxytag: member="Wt::Ext::Splitter::children" ref="a88f67b1fa84e213c5e527beff8ed6225" 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</td> </tr> </table> </div> <div class="memdoc"> <p>Returns contained widgets. </p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WContainerWidget.html#a2cfe66d9b62940f889e99538a9f478d2" title="Adds a child widget to this container.">WContainerWidget::addWidget()</a> </dd></dl> <p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#a72c4cd4ce0a6ed1ff2d7b6ddf2dbd917">Wt::WWebWidget</a>.</p> </div> </div> <a class="anchor" id="a9a1963027cc762d7a6565311ddb74ed1"></a><!-- doxytag: member="Wt::Ext::Splitter::handle" ref="a9a1963027cc762d7a6565311ddb74ed1" 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> <p>There is no handle to the left of the widget at index 0, and 0 will be returned. </p> </div> </div> <a class="anchor" id="ad15e9a76781f6b9b0f6842d79473310b"></a><!-- doxytag: member="Wt::Ext::Splitter::handleWidth" ref="ad15e9a76781f6b9b0f6842d79473310b" 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</td> </tr> </table> </div> <div class="memdoc"> <p>Return the width of the resize handles. </p> <p>The default width is 4 pixels.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad253324efbe507459f1b9753e299e870" title="Set the width of the resize handles (in pixels).">setHandleWidth()</a> </dd></dl> </div> </div> <a class="anchor" id="ad156963c4ad3d725e0d8b4bd2969b2f7"></a><!-- doxytag: member="Wt::Ext::Splitter::insertBefore" ref="ad156963c4ad3d725e0d8b4bd2969b2f7" 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> </tr> <tr> <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> <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"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#a4495c1d701edd2181dbc1bf071442363" 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#a1439877a32c4b082f312fee81d139665">Wt::WContainerWidget</a>.</p> </div> </div> <a class="anchor" id="a4495c1d701edd2181dbc1bf071442363"></a><!-- doxytag: member="Wt::Ext::Splitter::insertWidget" ref="a4495c1d701edd2181dbc1bf071442363" 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> </tr> <tr> <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> <p>The <em>widget</em> is inserted at the given <code>index</code>, and subsequent widgets are shifted.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad156963c4ad3d725e0d8b4bd2969b2f7" 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#a15ffcecaf10e6f04ec5667d2b3f0d919">Wt::WContainerWidget</a>.</p> </div> </div> <a class="anchor" id="ad253324efbe507459f1b9753e299e870"></a><!-- doxytag: member="Wt::Ext::Splitter::setHandleWidth" ref="ad253324efbe507459f1b9753e299e870" 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> <p>The default width is 4 pixels.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Splitter.html#ad15e9a76781f6b9b0f6842d79473310b" title="Return the width of the resize handles.">handleWidth()</a> </dd></dl> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr size="1"><address style="text-align: right; margin: 3px"><small> Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the C++ Web Toolkit (Wt)</a> by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" border="0" style="vertical-align: middle; display: inline-block; height: 2em"></a> 1.7.5.1</small></address> </body> </html>