Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > b3a1f4d91c26f535919e39e25606614a > files > 1249

wt-doc-3.2.3-1.fc18.noarch.rpm

<!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::AbstractToggleButton 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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_1AbstractToggleButton.html">AbstractToggleButton</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wt::Ext::AbstractToggleButton 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::AbstractToggleButton" --><!-- doxytag: inherits="Wt::Ext::FormField" -->
<p>Abstract base class for radio button and check box.  
 <a href="classWt_1_1Ext_1_1AbstractToggleButton.html#details">More...</a></p>

<p><code>#include &lt;Ext/AbstractToggleButton&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Wt::Ext::AbstractToggleButton:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Ext_1_1AbstractToggleButton__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1AbstractToggleButton_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Ext_1_1AbstractToggleButton_inherit__map" id="Wt_1_1Ext_1_1AbstractToggleButton_inherit__map">
<area shape="rect" href="classWt_1_1Ext_1_1CheckBox.html" title="A user control that represents a check box." alt="" coords="5,528,139,555"/><area shape="rect" href="classWt_1_1Ext_1_1RadioButton.html" title="A user control that represents a radio button." alt="" coords="163,528,307,555"/><area shape="rect" href="classWt_1_1Ext_1_1FormField.html" title="An abstract base class for form fields." alt="" coords="88,379,219,405"/><area shape="rect" href="classWt_1_1Ext_1_1Component.html" title="An abstract base class for widgets that can be visually disabled." alt="" coords="84,304,223,331"/><area shape="rect" href="classWt_1_1Ext_1_1Widget.html" title="An abstract base class for all Ext widgets." alt="" coords="96,229,211,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="89,155,217,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user&#45;interface component." alt="" coords="104,80,203,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="105,5,201,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classWt_1_1Ext_1_1AbstractToggleButton-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a9132c42402232810427d96d700e4cc61">setChecked</a> (bool)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the state of the button.  <a href="#a9132c42402232810427d96d700e4cc61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a9aa7198153fcca043f267d337fcfd168">setChecked</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the button checked.  <a href="#a9aa7198153fcca043f267d337fcfd168"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a56f4470889ff56155dc6598751eef47e">setUnChecked</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the button unChecked.  <a href="#a56f4470889ff56155dc6598751eef47e"></a><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"><a class="anchor" id="a73635f45799c76d017c4924cb133997f"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::setText" ref="a73635f45799c76d017c4924cb133997f" args="(const WString &amp;text)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a73635f45799c76d017c4924cb133997f">setText</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;text)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the text of the label. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0b4bbe46c7ee9a61267016a3530d136"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::text" ref="aa0b4bbe46c7ee9a61267016a3530d136" args="() const " -->
const <a class="el" href="classWt_1_1WString.html">WString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aa0b4bbe46c7ee9a61267016a3530d136">text</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the text of the label. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32fe2a8e20c828f15f08440bae17ef4d"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::isChecked" ref="a32fe2a8e20c828f15f08440bae17ef4d" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a32fe2a8e20c828f15f08440bae17ef4d">isChecked</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the state of the button. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a42534aedfc08e6b2cb816d792a9ca749">checked</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal emitted when the button gets checked.  <a href="#a42534aedfc08e6b2cb816d792a9ca749"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aad745c27aae18a80f159091c7e01fe10">unChecked</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal emitted when the button gets unChecked.  <a href="#aad745c27aae18a80f159091c7e01fe10"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for radio button and check box. </p>
<p>Ext/AbstractToggleButton A toggle button provides a button with a boolean state (checked or unchecked), and a text label.</p>
<p>To act on a change of the state, you can listen to the <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a42534aedfc08e6b2cb816d792a9ca749" title="Signal emitted when the button gets checked.">checked()</a> or <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aad745c27aae18a80f159091c7e01fe10" title="Signal emitted when the button gets unChecked.">unChecked()</a> signals.</p>
<p>The current state (checked or unchecked) may be inspected using the <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a32fe2a8e20c828f15f08440bae17ef4d" title="Returns the state of the button.">isChecked()</a> method.</p>
<p>The API is identical to the <a class="el" href="classWt_1_1WAbstractToggleButton.html" title="An abstract base class for radio buttons and check boxes.">WAbstractToggleButton</a> API. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a42534aedfc08e6b2cb816d792a9ca749"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::checked" ref="a42534aedfc08e6b2cb816d792a9ca749" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp; Wt::Ext::AbstractToggleButton::checked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Signal emitted when the button gets checked. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aad745c27aae18a80f159091c7e01fe10" title="Signal emitted when the button gets unChecked.">unChecked()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a9132c42402232810427d96d700e4cc61"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::setChecked" ref="a9132c42402232810427d96d700e4cc61" args="(bool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Ext::AbstractToggleButton::setChecked </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>how</em></td><td>)</td>
          <td><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Change the state of the button. </p>
<p>Does not emit the <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a42534aedfc08e6b2cb816d792a9ca749" title="Signal emitted when the button gets checked.">checked()</a> or <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aad745c27aae18a80f159091c7e01fe10" title="Signal emitted when the button gets unChecked.">unChecked()</a> signals.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a9aa7198153fcca043f267d337fcfd168" title="Set the button checked.">setChecked()</a>, <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a56f4470889ff56155dc6598751eef47e" title="Set the button unChecked.">setUnChecked()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a9aa7198153fcca043f267d337fcfd168"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::setChecked" ref="a9aa7198153fcca043f267d337fcfd168" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Ext::AbstractToggleButton::setChecked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual, slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the button checked. </p>
<p>Does not emit the <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a42534aedfc08e6b2cb816d792a9ca749" title="Signal emitted when the button gets checked.">checked()</a> signal.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a9132c42402232810427d96d700e4cc61" title="Change the state of the button.">setChecked(bool)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a56f4470889ff56155dc6598751eef47e"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::setUnChecked" ref="a56f4470889ff56155dc6598751eef47e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Ext::AbstractToggleButton::setUnChecked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual, slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the button unChecked. </p>
<p>Does not emit the <a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#aad745c27aae18a80f159091c7e01fe10" title="Signal emitted when the button gets unChecked.">unChecked()</a> signal.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a9132c42402232810427d96d700e4cc61" title="Change the state of the button.">setChecked(bool)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="aad745c27aae18a80f159091c7e01fe10"></a><!-- doxytag: member="Wt::Ext::AbstractToggleButton::unChecked" ref="aad745c27aae18a80f159091c7e01fe10" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> &amp; Wt::Ext::AbstractToggleButton::unChecked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Signal emitted when the button gets unChecked. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1AbstractToggleButton.html#a42534aedfc08e6b2cb816d792a9ca749" title="Signal emitted when the button gets checked.">checked()</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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&nbsp;<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>