File: classWt_1_1Ext_1_1Button.html

package info (click to toggle)
witty 3.1.2-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 45,512 kB
  • ctags: 35,832
  • sloc: cpp: 69,469; ansic: 66,945; xml: 4,383; sh: 594; perl: 108; makefile: 106
file content (178 lines) | stat: -rw-r--r-- 12,124 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Wt: Wt::Ext::Button Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceWt.html">Wt</a>::<a class="el" href="namespaceWt_1_1Ext.html">Ext</a>::<a class="el" href="classWt_1_1Ext_1_1Button.html">Button</a>
  </div>
</div>
<div class="contents">
<h1>Wt::Ext::Button Class Reference<br>
<small>
[<a class="el" href="group__ext.html">Ext widgets</a>]</small>
</h1><!-- doxytag: class="Wt::Ext::Button" --><!-- doxytag: inherits="Wt::Ext::AbstractButton" -->A button.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;Wt/Ext/Button&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Wt::Ext::Button:</div>
<div class="dynsection">
<p><center><img src="classWt_1_1Ext_1_1Button__inherit__graph.png" border="0" usemap="#Wt_1_1Ext_1_1Button__inherit__map" alt="Inheritance graph"></center>
<map name="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="29,229,141,256"><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="24,155,147,181"><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user&#45;interface component." alt="" coords="37,80,133,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><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classWt_1_1Ext_1_1Button-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a65a7bd6f3f9ad2be15d7553fb41e786"></a><!-- doxytag: member="Wt::Ext::Button::Button" ref="a65a7bd6f3f9ad2be15d7553fb41e786" args="(WContainerWidget *parent=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#a65a7bd6f3f9ad2be15d7553fb41e786">Button</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a push button with empty label. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f31acbe76188e841e5e132f8111f725"></a><!-- doxytag: member="Wt::Ext::Button::Button" ref="0f31acbe76188e841e5e132f8111f725" args="(const WString &amp;text, WContainerWidget *parent=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#0f31acbe76188e841e5e132f8111f725">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">&nbsp;</td><td class="mdescRight">Create a push button with given label. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f3cc145f4a8eedd7f65532187836586"></a><!-- doxytag: member="Wt::Ext::Button::~Button" ref="6f3cc145f4a8eedd7f65532187836586" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#6f3cc145f4a8eedd7f65532187836586">~Button</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delete a button. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#2ed225799c373580940b99312bfa0b79">setDefault</a> (bool how)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configure as the default button.  <a href="#2ed225799c373580940b99312bfa0b79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#ba951a81109feb3fcf1823e0dd8d8fcd">isDefault</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return if is the default button.  <a href="#ba951a81109feb3fcf1823e0dd8d8fcd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classWt_1_1JSignal.html">JSignal</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Ext_1_1Button.html#cdb897f4b6d0ca38764966017ecceaff">clicked</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#43a839bb8e46df6c06ef2df65ae277c9" title="Signal emitted when a item gets activated.">activated()</a> signal.  <a href="#cdb897f4b6d0ca38764966017ecceaff"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A button. 
<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#a0384abdeff4e404676bfbd872599d48" 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#d9f19a8ff62e3520544f2ea10a7647ce" title="Add a button at the bottom of this dialog.">Dialog::addButton()</a>).<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: <ul>
<li>
an icon may be specified using <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#b484de8e4b543aa36ef5bfd1c8b70548" 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#fe7d30546234065316df73026558fc79" 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#adbc30ae480d99a6e4ca19a070e02d81" title="Set a menu that popups up when the item is activated.">AbstractButton::setMenu()</a>; </li>
</ul>
<p>
<div align="center">
<img src="ExtButton-1.png" alt="ExtButton-1.png">
<p><strong>Standalone button</strong></p></div>
 <div align="center">
<img src="ExtButton-1a.png" alt="ExtButton-1a.png">
<p><strong>Standalone button hover effect</strong></p></div>
 <div align="center">
<img src="ExtButton-2.png" alt="ExtButton-2.png">
<p><strong>Button in tool bar</strong></p></div>
 <div align="center">
<img src="ExtButton-3.png" alt="ExtButton-3.png">
<p><strong>Button in tool bar with icon</strong></p></div>
 <div align="center">
<img src="ExtButton-4.png" alt="ExtButton-4.png">
<p><strong>Button in tool bar with icon and menu</strong></p></div>
 <div align="center">
<img src="ExtButton-5.png" alt="ExtButton-5.png">
<p><strong>Button in tool bar hover effect</strong></p></div>
 <div align="center">
<img src="ExtButton-6.png" alt="ExtButton-6.png">
<p><strong>Toggled button in tool bar</strong></p></div>
 <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2ed225799c373580940b99312bfa0b79"></a><!-- doxytag: member="Wt::Ext::Button::setDefault" ref="2ed225799c373580940b99312bfa0b79" 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&nbsp;</td>
          <td class="paramname"> <em>how</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

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

</div>
</div><p>
<a class="anchor" name="ba951a81109feb3fcf1823e0dd8d8fcd"></a><!-- doxytag: member="Wt::Ext::Button::isDefault" ref="ba951a81109feb3fcf1823e0dd8d8fcd" 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>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

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

</div>
</div><p>
<a class="anchor" name="cdb897f4b6d0ca38764966017ecceaff"></a><!-- doxytag: member="Wt::Ext::Button::clicked" ref="cdb897f4b6d0ca38764966017ecceaff" 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>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Alias for the <a class="el" href="classWt_1_1Ext_1_1AbstractButton.html#43a839bb8e46df6c06ef2df65ae277c9" title="Signal emitted when a item gets activated.">activated()</a> signal. 
<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>. 
</div>
</div><p>
</div>
<hr size="1"><address style="align: right;"><small>
Generated on Fri Mar 26 17:12:08 2010 for <a href="http://www.webtoolkit.eu/wt/">Wt</a> by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
</body>
</html>