source: trunk/doc/html/qradiobutton.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 17.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qradiobutton.cpp:50 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QRadioButton Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QRadioButton Class Reference</h1>
33
34<p>The QRadioButton widget provides a radio button with a text or pixmap label.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qradiobutton-h.html">qradiobutton.h</a>&gt;</tt>
37<p>Inherits <a href="qbutton.html">QButton</a>.
38<p><a href="qradiobutton-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QRadioButton"><b>QRadioButton</b></a> ( QWidget&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
42<li class=fn><a href="#QRadioButton-2"><b>QRadioButton</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;text, QWidget&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
43<li class=fn>bool <a href="#isChecked"><b>isChecked</b></a> () const</li>
44</ul>
45<h2>Public Slots</h2>
46<ul>
47<li class=fn>virtual void <a href="#setChecked"><b>setChecked</b></a> ( bool&nbsp;check )</li>
48</ul>
49<h2>Important Inherited Members</h2>
50<ul>
51<li class=fn>QString <a href="#text"><b>text</b></a> () const</li>
52<li class=fn>virtual void <a href="#setText"><b>setText</b></a> ( const QString &amp; )</li>
53<li class=fn>const QPixmap * <a href="#pixmap"><b>pixmap</b></a> () const</li>
54<li class=fn>virtual void <a href="#setPixmap"><b>setPixmap</b></a> ( const QPixmap &amp; )</li>
55<li class=fn>QKeySequence <a href="#accel"><b>accel</b></a> () const</li>
56<li class=fn>virtual void <a href="#setAccel"><b>setAccel</b></a> ( const QKeySequence &amp; )</li>
57<li class=fn>bool <a href="#isToggleButton"><b>isToggleButton</b></a> () const</li>
58<li class=fn>virtual void <a href="#setDown"><b>setDown</b></a> ( bool )</li>
59<li class=fn>bool <a href="#isDown"><b>isDown</b></a> () const</li>
60<li class=fn>bool <a href="#isOn"><b>isOn</b></a> () const</li>
61<li class=fn>ToggleState <a href="#state"><b>state</b></a> () const</li>
62<li class=fn>bool <a href="#autoRepeat"><b>autoRepeat</b></a> () const</li>
63<li class=fn>virtual void <a href="#setAutoRepeat"><b>setAutoRepeat</b></a> ( bool )</li>
64<li class=fn>bool <a href="#isExclusiveToggle"><b>isExclusiveToggle</b></a> () const</li>
65<li class=fn>QButtonGroup * <a href="#group"><b>group</b></a> () const</li>
66<li class=fn>void <a href="#toggle"><b>toggle</b></a> ()</li>
67<li class=fn>void <a href="#pressed"><b>pressed</b></a> ()</li>
68<li class=fn>void <a href="#released"><b>released</b></a> ()</li>
69<li class=fn>void <a href="#clicked"><b>clicked</b></a> ()</li>
70<li class=fn>void <a href="#toggled"><b>toggled</b></a> ( bool&nbsp;on )</li>
71<li class=fn>void <a href="#stateChanged"><b>stateChanged</b></a> ( int&nbsp;state )</li>
72</ul>
73<h2>Properties</h2>
74<ul>
75<li class=fn>bool <a href="#autoMask-prop"><b>autoMask</b></a>&nbsp;- whether the radio button is automatically masked &nbsp;<em>(read only)</em></li>
76<li class=fn>bool <a href="#checked-prop"><b>checked</b></a>&nbsp;- whether the radio button is checked</li>
77</ul>
78<hr><a name="details"></a><h2>Detailed Description</h2>
79
80
81The QRadioButton widget provides a radio button with a text or pixmap label.
82<p>
83
84<p> QRadioButton and <a href="qcheckbox.html">QCheckBox</a> are both option buttons. That is, they
85can be switched on (checked) or off (unchecked). The classes
86differ in how the choices for the user are restricted. Check boxes
87define "many of many" choices, whereas radio buttons provide a
88"one of many" choice. In a group of radio buttons only one radio
89button at a time can be checked; if the user selects another
90button, the previously selected button is switched off.
91<p> The easiest way to implement a "one of many" choice is simply to
92put the radio buttons into <a href="qbuttongroup.html">QButtonGroup</a>.
93<p> Whenever a button is switched on or off it emits the signal
94<a href="qbutton.html#toggled">toggled</a>(). Connect to this signal if you want to trigger an action
95each time the button changes state. Otherwise, use <a href="#isChecked">isChecked</a>() to
96see if a particular button is selected.
97<p> Just like <a href="qpushbutton.html">QPushButton</a>, a radio button can display text or a
98pixmap. The text can be set in the constructor or with <a href="qbutton.html#setText">setText</a>();
99the pixmap is set with <a href="qbutton.html#setPixmap">setPixmap</a>().
100<p> <img src=qradiobt-m.png> <img src=qradiobt-w.png>
101<p>
102<p> <p>See also <a href="qpushbutton.html">QPushButton</a>, <a href="qtoolbutton.html">QToolButton</a>, <a href="guibooks.html#fowler">GUI Design Handbook: Radio Button</a>, and <a href="basic.html">Basic Widgets</a>.
103
104<hr><h2>Member Function Documentation</h2>
105<h3 class=fn><a name="QRadioButton"></a>QRadioButton::QRadioButton ( <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
106</h3>
107Constructs a radio button with no text.
108<p> The <em>parent</em> and <em>name</em> arguments are sent on to the <a href="qwidget.html">QWidget</a>
109constructor.
110
111<h3 class=fn><a name="QRadioButton-2"></a>QRadioButton::QRadioButton ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;text, <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
112</h3>
113Constructs a radio button with the text <em>text</em>.
114<p> The <em>parent</em> and <em>name</em> arguments are sent on to the <a href="qwidget.html">QWidget</a>
115constructor.
116
117<h3 class=fn><a href="qkeysequence.html">QKeySequence</a> <a name="accel"></a>QButton::accel () const
118</h3><p>Returns the accelerator associated with the button.
119See the <a href="qbutton.html#accel-prop">"accel"</a> property for details.
120<h3 class=fn>bool <a name="autoRepeat"></a>QButton::autoRepeat () const
121</h3><p>Returns TRUE if autoRepeat is enabled; otherwise returns FALSE.
122See the <a href="qbutton.html#autoRepeat-prop">"autoRepeat"</a> property for details.
123<h3 class=fn>void <a name="clicked"></a>QButton::clicked ()<tt> [signal]</tt>
124</h3>
125
126<p> This signal is emitted when the button is activated (i.e. first
127pressed down and then released when the mouse cursor is inside the
128button), when the accelerator key is typed or when <a href="qbutton.html#animateClick">animateClick</a>()
129is called. This signal is <em>not</em> emitted if you call <a href="qbutton.html#setDown">setDown</a>().
130<p> The <a href="qbuttongroup.html#clicked">QButtonGroup::clicked</a>() signal does the same job, if you want
131to connect several buttons to the same slot.
132<p> <b>Warning:</b> Don't launch a model dialog in response to this signal
133for a button that has <a href="qbutton.html#autoRepeat-prop">autoRepeat</a> turned on.
134<p> <p>See also <a href="qbutton.html#pressed">pressed</a>(), <a href="qbutton.html#released">released</a>(), <a href="qbutton.html#toggled">toggled</a>(), <a href="qbutton.html#autoRepeat-prop">autoRepeat</a>, and <a href="qbutton.html#down-prop">down</a>.
135
136<p>Examples: <a href="tutorial2-08.html#x2596">chart/setdataform.cpp</a>, <a href="listbox-example.html#x1426">listbox/listbox.cpp</a>, <a href="clientserver-example.html#x792">network/clientserver/client/client.cpp</a>, <a href="progressbar-example.html#x962">progressbar/progressbar.cpp</a>, <a href="richtext-example.html#x462">richtext/richtext.cpp</a>, <a href="tutorial1-02.html#x2290">t2/main.cpp</a>, and <a href="tutorial1-04.html#x2306">t4/main.cpp</a>.
137<h3 class=fn><a href="qbuttongroup.html">QButtonGroup</a>&nbsp;* <a name="group"></a>QButton::group () const
138</h3>
139Returns the group that this button belongs to.
140<p> If the button is not a member of any <a href="qbuttongroup.html">QButtonGroup</a>, this function
141returns 0.
142<p> <p>See also <a href="qbuttongroup.html">QButtonGroup</a>.
143
144<h3 class=fn>bool <a name="isChecked"></a>QRadioButton::isChecked () const
145</h3><p>Returns TRUE if the radio button is checked; otherwise returns FALSE.
146See the <a href="qradiobutton.html#checked-prop">"checked"</a> property for details.
147<h3 class=fn>bool <a name="isDown"></a>QButton::isDown () const
148</h3><p>Returns TRUE if the button is pressed; otherwise returns FALSE.
149See the <a href="qbutton.html#down-prop">"down"</a> property for details.
150<h3 class=fn>bool <a name="isExclusiveToggle"></a>QButton::isExclusiveToggle () const
151</h3><p>Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE.
152See the <a href="qbutton.html#exclusiveToggle-prop">"exclusiveToggle"</a> property for details.
153<h3 class=fn>bool <a name="isOn"></a>QButton::isOn () const
154</h3><p>Returns TRUE if the button is toggled; otherwise returns FALSE.
155See the <a href="qbutton.html#on-prop">"on"</a> property for details.
156<h3 class=fn>bool <a name="isToggleButton"></a>QButton::isToggleButton () const
157</h3><p>Returns TRUE if the button is a toggle button; otherwise returns FALSE.
158See the <a href="qbutton.html#toggleButton-prop">"toggleButton"</a> property for details.
159<h3 class=fn>const&nbsp;<a href="qpixmap.html">QPixmap</a>&nbsp;* <a name="pixmap"></a>QButton::pixmap () const
160</h3><p>Returns the pixmap shown on the button.
161See the <a href="qbutton.html#pixmap-prop">"pixmap"</a> property for details.
162<h3 class=fn>void <a name="pressed"></a>QButton::pressed ()<tt> [signal]</tt>
163</h3>
164
165<p> This signal is emitted when the button is pressed down.
166<p> <p>See also <a href="qbutton.html#released">released</a>() and <a href="qbutton.html#clicked">clicked</a>().
167
168<p>Examples: <a href="httpd-example.html#x724">network/httpd/httpd.cpp</a> and <a href="popup-example.html#x1606">popup/popup.cpp</a>.
169<h3 class=fn>void <a name="released"></a>QButton::released ()<tt> [signal]</tt>
170</h3>
171
172<p> This signal is emitted when the button is released.
173<p> <p>See also <a href="qbutton.html#pressed">pressed</a>(), <a href="qbutton.html#clicked">clicked</a>(), and <a href="qbutton.html#toggled">toggled</a>().
174
175<h3 class=fn>void <a name="setAccel"></a>QButton::setAccel ( const&nbsp;<a href="qkeysequence.html">QKeySequence</a>&nbsp;&amp; )<tt> [virtual]</tt>
176</h3><p>Sets the accelerator associated with the button.
177See the <a href="qbutton.html#accel-prop">"accel"</a> property for details.
178<h3 class=fn>void <a name="setAutoRepeat"></a>QButton::setAutoRepeat ( bool )<tt> [virtual]</tt>
179</h3><p>Sets whether autoRepeat is enabled.
180See the <a href="qbutton.html#autoRepeat-prop">"autoRepeat"</a> property for details.
181<h3 class=fn>void <a name="setChecked"></a>QRadioButton::setChecked ( bool&nbsp;check )<tt> [virtual slot]</tt>
182</h3><p>Sets whether the radio button is checked to <em>check</em>.
183See the <a href="qradiobutton.html#checked-prop">"checked"</a> property for details.
184<h3 class=fn>void <a name="setDown"></a>QButton::setDown ( bool )<tt> [virtual]</tt>
185</h3><p>Sets whether the button is pressed.
186See the <a href="qbutton.html#down-prop">"down"</a> property for details.
187<h3 class=fn>void <a name="setPixmap"></a>QButton::setPixmap ( const&nbsp;<a href="qpixmap.html">QPixmap</a>&nbsp;&amp; )<tt> [virtual]</tt>
188</h3><p>Sets the pixmap shown on the button.
189See the <a href="qbutton.html#pixmap-prop">"pixmap"</a> property for details.
190<h3 class=fn>void <a name="setText"></a>QButton::setText ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; )<tt> [virtual]</tt>
191</h3><p>Sets the text shown on the button.
192See the <a href="qbutton.html#text-prop">"text"</a> property for details.
193<h3 class=fn><a href="qbutton.html#ToggleState-enum">ToggleState</a> <a name="state"></a>QButton::state () const
194</h3><p>Returns the state of the toggle button.
195See the <a href="qbutton.html#toggleState-prop">"toggleState"</a> property for details.
196<h3 class=fn>void <a name="stateChanged"></a>QButton::stateChanged ( int&nbsp;state )<tt> [signal]</tt>
197</h3>
198
199<p> This signal is emitted whenever a toggle button changes state. <em>state</em> is <a href="qbutton.html#ToggleState-enum">On</a> if the button is on, <a href="qbutton.html#ToggleState-enum">NoChange</a> if it is in the
200<a href="qcheckbox.html#setTristate">"no change" state</a> or <a href="qbutton.html#ToggleState-enum">Off</a>
201if the button is off.
202<p> This may be the result of a user action, <a href="qbutton.html#toggle">toggle</a>() slot activation,
203<a href="qbutton.html#setState">setState</a>(), or because <a href="qbutton.html#setOn">setOn</a>() was called.
204<p> <p>See also <a href="qbutton.html#clicked">clicked</a>() and <a href="qbutton.html#ToggleState-enum">QButton::ToggleState</a>.
205
206<h3 class=fn><a href="qstring.html">QString</a> <a name="text"></a>QButton::text () const
207</h3><p>Returns the text shown on the button.
208See the <a href="qbutton.html#text-prop">"text"</a> property for details.
209<h3 class=fn>void <a name="toggle"></a>QButton::toggle ()<tt> [slot]</tt>
210</h3>
211Toggles the state of a toggle button.
212<p> <p>See also <a href="qbutton.html#on-prop">on</a>, <a href="qbutton.html#setOn">setOn</a>(), <a href="qbutton.html#toggled">toggled</a>(), and <a href="qbutton.html#toggleButton-prop">toggleButton</a>.
213
214<h3 class=fn>void <a name="toggled"></a>QButton::toggled ( bool&nbsp;on )<tt> [signal]</tt>
215</h3>
216
217<p> This signal is emitted whenever a toggle button changes status. <em>on</em> is TRUE if the button is on, or FALSE if the button is off.
218<p> This may be the result of a user action, <a href="qbutton.html#toggle">toggle</a>() slot activation,
219or because <a href="qbutton.html#setOn">setOn</a>() was called.
220<p> <p>See also <a href="qbutton.html#clicked">clicked</a>().
221
222<p>Example: <a href="listbox-example.html#x1427">listbox/listbox.cpp</a>.
223<hr><h2>Property Documentation</h2>
224<h3 class=fn><a href="qkeysequence.html">QKeySequence</a> <a name="accel-prop"></a>accel</h3>
225<p>This property holds the accelerator associated with the button.
226<p>This property is 0 if there is no accelerator set. If you set this
227property to 0 then any current accelerator is removed.
228
229<p>Set this property's value with <a href="#setAccel">setAccel</a>() and get this property's value with <a href="#accel">accel</a>().
230<h3 class=fn>bool <a name="autoMask-prop"></a>autoMask</h3>
231<p>This property holds whether the radio button is automatically masked.
232<p><p><p>See also <a href="qwidget.html#autoMask-prop">QWidget::autoMask</a>.
233
234<h3 class=fn>bool <a name="autoRepeat-prop"></a>autoRepeat</h3>
235<p>This property holds whether autoRepeat is enabled.
236<p>If autoRepeat is enabled then the <a href="qbutton.html#clicked">clicked</a>() signal is emitted at
237regular intervals if the button is down. This property has no
238effect on toggle buttons. autoRepeat is off by default.
239
240<p>Set this property's value with <a href="#setAutoRepeat">setAutoRepeat</a>() and get this property's value with <a href="#autoRepeat">autoRepeat</a>().
241<h3 class=fn>bool <a name="checked-prop"></a>checked</h3>
242<p>This property holds whether the radio button is checked.
243<p>This property will not effect any other radio buttons unless they
244have been placed in the same <a href="qbuttongroup.html">QButtonGroup</a>. The default value is
245FALSE (unchecked).
246
247<p>Set this property's value with <a href="#setChecked">setChecked</a>() and get this property's value with <a href="#isChecked">isChecked</a>().
248<h3 class=fn><a href="qpixmap.html">QPixmap</a> <a name="pixmap-prop"></a>pixmap</h3>
249<p>This property holds the pixmap shown on the button.
250<p>If the pixmap is monochrome (i.e. it is a <a href="qbitmap.html">QBitmap</a> or its <a href="qpixmap.html#depth">depth</a> is 1) and it does not have a mask,
251this property will set the pixmap to be its own mask. The purpose
252of this is to draw transparent bitmaps which are important for
253toggle buttons, for example.
254<p> <a href="qbutton.html#pixmap">pixmap</a>() returns 0 if no pixmap was set.
255
256<p>Set this property's value with <a href="#setPixmap">setPixmap</a>() and get this property's value with <a href="#pixmap">pixmap</a>().
257<h3 class=fn><a href="qstring.html">QString</a> <a name="text-prop"></a>text</h3>
258<p>This property holds the text shown on the button.
259<p>This property will return a <a href="qstring.html#QString-null">QString::null</a> if the button has no
260text. If the text has an ampersand (&amp;) in it, then an
261accelerator is automatically created for it using the character
262that follows the '&amp;' as the accelerator key. Any previous
263accelerator will be overwritten, or cleared if no accelerator is
264defined by the text.
265<p> There is no default text.
266
267<p>Set this property's value with <a href="#setText">setText</a>() and get this property's value with <a href="#text">text</a>().
268<!-- eof -->
269<hr><p>
270This file is part of the <a href="index.html">Qt toolkit</a>.
271Copyright &copy; 1995-2007
272<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
273<table width=100% cellspacing=0 border=0><tr>
274<td>Copyright &copy; 2007
275<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
276<td align=right><div align=right>Qt 3.3.8</div>
277</table></div></address></body>
278</html>
Note: See TracBrowser for help on using the repository browser.