<!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::WObject 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="classWt_1_1WObject.html">WObject</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WObject Class Reference<div class="ingroups"><a class="el" href="group__signalslot.html">Signal/slot system</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WObject" -->
<p>A base class for objects that participate in the signal/slot system.
<a href="classWt_1_1WObject.html#details">More...</a></p>
<p><code>#include <Wt/WObject></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WObject:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WObject__inherit__graph.png" border="0" usemap="#Wt_1_1WObject_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WObject_inherit__map" id="Wt_1_1WObject_inherit__map">
<area shape="rect" href="classWt_1_1WSignalMapper.html" title="Wt::WSignalMapper\< Coordinate, NoClass \>" alt="" coords="179,5,459,32"/><area shape="rect" href="classWt_1_1WSignalMapper.html" title="Wt::WSignalMapper\< int \>" alt="" coords="231,56,407,83"/><area shape="rect" href="classWt_1_1WSignalMapper.html" title="Wt::WSignalMapper\< StandardButton, NoClass \>" alt="" coords="164,107,473,133"/><area shape="rect" href="classWt_1_1WSignalMapper.html" title="Wt::WSignalMapper\< WModelIndex, WMouseEvent \>" alt="" coords="152,157,485,184"/><area shape="rect" href="classWt_1_1Auth_1_1Login.html" title="A class that manages the current login state." alt="" coords="263,208,375,235"/><area shape="rect" href="classWt_1_1Auth_1_1OAuthProcess.html" title="An OAuth authorization (and authentication) process." alt="" coords="236,259,401,285"/><area shape="rect" href="classWt_1_1Ext_1_1ToolTipConfig.html" title="A configuration object for tool tips." alt="" coords="244,309,393,336"/><area shape="rect" href="classWt_1_1Http_1_1Client.html" title="An HTTP client." alt="" coords="263,360,375,387"/><area shape="rect" href="classWt_1_1Payment_1_1PayPalExpressCheckout.html" title="A paypal express checkout process." alt="" coords="193,411,444,437"/><area shape="rect" href="classWt_1_1WAbstractArea.html" title="Abstract base class for interactive areas in a widget." alt="" coords="251,461,387,488"/><area shape="rect" href="classWt_1_1WAbstractItemDelegate.html" title="Abstract delegate class for rendering an item in an item view." alt="" coords="227,512,411,539"/><area shape="rect" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt's view classes." alt="" coords="235,563,403,589"/><area shape="rect" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session." alt="" coords="257,613,380,640"/><area shape="rect" href="classWt_1_1WButtonGroup.html" title="A class for grouping radio buttons logically together." alt="" coords="253,664,384,691"/><area shape="rect" href="classWt_1_1WCanvasPaintDevice.html" title="A paint device for rendering using the HTML 5 <canvas> element." alt="" coords="235,715,403,741"/><area shape="rect" href="classWt_1_1WCssRule.html" title="Abstract rule in a CSS style sheet." alt="" coords="265,765,372,792"/><area shape="rect" href="classWt_1_1WFormModel.html" title="A basic model class for forms." alt="" coords="257,816,380,843"/><area shape="rect" href="classWt_1_1WItemSelectionModel.html" title="A class that represents a selection for a WAbstractItemView." alt="" coords="232,867,405,893"/><area shape="rect" href="classWt_1_1WLayout.html" title="An abstract base class for layout managers." alt="" coords="269,917,368,944"/><area shape="rect" href="classWt_1_1WMenuItem.html" title="A single item in a menu." alt="" coords="261,968,376,995"/><area shape="rect" href="classWt_1_1WResource.html" title="An object which can be rendered in the HTTP protocol." alt="" coords="261,1019,376,1045"/><area shape="rect" href="classWt_1_1WScrollBar.html" title="A scrollbar attached to a scroll area." alt="" coords="263,1069,375,1096"/><area shape="rect" href="classWt_1_1WSignalMapper.html" title="A utility class to connect multiple senders to a single slot." alt="" coords="223,1120,415,1147"/><area shape="rect" href="classWt_1_1WSocketNotifier.html" title="A utility class for asynchronous notification of socket activity." alt="" coords="249,1171,388,1197"/><area shape="rect" href="classWt_1_1WSound.html" title="A value class to play a sound effect." alt="" coords="271,1221,367,1248"/><area shape="rect" href="classWt_1_1WTableColumn.html" title="A table column." alt="" coords="252,1272,385,1299"/><area shape="rect" href="classWt_1_1WTableRow.html" title="A table row." alt="" coords="261,1323,376,1349"/><area shape="rect" href="classWt_1_1WTimer.html" title="A utility class which provides timer signals and single-shot timers." alt="" coords="273,1373,364,1400"/><area shape="rect" href="classWt_1_1WValidator.html" title="A validator is used to validate user input according to pre-defined rules." alt="" coords="264,1424,373,1451"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="269,1475,368,1501"/><area shape="rect" href="classWt_1_1WCircleArea.html" title="A interactive area in a widget, specified by a circle." alt="" coords="563,309,683,336"/><area shape="rect" href="classWt_1_1WPolygonArea.html" title="An interactive area in a widget, specified by a polygon." alt="" coords="556,360,689,387"/><area shape="rect" href="classWt_1_1WRectArea.html" title="A interactive area in a widget, specified by a rectangle." alt="" coords="567,411,679,437"/><area shape="rect" href="classWt_1_1WItemDelegate.html" title="Standard delegate class for rendering a view item." alt="" coords="555,461,691,488"/><area shape="rect" href="classWt_1_1WAbstractListModel.html" title="An abstract list model for use with Wt's view classes." alt="" coords="541,512,704,539"/><area shape="rect" href="classWt_1_1WAbstractProxyModel.html" title="An abstract proxy model for Wt's item models." alt="" coords="535,563,711,589"/><area shape="rect" href="classWt_1_1WAbstractTableModel.html" title="An abstract table model for use with Wt's view classes." alt="" coords="536,613,709,640"/><area shape="rect" href="classWt_1_1WStandardItemModel.html" title="A standard data model, which stores its data in memory." alt="" coords="537,664,708,691"/><area shape="rect" href="classWt_1_1WCssTemplateRule.html" title="A CSS rule based on a template widget." alt="" coords="543,715,703,741"/><area shape="rect" href="classWt_1_1WCssTextRule.html" title="A CSS rule specified directly using CSS declarations." alt="" coords="557,765,688,792"/><area shape="rect" href="classWt_1_1Auth_1_1FormBaseModel.html" title="A base model class for authentication-related forms." alt="" coords="535,816,711,843"/><area shape="rect" href="classWt_1_1WBorderLayout.html" title="A layout manager which divides the container region in five regions." alt="" coords="555,867,691,893"/><area shape="rect" href="classWt_1_1WBoxLayout.html" title="A layout manager which arranges widgets horizontally or vertically." alt="" coords="563,917,683,944"/><area shape="rect" href="classWt_1_1WDefaultLayout.html" title="A default layout manager." alt="" coords="553,968,692,995"/><area shape="rect" href="classWt_1_1WFitLayout.html" title="A layout manager which spans a single widget to all available space." alt="" coords="567,1019,679,1045"/><area shape="rect" href="classWt_1_1WGridLayout.html" title="A layout manager which arranges widgets in a grid." alt="" coords="561,1069,684,1096"/><area shape="rect" href="classWt_1_1WSubMenuItem.html" title="A menu item that contains a nested sub menu." alt="" coords="553,1120,692,1147"/><area shape="rect" href="classWt_1_1Ext_1_1DataStore.html" title="A resource that serializes data from a data model." alt="" coords="557,1171,688,1197"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WObject-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ef714d6ef0060b78c039e729b913aa9"></a><!-- doxytag: member="Wt::WObject::Method" ref="a6ef714d6ef0060b78c039e729b913aa9" args=")()" -->
typedef void(WObject::* </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a6ef714d6ef0060b78c039e729b913aa9">Method</a> )()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Typedef for a WObject method without arguments. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a1da12f5d82488adcca912c596b9398ea">WObject</a> (<a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a WObject with a given parent object. <a href="#a1da12f5d82488adcca912c596b9398ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a45d6c07b134db69687bd1b49025799c3">~WObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a45d6c07b134db69687bd1b49025799c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a5c5cc1d7aada99baf97d0dc203e42154">id</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the (unique) identifier for this object. <a href="#a5c5cc1d7aada99baf97d0dc203e42154"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a64ce31cadb378c4eba81224f43bf493d">setObjectName</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an object name. <a href="#a64ce31cadb378c4eba81224f43bf493d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a5cad0cc3f73402de1422747653ece18f">objectName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the object name. <a href="#a5cad0cc3f73402de1422747653ece18f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a92d8b00edc79b7a60d41d7c088f50436">resetLearnedSlots</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets learned stateless slot implementations. <a href="#a92d8b00edc79b7a60d41d7c088f50436"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a5c7dcd5a60c88e5b36f0c8e0f9117698">resetLearnedSlot</a> (void(T::*method)())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets a learned stateless slot implementation. <a href="#a5c7dcd5a60c88e5b36f0c8e0f9117698"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">WStatelessSlot * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6">implementStateless</a> (void(T::*method)())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Declares a slot to be stateless and learn client-side behaviour on first invocation. <a href="#adaa163b9e92933f3b2ff4ec58e2734c6"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">WStatelessSlot * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a7bf46fd1437f07150a9dd95bd95c266d">implementStateless</a> (void(T::*method)(), void(T::*undoMethod)())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Declares a slot to be stateless and learn client-side behaviour in advance. <a href="#a7bf46fd1437f07150a9dd95bd95c266d"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">WStatelessSlot * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a214deee5d7324b9afd4ce44534daa782">implementJavaScript</a> (void(T::*method)(), const std::string &jsCode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides a JavaScript implementation for a method. <a href="#a214deee5d7324b9afd4ce44534daa782"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a945f972be4331bfe46221263e04ae9ed">addChild</a> (<a class="el" href="classWt_1_1WObject.html">WObject</a> *child)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a child object. <a href="#a945f972be4331bfe46221263e04ae9ed"></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_1WObject.html#a1f811eeb5f0aa37b5b1931497cd9f163">removeChild</a> (<a class="el" href="classWt_1_1WObject.html">WObject</a> *child)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a child object. <a href="#a1f811eeb5f0aa37b5b1931497cd9f163"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66c8da3f967545ceb585ed574f68b8cf"></a><!-- doxytag: member="Wt::WObject::children" ref="a66c8da3f967545ceb585ed574f68b8cf" args="() const " -->
const std::vector< <a class="el" href="classWt_1_1WObject.html">WObject</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a66c8da3f967545ceb585ed574f68b8cf">children</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the children. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2af8f7ec8d3807d434e1f70d1245c6b4"></a><!-- doxytag: member="Wt::WObject::parent" ref="a2af8f7ec8d3807d434e1f70d1245c6b4" args="() const " -->
<a class="el" href="classWt_1_1WObject.html">WObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a2af8f7ec8d3807d434e1f70d1245c6b4">parent</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent object. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual WStatelessSlot * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#aae1e4d3444723814adfc9717e14b693a">getStateless</a> (<a class="el" href="classWt_1_1WObject.html#a6ef714d6ef0060b78c039e729b913aa9">Method</a> method)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">On-demand stateless slot implementation. <a href="#aae1e4d3444723814adfc9717e14b693a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classWt_1_1WObject.html">WObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WObject.html#a413deb54de40ee278dd554e4960d58ca">sender</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the sender of the current slot call. <a href="#a413deb54de40ee278dd554e4960d58ca"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A base class for objects that participate in the signal/slot system. </p>
<p>The main feature offered by WObject is automated object life-time tracking when involved in signal/slot connections. Connections between signals and slots of WObject instances implement a type-safe event callback system. For example, one can simply connect() the <a class="el" href="classWt_1_1WInteractWidget.html#ae11e050cce0d4a8f742afa3ef92bfe8c" title="Event signal emitted when a mouse key was clicked on this widget.">WInteractWidget::clicked()</a> signal of a <a class="el" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">WPushButton</a> to the <a class="el" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">WApplication::quit()</a> method, to exit the application when the button is clicked:</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction.">Wt::WInteractWidget</a> *<a class="code" href="classWt_1_1WObject.html#a413deb54de40ee278dd554e4960d58ca" title="Returns the sender of the current slot call.">sender</a> = <span class="keyword">new</span> <a class="code" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">Wt::WText</a>(<span class="stringliteral">"Quit."</span>);
<a class="code" href="classWt_1_1WApplication.html" title="Represents an application instance for a single session.">Wt::WApplication</a> *app = <a class="code" href="classWt_1_1WApplication.html#a38d922da0a0d83395519f3eaab85d0f6" title="Returns the current application instance.">Wt::WApplication::instance</a>();
sender-><a class="code" href="classWt_1_1WInteractWidget.html#ae11e050cce0d4a8f742afa3ef92bfe8c" title="Event signal emitted when a mouse key was clicked on this widget.">clicked</a>().connect(app, &<a class="code" href="classWt_1_1WApplication.html#a5231d54ed34982f4366058eb6440c8f7" title="Quits the application.">Wt::WApplication::quit</a>);
</pre></div><p>Wt's signals may also propagate arguments to slots. For example, the same clicked() signal provides event details in a <a class="el" href="classWt_1_1WMouseEvent.html" title="A class providing details for a mouse event.">WMouseEvent</a> details class, and these details may be received in the slot: </p>
<div class="fragment"><pre class="fragment"> <span class="keyword">class </span>MyClass : <span class="keyword">public</span> Wt::WContainerWidget
{
<span class="keyword">public</span>:
MyClass(<a class="code" href="classWt_1_1WContainerWidget.html" title="A widget that holds and manages child widgets.">Wt::WContainerWidget</a> *parent = 0)
: Wt::WContainerWidget(parent)
{
<a class="code" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">Wt::WText</a> *text = <a class="code" href="classWt_1_1WText.html" title="A widget that renders (XHTML) text.">Wt::WText</a>(<span class="stringliteral">"Click here"</span>, <span class="keyword">this</span>);
text-><a class="code" href="classWt_1_1WInteractWidget.html#ae11e050cce0d4a8f742afa3ef92bfe8c" title="Event signal emitted when a mouse key was clicked on this widget.">clicked</a>().connect(<span class="keyword">this</span>, &MyClass::handleClick);
...
}
<span class="keyword">private</span>:
<span class="keywordtype">void</span> handleClick(<span class="keyword">const</span> <a class="code" href="classWt_1_1WMouseEvent.html" title="A class providing details for a mouse event.">Wt::WMouseEvent</a>& event) {
<span class="keywordflow">if</span> (event.<a class="code" href="classWt_1_1WMouseEvent.html#ac84d28364a178e547d2bc417e3eb2423" title="Returns keyboard modifiers.">modifiers</a>() & <a class="code" href="group__signalslot.html#gga50f91169486bada5931f3adc3a623091a206924f86e7455d5d88c30a1d61899b3" title="Shift key pressed.">Wt::ShiftModifier</a>) {
...
}
}
};
</pre></div><p> As the example illustrates, slots are ordinary WObject methods.</p>
<p>A second feature of WObject is that they allow ownership organization in ownership object trees. When an object is created with another object as parent, it's ownership is transferred to the parent. If not deleted explicitly, the child object will be deleted together with the parent. Child objects may also be deleted manually: they will remove themselves from their parent in the process.</p>
<p>In conjunction with <a class="el" href="classWt_1_1EventSignal.html" title="A signal that conveys user-interface events.">EventSignal</a>, WObject also facilitates learning of client-side event handling (in JavaScript) through invocation of the slot method. This is only possible when the slot behaviour is stateless, i.e. independent of any application state, and can be specified using the <a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6" title="Declares a slot to be stateless and learn client-side behaviour on first invocation.">implementStateless()</a> methods.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Signal.html" title="A signal that propagates events to listeners.">Signal</a>, <a class="el" href="classWt_1_1EventSignal.html" title="A signal that conveys user-interface events.">EventSignal</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1da12f5d82488adcca912c596b9398ea"></a><!-- doxytag: member="Wt::WObject::WObject" ref="a1da12f5d82488adcca912c596b9398ea" args="(WObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WObject::WObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html">WObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a WObject with a given parent object. </p>
<p>If the optional parent is specified, the parent object will destroy all child objects. Set parent to <code>0</code> to create an object with no parent.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a945f972be4331bfe46221263e04ae9ed" title="Adds a child object.">addChild()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a45d6c07b134db69687bd1b49025799c3"></a><!-- doxytag: member="Wt::WObject::~WObject" ref="a45d6c07b134db69687bd1b49025799c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::WObject::~WObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>This automatically:</p>
<ul>
<li>deletes all child objects</li>
<li>invalidates this object as sender or receiver in signals and slots </li>
</ul>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a945f972be4331bfe46221263e04ae9ed"></a><!-- doxytag: member="Wt::WObject::addChild" ref="a945f972be4331bfe46221263e04ae9ed" args="(WObject *child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WObject::addChild </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html">WObject</a> * </td>
<td class="paramname"><em>child</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a child object. </p>
<p>Take responsibility of deleting the child object, together with this object.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a1f811eeb5f0aa37b5b1931497cd9f163" title="Removes a child object.">removeChild()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aae1e4d3444723814adfc9717e14b693a"></a><!-- doxytag: member="Wt::WObject::getStateless" ref="aae1e4d3444723814adfc9717e14b693a" args="(Method method)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WStatelessSlot * Wt::WObject::getStateless </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html#a6ef714d6ef0060b78c039e729b913aa9">Method</a> </td>
<td class="paramname"><em>method</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>On-demand stateless slot implementation. </p>
<p>This method returns a stateless slot implementation for the given <code>method</code>. To avoid the cost of declaring methods to be stateless when they are not used, you may reimplement this method to provide a stateless implementation for a method only when the method is involved in a slot connection.</p>
<p>Use <a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6" title="Declares a slot to be stateless and learn client-side behaviour on first invocation.">implementStateless()</a> to provide a stateless implementation of the given <code>method</code>, or return the base class implementation otherwise. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1WWidget.html#ac7b367f664ab2b12ef79003123a17a0e">Wt::WWidget</a>, <a class="el" href="classWt_1_1WFormWidget.html#ae6f44795e053299e31a3ab3e433c7deb">Wt::WFormWidget</a>, and <a class="el" href="classWt_1_1WAbstractToggleButton.html#a7f686a8fc96dbecac79b58271c7dbb00">Wt::WAbstractToggleButton</a>.</p>
</div>
</div>
<a class="anchor" id="a5c5cc1d7aada99baf97d0dc203e42154"></a><!-- doxytag: member="Wt::WObject::id" ref="a5c5cc1d7aada99baf97d0dc203e42154" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string Wt::WObject::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the (unique) identifier for this object. </p>
<p>For a WWidget, this corresponds to the id of the DOM element that represents the widget. This is not entirely unique, since a <a class="el" href="classWt_1_1WCompositeWidget.html">composite widget</a> shares the same id as its implementation.</p>
<p>By default, the id is auto-generated, unless a custom id is set for a widget using <a class="el" href="classWt_1_1WWidget.html#a93ff9d1ca04e733cd54cd40a06775f7e" title="Sets the CSS Id.">WWidget::setId()</a>. The auto-generated id is created by concatenating <a class="el" href="classWt_1_1WObject.html#a5cad0cc3f73402de1422747653ece18f" title="Returns the object name.">objectName()</a> with a unique number.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WWidget.html#aa2b7078b3b43d53a85e5244b45d504f7" title="Returns a JavaScript expression to the corresponding DOM node.">WWidget::jsRef()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1WWebWidget.html#ae8e4e201f9e471659460ef047021d7e4">Wt::WWebWidget</a>, <a class="el" href="classWt_1_1WButtonGroup.html#abadc2ee3d7c98c6d4f7f0dcf3384d3be">Wt::WButtonGroup</a>, <a class="el" href="classWt_1_1WTableRow.html#ac16b8e1246aa646e7dca93c13685a392">Wt::WTableRow</a>, <a class="el" href="classWt_1_1WTableColumn.html#abd8af1a254554ad9bc465bccb4411b02">Wt::WTableColumn</a>, and <a class="el" href="classWt_1_1WCompositeWidget.html#a0557ba9778c04c33eab0be399cc84c02">Wt::WCompositeWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a214deee5d7324b9afd4ce44534daa782"></a><!-- doxytag: member="Wt::WObject::implementJavaScript" ref="a214deee5d7324b9afd4ce44534daa782" args="(void(T::*method)(), const std::string &jsCode)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">WStatelessSlot * Wt::WObject::implementJavaScript </td>
<td>(</td>
<td class="paramtype">void(T::*)() </td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>jsCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides a JavaScript implementation for a method. </p>
<p>This method sets the JavaScript implementation for a method. As a result, if JavaScript is available, the JavaScript version will be used on the client side and the visual effect of the C++ implementation will be ignored.</p>
<p>This is very similar to an auto-learned stateless slot, but here the learning is avoided by directly setting the JavaScript implementation.</p>
<p>The <code>jsCode</code> should be one or more valid JavaScript statements.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6">implementStateless(void (T::*method)())</a> </dd></dl>
</div>
</div>
<a class="anchor" id="adaa163b9e92933f3b2ff4ec58e2734c6"></a><!-- doxytag: member="Wt::WObject::implementStateless" ref="adaa163b9e92933f3b2ff4ec58e2734c6" args="(void(T::*method)())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">WStatelessSlot * Wt::WObject::implementStateless </td>
<td>(</td>
<td class="paramtype">void(T::*)() </td>
<td class="paramname"><em>method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Declares a slot to be stateless and learn client-side behaviour on first invocation. </p>
<p>Indicate that the given slot is stateless, and meets the requirement that the slot's code does not depend on any state of the object, but performs the same visual effect regardless of any state, or at least until <a class="el" href="classWt_1_1WObject.html#a5c7dcd5a60c88e5b36f0c8e0f9117698" title="Resets a learned stateless slot implementation.">resetLearnedSlot()</a> is called.</p>
<p>When this slot is connected to an <a class="el" href="classWt_1_1EventSignal.html" title="A signal that conveys user-interface events.">EventSignal</a> (such as those exposed by <a class="el" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction.">WInteractWidget</a> and <a class="el" href="classWt_1_1WFormWidget.html" title="An abstract widget that corresponds to an HTML form element.">WFormWidget</a>), the Wt library may decide to cache the visual effect of this slot in JavaScript code at client-side: this effect will be learned automatically at the first invocation. This has no consequences for the normal event handling, since the slot implementation is still executed in response to any event notification. Therefore, it is merely an optimization of the latency for the visual effect, but it does not change the behaviour of the application.</p>
<p>When for some reason the visual effect does change, one may use <a class="el" href="classWt_1_1WObject.html#a5c7dcd5a60c88e5b36f0c8e0f9117698" title="Resets a learned stateless slot implementation.">resetLearnedSlot()</a> or <a class="el" href="classWt_1_1WObject.html#a92d8b00edc79b7a60d41d7c088f50436" title="Resets learned stateless slot implementations.">resetLearnedSlots()</a> to flush the existing cached visual effect, forcing the library to relearn it.</p>
<p>It is crucial that this function be applied first to a slot that is intended to be stateless before any EventSignal connects to that slot. Otherwise, the connecting EventSignal cannot find the stateless slot implementation for the intended slot, and the statement will have no effect for that connection.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a5c7dcd5a60c88e5b36f0c8e0f9117698" title="Resets a learned stateless slot implementation.">resetLearnedSlot()</a>, <a class="el" href="classWt_1_1EventSignal.html" title="A signal that conveys user-interface events.">EventSignal</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7bf46fd1437f07150a9dd95bd95c266d"></a><!-- doxytag: member="Wt::WObject::implementStateless" ref="a7bf46fd1437f07150a9dd95bd95c266d" args="(void(T::*method)(), void(T::*undoMethod)())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">WStatelessSlot * Wt::WObject::implementStateless </td>
<td>(</td>
<td class="paramtype">void(T::*)() </td>
<td class="paramname"><em>method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(T::*)() </td>
<td class="paramname"><em>undoMethod</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Declares a slot to be stateless and learn client-side behaviour in advance. </p>
<p>This method has the same effect as <a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6">implementStateless(void (T::*method)())</a>, but learns the visual effect of the slot before the first invocation of the event.</p>
<p>To learn the visual effect, the library will simulate the event and record the visual effect. To restore the application state, it will call the undoMethod which must restore the effect of method.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6">implementStateless(void (T::*method)())</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5cad0cc3f73402de1422747653ece18f"></a><!-- doxytag: member="Wt::WObject::objectName" ref="a5cad0cc3f73402de1422747653ece18f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::WObject::objectName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the object name. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a64ce31cadb378c4eba81224f43bf493d" title="Sets an object name.">setObjectName()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1f811eeb5f0aa37b5b1931497cd9f163"></a><!-- doxytag: member="Wt::WObject::removeChild" ref="a1f811eeb5f0aa37b5b1931497cd9f163" args="(WObject *child)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WObject::removeChild </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WObject.html">WObject</a> * </td>
<td class="paramname"><em>child</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a child object. </p>
<p>The child must have been previously added.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a945f972be4331bfe46221263e04ae9ed" title="Adds a child object.">addChild()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1WWebWidget.html#a0b5f792c519fcf1d58efc2dfc18cc372">Wt::WWebWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a5c7dcd5a60c88e5b36f0c8e0f9117698"></a><!-- doxytag: member="Wt::WObject::resetLearnedSlot" ref="a5c7dcd5a60c88e5b36f0c8e0f9117698" args="(void(T::*method)())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">void Wt::WObject::resetLearnedSlot </td>
<td>(</td>
<td class="paramtype">void(T::*)() </td>
<td class="paramname"><em>method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets a learned stateless slot implementation. </p>
<p>Clears the stateless implementation for the given slot that was declared to be implemented with a stateless implementation.</p>
<p>When something has changed that breaks the contract of a stateless slot to always have the same effect, you may call this method to force the application to discard the current implementation.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6" title="Declares a slot to be stateless and learn client-side behaviour on first invocation.">implementStateless()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a92d8b00edc79b7a60d41d7c088f50436"></a><!-- doxytag: member="Wt::WObject::resetLearnedSlots" ref="a92d8b00edc79b7a60d41d7c088f50436" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WObject::resetLearnedSlots </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets learned stateless slot implementations. </p>
<p>Clears the stateless implementation for all slots declared to be implemented with a stateless implementation.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a5c7dcd5a60c88e5b36f0c8e0f9117698" title="Resets a learned stateless slot implementation.">resetLearnedSlot()</a>, <a class="el" href="classWt_1_1WObject.html#adaa163b9e92933f3b2ff4ec58e2734c6" title="Declares a slot to be stateless and learn client-side behaviour on first invocation.">implementStateless()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a413deb54de40ee278dd554e4960d58ca"></a><!-- doxytag: member="Wt::WObject::sender" ref="a413deb54de40ee278dd554e4960d58ca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WObject.html">WObject</a> * Wt::WObject::sender </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the sender of the current slot call. </p>
<p>Use this function to know who emitted the signal that triggered this slot call. It may be <code>0</code> if the signal has no owner information, or if there is no signal triggering the current slot, but instead the slot method is called directly. </p>
</div>
</div>
<a class="anchor" id="a64ce31cadb378c4eba81224f43bf493d"></a><!-- doxytag: member="Wt::WObject::setObjectName" ref="a64ce31cadb378c4eba81224f43bf493d" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::WObject::setObjectName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets an object name. </p>
<p>The object name can be used to easily identify a type of object in the DOM, and does not need to be unique. It will usually reflect the widget type or role. The object name is prepended to the auto-generated object <a class="el" href="classWt_1_1WObject.html#a5c5cc1d7aada99baf97d0dc203e42154" title="Returns the (unique) identifier for this object.">id()</a>.</p>
<p>The default object name is empty.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Only letters ([A-Za-z]), digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".") are allowed in the id.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WObject.html#a5c5cc1d7aada99baf97d0dc203e42154" title="Returns the (unique) identifier for this object.">id()</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>
