<!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::AbstractButton 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_1AbstractButton.html">AbstractButton</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::AbstractButton 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::AbstractButton" --><!-- doxytag: inherits="Wt::Ext::Component" -->
<p>Abstract base class for a (toolbar) button or menu item.
<a href="classWt_1_1Ext_1_1AbstractButton.html#details">More...</a></p>
<p><code>#include <Wt/Ext/AbstractButton></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Ext::AbstractButton:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Ext_1_1AbstractButton__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1AbstractButton_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Ext_1_1AbstractButton_inherit__map" id="Wt_1_1Ext_1_1AbstractButton_inherit__map">
<area shape="rect" href="classWt_1_1Ext_1_1Button.html" title="A button." alt="" coords="5,453,117,480"/><area shape="rect" href="classWt_1_1Ext_1_1MenuItem.html" title="An item in a menu." alt="" coords="141,453,272,480"/><area shape="rect" href="classWt_1_1Ext_1_1Component.html" title="An abstract base class for widgets that can be visually disabled." alt="" coords="64,304,203,331"/><area shape="rect" href="classWt_1_1Ext_1_1Widget.html" title="An abstract base class for all Ext widgets." alt="" coords="76,229,191,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="69,155,197,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="84,80,183,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="85,5,181,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Ext_1_1AbstractButton-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="ae4a53837bb690bc1426a8b8da336bcea"></a><!-- doxytag: member="Wt::Ext::AbstractButton::setText" ref="ae4a53837bb690bc1426a8b8da336bcea" args="(const WString &text)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#ae4a53837bb690bc1426a8b8da336bcea">setText</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the item text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7adfdba80922236853b08502a4881a72"></a><!-- doxytag: member="Wt::Ext::AbstractButton::text" ref="a7adfdba80922236853b08502a4881a72" args="() const " -->
const <a class="el" href="classWt_1_1WString.html">WString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a7adfdba80922236853b08502a4881a72">text</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the item text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab484de8e4b543aa36ef5bfd1c8b70548"></a><!-- doxytag: member="Wt::Ext::AbstractButton::setIcon" ref="ab484de8e4b543aa36ef5bfd1c8b70548" args="(const std::string &path)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#ab484de8e4b543aa36ef5bfd1c8b70548">setIcon</a> (const std::string &path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the item icon path. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3b00f75eba7eb933b3cd809746cb8a1"></a><!-- doxytag: member="Wt::Ext::AbstractButton::icon" ref="aa3b00f75eba7eb933b3cd809746cb8a1" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#aa3b00f75eba7eb933b3cd809746cb8a1">icon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the item icon path. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe7d30546234065316df73026558fc79"></a><!-- doxytag: member="Wt::Ext::AbstractButton::setCheckable" ref="afe7d30546234065316df73026558fc79" args="(bool how)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79">setCheckable</a> (bool how)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set if the item is checkable. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fa242a4f266453da5ef8112cadc59e9"></a><!-- doxytag: member="Wt::Ext::AbstractButton::isCheckable" ref="a3fa242a4f266453da5ef8112cadc59e9" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9">isCheckable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return if the item is checkable. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadbc30ae480d99a6e4ca19a070e02d81"></a><!-- doxytag: member="Wt::Ext::AbstractButton::setMenu" ref="aadbc30ae480d99a6e4ca19a070e02d81" args="(Menu *menu)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#aadbc30ae480d99a6e4ca19a070e02d81">setMenu</a> (<a class="el" href="classWt_1_1Ext_1_1Menu.html">Menu</a> *menu)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a menu that popups up when the item is activated. <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_1AbstractButton.html#a79b1606d4b674dc13c5e92239be85700">setChecked</a> (bool how)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the checked state. <a href="#a79b1606d4b674dc13c5e92239be85700"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa637f0902da104ab323131cb237c3556"></a><!-- doxytag: member="Wt::Ext::AbstractButton::isChecked" ref="aa637f0902da104ab323131cb237c3556" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#aa637f0902da104ab323131cb237c3556">isChecked</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the checked state. <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_1AbstractButton.html#afc7e2bc9c426bbbfb9beb9e18e9a0845">configureToolTip</a> (<a class="el" href="classWt_1_1Ext_1_1ToolTipConfig.html">ToolTipConfig</a> *config)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure the tool tip associated with this item. <a href="#afc7e2bc9c426bbbfb9beb9e18e9a0845"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1JSignal.html">JSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a43a839bb8e46df6c06ef2df65ae277c9">activated</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal emitted when a item gets activated. <a href="#a43a839bb8e46df6c06ef2df65ae277c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1JSignal.html">JSignal</a>< bool > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a4492f5bd82c0c33c0282c955bafce9d4">toggled</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal emitted when a item gets toggled. <a href="#a4492f5bd82c0c33c0282c955bafce9d4"></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_1AbstractButton.html#a2cab98fae87f87209c9999e086253fb0">refresh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Refresh the widget. <a href="#a2cab98fae87f87209c9999e086253fb0"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for a (toolbar) button or menu item. </p>
<p>You may set the button text using <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#ae4a53837bb690bc1426a8b8da336bcea" title="Set the item text.">setText()</a> and icon use <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#ab484de8e4b543aa36ef5bfd1c8b70548" title="Set the item icon path.">setIcon()</a>, and configure whether the button/menu item can be checked or toggled using <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79" title="Set if the item is checkable.">setCheckable()</a>.</p>
<p>To respond to a click, you can connect to the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a43a839bb8e46df6c06ef2df65ae277c9" title="Signal emitted when a item gets activated.">activated()</a> signal, and for a checkable button/item you may listen to the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a4492f5bd82c0c33c0282c955bafce9d4" title="Signal emitted when a item gets toggled.">toggled()</a> signal.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Button.html" title="A button.">Button</a>, <a class="el" href="classWt_1_1Ext_1_1MenuItem.html" title="An item in a menu.">MenuItem</a>, <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html" title="Abstract base class for radio button and check box.">AbstractToggleButton</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a43a839bb8e46df6c06ef2df65ae277c9"></a><!-- doxytag: member="Wt::Ext::AbstractButton::activated" ref="a43a839bb8e46df6c06ef2df65ae277c9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1JSignal.html">JSignal</a>& Wt::Ext::AbstractButton::activated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal emitted when a item gets activated. </p>
<p>This signal is emitted for non-checkable items (for who <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</a> == false), when the user activates the item (by clicking it).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79" title="Set if the item is checkable.">setCheckable(bool)</a>, <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="afc7e2bc9c426bbbfb9beb9e18e9a0845"></a><!-- doxytag: member="Wt::Ext::AbstractButton::configureToolTip" ref="afc7e2bc9c426bbbfb9beb9e18e9a0845" args="(ToolTipConfig *config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::AbstractButton::configureToolTip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Ext_1_1ToolTipConfig.html">ToolTipConfig</a> * </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Configure the tool tip associated with this item. </p>
<p>If the config has no parent, then ownership is transferred to this widget. </p>
</div>
</div>
<a class="anchor" id="a2cab98fae87f87209c9999e086253fb0"></a><!-- doxytag: member="Wt::Ext::AbstractButton::refresh" ref="a2cab98fae87f87209c9999e086253fb0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::AbstractButton::refresh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Refresh the widget. </p>
<p>The refresh method is invoked when the locale is changed using <a class="el" href="classWt_1_1WApplication.html#a5c9cc1350019d69f154a2b44cdaf2596" title="Changes the locale.">WApplication::setLocale()</a> or when the user hit the refresh button.</p>
<p>The widget must actualize its contents in response. </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WWebWidget.html#a48f8c17376bd04d1359481c5441f072a">Wt::WWebWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a79b1606d4b674dc13c5e92239be85700"></a><!-- doxytag: member="Wt::Ext::AbstractButton::setChecked" ref="a79b1606d4b674dc13c5e92239be85700" args="(bool how)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Ext::AbstractButton::setChecked </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>how</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change the checked state. </p>
<p>This is only used when the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</a> == true.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79" title="Set if the item is checkable.">setCheckable(bool)</a>, <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a4492f5bd82c0c33c0282c955bafce9d4"></a><!-- doxytag: member="Wt::Ext::AbstractButton::toggled" ref="a4492f5bd82c0c33c0282c955bafce9d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1JSignal.html">JSignal</a><bool>& Wt::Ext::AbstractButton::toggled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal emitted when a item gets toggled. </p>
<p>This signal is emitted for checkable items (for who <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</a> == false), when the user changed toggles the item state. The new state is passed as a parameter value.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79" title="Set if the item is checkable.">setCheckable(bool)</a>, <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a3fa242a4f266453da5ef8112cadc59e9" title="Return if the item is checkable.">isCheckable()</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>
