Sophie

Sophie

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

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::Button 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_1Button.html">Button</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::Button 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::Button" --><!-- doxytag: inherits="Wt::Ext::AbstractButton" -->
<p>A button.  
 <a href="classWt_1_1Ext_1_1Button.html#details">More...</a></p>

<p><code>#include &lt;Wt/Ext/Button&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Wt::Ext::Button:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Ext_1_1Button__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1Button_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Ext_1_1Button_inherit__map" id="Wt_1_1Ext_1_1Button_inherit__map">
<area shape="rect" href="classWt_1_1Ext_1_1AbstractButton.html" title="Abstract base class for a (toolbar) button or menu item." alt="" coords="5,379,165,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="16,304,155,331"/><area shape="rect" href="classWt_1_1Ext_1_1Widget.html" title="An abstract base class for all Ext widgets." alt="" coords="28,229,143,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="21,155,149,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user&#45;interface component." alt="" coords="36,80,135,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="37,5,133,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classWt_1_1Ext_1_1Button-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="aa65a7bd6f3f9ad2be15d7553fb41e786"></a><!-- doxytag: member="Wt::Ext::Button::Button" ref="aa65a7bd6f3f9ad2be15d7553fb41e786" args="(WContainerWidget *parent=0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#aa65a7bd6f3f9ad2be15d7553fb41e786">Button</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a push button with empty label. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0f31acbe76188e841e5e132f8111f725"></a><!-- doxytag: member="Wt::Ext::Button::Button" ref="a0f31acbe76188e841e5e132f8111f725" args="(const WString &amp;text, WContainerWidget *parent=0)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#a0f31acbe76188e841e5e132f8111f725">Button</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;text, <a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a push button with given label. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f3cc145f4a8eedd7f65532187836586"></a><!-- doxytag: member="Wt::Ext::Button::~Button" ref="a6f3cc145f4a8eedd7f65532187836586" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#a6f3cc145f4a8eedd7f65532187836586">~Button</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a button. <br/></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_1Button.html#a2ed225799c373580940b99312bfa0b79">setDefault</a> (bool how)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Configure as the default button.  <a href="#a2ed225799c373580940b99312bfa0b79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#aba951a81109feb3fcf1823e0dd8d8fcd">isDefault</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return if is the default button.  <a href="#aba951a81109feb3fcf1823e0dd8d8fcd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1JSignal.html">JSignal</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#acdb897f4b6d0ca38764966017ecceaff">clicked</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a43a839bb8e46df6c06ef2df65ae277c9" title="Signal emitted when a item gets activated.">activated()</a> signal.  <a href="#acdb897f4b6d0ca38764966017ecceaff"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A button. </p>
<p>A button with a label and/or icon, which may be standalone, or be added to a <a class="el" href="classWt_1_1Ext_1_1ToolBar.html" title="A class that represents a tool bar (or a menu bar).">ToolBar</a> (see <a class="el" href="classWt_1_1Ext_1_1ToolBar.html#aa0384abdeff4e404676bfbd872599d48" title="Add a button with given text.">ToolBar::addButton()</a>) or to a <a class="el" href="classWt_1_1Ext_1_1Dialog.html" title="A dialog emulates a modal window that blocks the user-interface.">Dialog</a> (see <a class="el" href="classWt_1_1Ext_1_1Dialog.html#ad9f19a8ff62e3520544f2ea10a7647ce" title="Add a button at the bottom of this dialog.">Dialog::addButton()</a>).</p>
<p>The API is similar to the <a class="el" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">WPushButton</a> API, with the following additional features: </p>
<ul>
<li>
an icon may be specified using <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#ab484de8e4b543aa36ef5bfd1c8b70548" title="Set the item icon path.">AbstractButton::setIcon()</a>; </li>
<li>
the button may be configured as a toggle button (see <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#afe7d30546234065316df73026558fc79" title="Set if the item is checkable.">AbstractButton::setCheckable()</a>; </li>
<li>
the button may be associated with a popup-menu (see <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#aadbc30ae480d99a6e4ca19a070e02d81" title="Set a menu that popups up when the item is activated.">AbstractButton::setMenu()</a>; </li>
</ul>
<div class="image">
<img src="ExtButton-1.png" alt="ExtButton-1.png"/>
<div class="caption">
Standalone button</div></div>
 <div class="image">
<img src="ExtButton-1a.png" alt="ExtButton-1a.png"/>
<div class="caption">
Standalone button hover effect</div></div>
 <div class="image">
<img src="ExtButton-2.png" alt="ExtButton-2.png"/>
<div class="caption">
Button in tool bar</div></div>
 <div class="image">
<img src="ExtButton-3.png" alt="ExtButton-3.png"/>
<div class="caption">
Button in tool bar with icon</div></div>
 <div class="image">
<img src="ExtButton-4.png" alt="ExtButton-4.png"/>
<div class="caption">
Button in tool bar with icon and menu</div></div>
 <div class="image">
<img src="ExtButton-5.png" alt="ExtButton-5.png"/>
<div class="caption">
Button in tool bar hover effect</div></div>
 <div class="image">
<img src="ExtButton-6.png" alt="ExtButton-6.png"/>
<div class="caption">
Toggled button in tool bar</div></div>
 </div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acdb897f4b6d0ca38764966017ecceaff"></a><!-- doxytag: member="Wt::Ext::Button::clicked" ref="acdb897f4b6d0ca38764966017ecceaff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1JSignal.html">JSignal</a>&amp; Wt::Ext::Button::clicked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Alias for the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#a43a839bb8e46df6c06ef2df65ae277c9" title="Signal emitted when a item gets activated.">activated()</a> signal. </p>
<p>This signal is added for increased API compatibility with <a class="el" href="classWt_1_1WPushButton.html" title="A widget that represents a push button.">WPushButton</a>. </p>

</div>
</div>
<a class="anchor" id="aba951a81109feb3fcf1823e0dd8d8fcd"></a><!-- doxytag: member="Wt::Ext::Button::isDefault" ref="aba951a81109feb3fcf1823e0dd8d8fcd" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Wt::Ext::Button::isDefault </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return if is the default button. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Button.html#a2ed225799c373580940b99312bfa0b79" title="Configure as the default button.">setDefault(bool)</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a2ed225799c373580940b99312bfa0b79"></a><!-- doxytag: member="Wt::Ext::Button::setDefault" ref="a2ed225799c373580940b99312bfa0b79" args="(bool how)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Wt::Ext::Button::setDefault </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>how</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Configure as the default button. </p>
<p>This only applies for buttons that have been added to a dialog using <a class="el" href="classWt_1_1Ext_1_1Dialog.html#ad9f19a8ff62e3520544f2ea10a7647ce" title="Add a button at the bottom of this dialog.">Dialog::addButton()</a>.</p>
<p>The default button will be activated when the user presses the Enter (or Return) key in a dialog.</p>
<p>The default button may be rendered with more emphasis (?).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Ext_1_1Button.html#aba951a81109feb3fcf1823e0dd8d8fcd" title="Return if is the default button.">isDefault()</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>