diff options
Diffstat (limited to 'doc/html/ntqcheckbox.html')
| -rw-r--r-- | doc/html/ntqcheckbox.html | 302 |
1 files changed, 302 insertions, 0 deletions
diff --git a/doc/html/ntqcheckbox.html b/doc/html/ntqcheckbox.html new file mode 100644 index 000000000..233068c3b --- /dev/null +++ b/doc/html/ntqcheckbox.html @@ -0,0 +1,302 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qcheckbox.cpp:49 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>TQCheckBox Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQCheckBox Class Reference</h1> + +<p>The TQCheckBox widget provides a checkbox with a text label. +<a href="#details">More...</a> +<p><tt>#include <<a href="qcheckbox-h.html">ntqcheckbox.h</a>></tt> +<p>Inherits <a href="ntqbutton.html">TQButton</a>. +<p><a href="qcheckbox-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#TQCheckBox"><b>TQCheckBox</b></a> ( TQWidget * parent, const char * name = 0 )</li> +<li class=fn><a href="#TQCheckBox-2"><b>TQCheckBox</b></a> ( const TQString & text, TQWidget * parent, const char * name = 0 )</li> +<li class=fn>bool <a href="#isChecked"><b>isChecked</b></a> () const</li> +<li class=fn>void <a href="#setNoChange"><b>setNoChange</b></a> ()</li> +<li class=fn>void <a href="#setTristate"><b>setTristate</b></a> ( bool y = TRUE )</li> +<li class=fn>bool <a href="#isTristate"><b>isTristate</b></a> () const</li> +</ul> +<h2>Public Slots</h2> +<ul> +<li class=fn>void <a href="#setChecked"><b>setChecked</b></a> ( bool check )</li> +</ul> +<h2>Important Inherited Members</h2> +<ul> +<li class=fn>TQString <a href="#text"><b>text</b></a> () const</li> +<li class=fn>virtual void <a href="#setText"><b>setText</b></a> ( const TQString & )</li> +<li class=fn>const TQPixmap * <a href="#pixmap"><b>pixmap</b></a> () const</li> +<li class=fn>virtual void <a href="#setPixmap"><b>setPixmap</b></a> ( const TQPixmap & )</li> +<li class=fn>TQKeySequence <a href="#accel"><b>accel</b></a> () const</li> +<li class=fn>virtual void <a href="#setAccel"><b>setAccel</b></a> ( const TQKeySequence & )</li> +<li class=fn>bool <a href="#isToggleButton"><b>isToggleButton</b></a> () const</li> +<li class=fn>virtual void <a href="#setDown"><b>setDown</b></a> ( bool )</li> +<li class=fn>bool <a href="#isDown"><b>isDown</b></a> () const</li> +<li class=fn>bool <a href="#isOn"><b>isOn</b></a> () const</li> +<li class=fn>ToggleState <a href="#state"><b>state</b></a> () const</li> +<li class=fn>bool <a href="#autoRepeat"><b>autoRepeat</b></a> () const</li> +<li class=fn>virtual void <a href="#setAutoRepeat"><b>setAutoRepeat</b></a> ( bool )</li> +<li class=fn>bool <a href="#isExclusiveToggle"><b>isExclusiveToggle</b></a> () const</li> +<li class=fn>TQButtonGroup * <a href="#group"><b>group</b></a> () const</li> +<li class=fn>void <a href="#toggle"><b>toggle</b></a> ()</li> +<li class=fn>void <a href="#pressed"><b>pressed</b></a> ()</li> +<li class=fn>void <a href="#released"><b>released</b></a> ()</li> +<li class=fn>void <a href="#clicked"><b>clicked</b></a> ()</li> +<li class=fn>void <a href="#toggled"><b>toggled</b></a> ( bool on )</li> +<li class=fn>void <a href="#stateChanged"><b>stateChanged</b></a> ( int state )</li> +</ul> +<h2>Properties</h2> +<ul> +<li class=fn>bool <a href="#autoMask-prop"><b>autoMask</b></a> - whether the checkbox is automatically masked <em>(read only)</em></li> +<li class=fn>bool <a href="#checked-prop"><b>checked</b></a> - whether the checkbox is checked</li> +<li class=fn>bool <a href="#tristate-prop"><b>tristate</b></a> - whether the checkbox is a tri-state checkbox</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The TQCheckBox widget provides a checkbox with a text label. +<p> + +<p> TQCheckBox and <a href="ntqradiobutton.html">TQRadioButton</a> are both option buttons. That is, they +can be switched on (checked) or off (unchecked). The classes +differ in how the choices for the user are restricted. Radio +buttons define a "one of many" choice, whereas checkboxes provide +"many of many" choices. +<p> A <a href="ntqbuttongroup.html">TQButtonGroup</a> can be used to group check buttons visually. +<p> Whenever a checkbox is checked or cleared it emits the signal +<a href="ntqbutton.html#toggled">toggled</a>(). Connect to this signal if you want to trigger an action +each time the checkbox changes state. You can use <a href="#isChecked">isChecked</a>() to +query whether or not a checkbox is checked. +<p> <b>Warning:</b> The toggled() signal can not be trusted for tristate +checkboxes. +<p> In addition to the usual checked and unchecked states, TQCheckBox +optionally provides a third state to indicate "no change". This +is useful whenever you need to give the user the option of neither +checking nor unchecking a checkbox. If you need this third state, +enable it with <a href="#setTristate">setTristate</a>() and use <a href="ntqbutton.html#state">state</a>() to query the current +toggle state. When a tristate checkbox changes state, it emits the +<a href="ntqbutton.html#stateChanged">stateChanged</a>() signal. +<p> Just like <a href="ntqpushbutton.html">TQPushButton</a>, a checkbox can display text or a pixmap. +The text can be set in the constructor or with <a href="ntqbutton.html#setText">setText</a>(); the +pixmap is set with <a href="ntqbutton.html#setPixmap">setPixmap</a>(). +<p> +<p> <img src=qchkbox-m.png> <img src=qchkbox-w.png> +<p> <p>See also <a href="ntqbutton.html">TQButton</a>, <a href="ntqradiobutton.html">TQRadioButton</a>, <a href="guibooks.html#fowler">Fowler: Check Box</a>, and <a href="basic.html">Basic Widgets</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="TQCheckBox"></a>TQCheckBox::TQCheckBox ( <a href="ntqwidget.html">TQWidget</a> * parent, const char * name = 0 ) +</h3> +Constructs a checkbox with no text. +<p> The <em>parent</em> and <em>name</em> arguments are sent to the <a href="ntqwidget.html">TQWidget</a> +constructor. + +<h3 class=fn><a name="TQCheckBox-2"></a>TQCheckBox::TQCheckBox ( const <a href="ntqstring.html">TQString</a> & text, <a href="ntqwidget.html">TQWidget</a> * parent, const char * name = 0 ) +</h3> +Constructs a checkbox with text <em>text</em>. +<p> The <em>parent</em> and <em>name</em> arguments are sent to the <a href="ntqwidget.html">TQWidget</a> +constructor. + +<h3 class=fn><a href="ntqkeysequence.html">TQKeySequence</a> <a name="accel"></a>TQButton::accel () const +</h3><p>Returns the accelerator associated with the button. +See the <a href="ntqbutton.html#accel-prop">"accel"</a> property for details. +<h3 class=fn>bool <a name="autoRepeat"></a>TQButton::autoRepeat () const +</h3><p>Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. +See the <a href="ntqbutton.html#autoRepeat-prop">"autoRepeat"</a> property for details. +<h3 class=fn>void <a name="clicked"></a>TQButton::clicked ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the button is activated (i.e. first +pressed down and then released when the mouse cursor is inside the +button), when the accelerator key is typed or when <a href="ntqbutton.html#animateClick">animateClick</a>() +is called. This signal is <em>not</em> emitted if you call <a href="ntqbutton.html#setDown">setDown</a>(). +<p> The <a href="ntqbuttongroup.html#clicked">TQButtonGroup::clicked</a>() signal does the same job, if you want +to connect several buttons to the same slot. +<p> <b>Warning:</b> Don't launch a model dialog in response to this signal +for a button that has <a href="ntqbutton.html#autoRepeat-prop">autoRepeat</a> turned on. +<p> <p>See also <a href="ntqbutton.html#pressed">pressed</a>(), <a href="ntqbutton.html#released">released</a>(), <a href="ntqbutton.html#toggled">toggled</a>(), <a href="ntqbutton.html#autoRepeat-prop">autoRepeat</a>, and <a href="ntqbutton.html#down-prop">down</a>. + +<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>. +<h3 class=fn><a href="ntqbuttongroup.html">TQButtonGroup</a> * <a name="group"></a>TQButton::group () const +</h3> +Returns the group that this button belongs to. +<p> If the button is not a member of any <a href="ntqbuttongroup.html">TQButtonGroup</a>, this function +returns 0. +<p> <p>See also <a href="ntqbuttongroup.html">TQButtonGroup</a>. + +<h3 class=fn>bool <a name="isChecked"></a>TQCheckBox::isChecked () const +</h3><p>Returns TRUE if the checkbox is checked; otherwise returns FALSE. +See the <a href="ntqcheckbox.html#checked-prop">"checked"</a> property for details. +<h3 class=fn>bool <a name="isDown"></a>TQButton::isDown () const +</h3><p>Returns TRUE if the button is pressed; otherwise returns FALSE. +See the <a href="ntqbutton.html#down-prop">"down"</a> property for details. +<h3 class=fn>bool <a name="isExclusiveToggle"></a>TQButton::isExclusiveToggle () const +</h3><p>Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. +See the <a href="ntqbutton.html#exclusiveToggle-prop">"exclusiveToggle"</a> property for details. +<h3 class=fn>bool <a name="isOn"></a>TQButton::isOn () const +</h3><p>Returns TRUE if the button is toggled; otherwise returns FALSE. +See the <a href="ntqbutton.html#on-prop">"on"</a> property for details. +<h3 class=fn>bool <a name="isToggleButton"></a>TQButton::isToggleButton () const +</h3><p>Returns TRUE if the button is a toggle button; otherwise returns FALSE. +See the <a href="ntqbutton.html#toggleButton-prop">"toggleButton"</a> property for details. +<h3 class=fn>bool <a name="isTristate"></a>TQCheckBox::isTristate () const +</h3><p>Returns TRUE if the checkbox is a tri-state checkbox; otherwise returns FALSE. +See the <a href="ntqcheckbox.html#tristate-prop">"tristate"</a> property for details. +<h3 class=fn>const <a href="ntqpixmap.html">TQPixmap</a> * <a name="pixmap"></a>TQButton::pixmap () const +</h3><p>Returns the pixmap shown on the button. +See the <a href="ntqbutton.html#pixmap-prop">"pixmap"</a> property for details. +<h3 class=fn>void <a name="pressed"></a>TQButton::pressed ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the button is pressed down. +<p> <p>See also <a href="ntqbutton.html#released">released</a>() and <a href="ntqbutton.html#clicked">clicked</a>(). + +<p>Examples: <a href="httpd-example.html#x724">network/httpd/httpd.cpp</a> and <a href="popup-example.html#x1606">popup/popup.cpp</a>. +<h3 class=fn>void <a name="released"></a>TQButton::released ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when the button is released. +<p> <p>See also <a href="ntqbutton.html#pressed">pressed</a>(), <a href="ntqbutton.html#clicked">clicked</a>(), and <a href="ntqbutton.html#toggled">toggled</a>(). + +<h3 class=fn>void <a name="setAccel"></a>TQButton::setAccel ( const <a href="ntqkeysequence.html">TQKeySequence</a> & )<tt> [virtual]</tt> +</h3><p>Sets the accelerator associated with the button. +See the <a href="ntqbutton.html#accel-prop">"accel"</a> property for details. +<h3 class=fn>void <a name="setAutoRepeat"></a>TQButton::setAutoRepeat ( bool )<tt> [virtual]</tt> +</h3><p>Sets whether autoRepeat is enabled. +See the <a href="ntqbutton.html#autoRepeat-prop">"autoRepeat"</a> property for details. +<h3 class=fn>void <a name="setChecked"></a>TQCheckBox::setChecked ( bool check )<tt> [slot]</tt> +</h3><p>Sets whether the checkbox is checked to <em>check</em>. +See the <a href="ntqcheckbox.html#checked-prop">"checked"</a> property for details. +<h3 class=fn>void <a name="setDown"></a>TQButton::setDown ( bool )<tt> [virtual]</tt> +</h3><p>Sets whether the button is pressed. +See the <a href="ntqbutton.html#down-prop">"down"</a> property for details. +<h3 class=fn>void <a name="setNoChange"></a>TQCheckBox::setNoChange () +</h3> +Sets the checkbox to the "no change" state. +<p> <p>See also <a href="#tristate-prop">tristate</a>. + +<h3 class=fn>void <a name="setPixmap"></a>TQButton::setPixmap ( const <a href="ntqpixmap.html">TQPixmap</a> & )<tt> [virtual]</tt> +</h3><p>Sets the pixmap shown on the button. +See the <a href="ntqbutton.html#pixmap-prop">"pixmap"</a> property for details. +<h3 class=fn>void <a name="setText"></a>TQButton::setText ( const <a href="ntqstring.html">TQString</a> & )<tt> [virtual]</tt> +</h3><p>Sets the text shown on the button. +See the <a href="ntqbutton.html#text-prop">"text"</a> property for details. +<h3 class=fn>void <a name="setTristate"></a>TQCheckBox::setTristate ( bool y = TRUE ) +</h3><p>Sets whether the checkbox is a tri-state checkbox to <em>y</em>. +See the <a href="ntqcheckbox.html#tristate-prop">"tristate"</a> property for details. +<h3 class=fn><a href="ntqbutton.html#ToggleState-enum">ToggleState</a> <a name="state"></a>TQButton::state () const +</h3><p>Returns the state of the toggle button. +See the <a href="ntqbutton.html#toggleState-prop">"toggleState"</a> property for details. +<h3 class=fn>void <a name="stateChanged"></a>TQButton::stateChanged ( int state )<tt> [signal]</tt> +</h3> + +<p> This signal is emitted whenever a toggle button changes state. <em>state</em> is <a href="ntqbutton.html#ToggleState-enum">On</a> if the button is on, <a href="ntqbutton.html#ToggleState-enum">NoChange</a> if it is in the +<a href="#setTristate">"no change" state</a> or <a href="ntqbutton.html#ToggleState-enum">Off</a> +if the button is off. +<p> This may be the result of a user action, <a href="ntqbutton.html#toggle">toggle</a>() slot activation, +<a href="ntqbutton.html#setState">setState</a>(), or because <a href="ntqbutton.html#setOn">setOn</a>() was called. +<p> <p>See also <a href="ntqbutton.html#clicked">clicked</a>() and <a href="ntqbutton.html#ToggleState-enum">TQButton::ToggleState</a>. + +<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="text"></a>TQButton::text () const +</h3><p>Returns the text shown on the button. +See the <a href="ntqbutton.html#text-prop">"text"</a> property for details. +<h3 class=fn>void <a name="toggle"></a>TQButton::toggle ()<tt> [slot]</tt> +</h3> +Toggles the state of a toggle button. +<p> <p>See also <a href="ntqbutton.html#on-prop">on</a>, <a href="ntqbutton.html#setOn">setOn</a>(), <a href="ntqbutton.html#toggled">toggled</a>(), and <a href="ntqbutton.html#toggleButton-prop">toggleButton</a>. + +<h3 class=fn>void <a name="toggled"></a>TQButton::toggled ( bool on )<tt> [signal]</tt> +</h3> + +<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. +<p> This may be the result of a user action, <a href="ntqbutton.html#toggle">toggle</a>() slot activation, +or because <a href="ntqbutton.html#setOn">setOn</a>() was called. +<p> <p>See also <a href="ntqbutton.html#clicked">clicked</a>(). + +<p>Example: <a href="listbox-example.html#x1427">listbox/listbox.cpp</a>. +<hr><h2>Property Documentation</h2> +<h3 class=fn><a href="ntqkeysequence.html">TQKeySequence</a> <a name="accel-prop"></a>accel</h3> +<p>This property holds the accelerator associated with the button. +<p>This property is 0 if there is no accelerator set. If you set this +property to 0 then any current accelerator is removed. + +<p>Set this property's value with <a href="#setAccel">setAccel</a>() and get this property's value with <a href="#accel">accel</a>(). +<h3 class=fn>bool <a name="autoMask-prop"></a>autoMask</h3> +<p>This property holds whether the checkbox is automatically masked. +<p><p><p>See also <a href="ntqwidget.html#autoMask-prop">TQWidget::autoMask</a>. + +<h3 class=fn>bool <a name="autoRepeat-prop"></a>autoRepeat</h3> +<p>This property holds whether autoRepeat is enabled. +<p>If autoRepeat is enabled then the <a href="ntqbutton.html#clicked">clicked</a>() signal is emitted at +regular intervals if the button is down. This property has no +effect on toggle buttons. autoRepeat is off by default. + +<p>Set this property's value with <a href="#setAutoRepeat">setAutoRepeat</a>() and get this property's value with <a href="#autoRepeat">autoRepeat</a>(). +<h3 class=fn>bool <a name="checked-prop"></a>checked</h3> +<p>This property holds whether the checkbox is checked. +<p>The default is unchecked, i.e. FALSE. + +<p>Set this property's value with <a href="#setChecked">setChecked</a>() and get this property's value with <a href="#isChecked">isChecked</a>(). +<h3 class=fn><a href="ntqpixmap.html">TQPixmap</a> <a name="pixmap-prop"></a>pixmap</h3> +<p>This property holds the pixmap shown on the button. +<p>If the pixmap is monochrome (i.e. it is a <a href="ntqbitmap.html">TQBitmap</a> or its <a href="ntqpixmap.html#depth">depth</a> is 1) and it does not have a mask, +this property will set the pixmap to be its own mask. The purpose +of this is to draw transparent bitmaps which are important for +toggle buttons, for example. +<p> <a href="ntqbutton.html#pixmap">pixmap</a>() returns 0 if no pixmap was set. + +<p>Set this property's value with <a href="#setPixmap">setPixmap</a>() and get this property's value with <a href="#pixmap">pixmap</a>(). +<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="text-prop"></a>text</h3> +<p>This property holds the text shown on the button. +<p>This property will return a <a href="ntqstring.html#TQString-null">TQString::null</a> if the button has no +text. If the text has an ampersand (&) in it, then an +accelerator is automatically created for it using the character +that follows the '&' as the accelerator key. Any previous +accelerator will be overwritten, or cleared if no accelerator is +defined by the text. +<p> There is no default text. + +<p>Set this property's value with <a href="#setText">setText</a>() and get this property's value with <a href="#text">text</a>(). +<h3 class=fn>bool <a name="tristate-prop"></a>tristate</h3> +<p>This property holds whether the checkbox is a tri-state checkbox. +<p>The default is two-state, i.e. tri-state is FALSE. + +<p>Set this property's value with <a href="#setTristate">setTristate</a>() and get this property's value with <a href="#isTristate">isTristate</a>(). +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">TQt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>TQt 3.3.8</div> +</table></div></address></body> +</html> |