'\" t
.TH TQRadioButton 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
TQRadioButton \- Radio button with a text or pixmap label
.SH SYNOPSIS
\fC#include <tqradiobutton.h>\fR
.PP
Inherits TQButton.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBTQRadioButton\fR ( TQWidget * parent, const char * name = 0 )"
.br
.ti -1c
.BI "\fBTQRadioButton\fR ( const TQString & text, TQWidget * parent, const char * name = 0 )"
.br
.ti -1c
.BI "bool \fBisChecked\fR () const"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "virtual void \fBsetChecked\fR ( bool check )"
.br
.in -1c
.SS "Important Inherited Members"
.in +1c
.ti -1c
.BI "TQString \fBtext\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetText\fR ( const TQString & )"
.br
.ti -1c
.BI "const TQPixmap * \fBpixmap\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetPixmap\fR ( const TQPixmap & )"
.br
.ti -1c
.BI "TQKeySequence \fBaccel\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetAccel\fR ( const TQKeySequence & )"
.br
.ti -1c
.BI "bool \fBisToggleButton\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetDown\fR ( bool )"
.br
.ti -1c
.BI "bool \fBisDown\fR () const"
.br
.ti -1c
.BI "bool \fBisOn\fR () const"
.br
.ti -1c
.BI "ToggleState \fBstate\fR () const"
.br
.ti -1c
.BI "bool \fBautoRepeat\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetAutoRepeat\fR ( bool )"
.br
.ti -1c
.BI "bool \fBisExclusiveToggle\fR () const"
.br
.ti -1c
.BI "TQButtonGroup * \fBgroup\fR () const"
.br
.ti -1c
.BI "void \fBtoggle\fR ()"
.br
.ti -1c
.BI "void \fBpressed\fR ()"
.br
.ti -1c
.BI "void \fBreleased\fR ()"
.br
.ti -1c
.BI "void \fBclicked\fR ()"
.br
.ti -1c
.BI "void \fBtoggled\fR ( bool on )"
.br
.ti -1c
.BI "void \fBstateChanged\fR ( int state )"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "bool \fBautoMask\fR - whether the radio button is automatically masked \fI(read " "only" ")\fR"
.br
.ti -1c
.BI "bool \fBchecked\fR - whether the radio button is checked"
.br
.in -1c
.SH DESCRIPTION
The TQRadioButton widget provides a radio button with a text or pixmap label.
.PP
TQRadioButton and TQCheckBox 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. Check boxes define "many of many" choices, whereas radio buttons provide a" one of many" choice. In a group of radio buttons only one radio button at a time can be checked; if the user selects another button, the previously selected button is switched off.
.PP
The easiest way to implement a "one of many" choice is simply to put the radio buttons into TQButtonGroup.
.PP
Whenever a button is switched on or off it emits the signal toggled(). Connect to this signal if you want to trigger an action each time the button changes state. Otherwise, use isChecked() to see if a particular button is selected.
.PP
Just like TQPushButton, a radio button can display text or a pixmap. The text can be set in the constructor or with setText(); the pixmap is set with setPixmap().
.PP
.ce 1
.B "[Image Omitted]"
.PP
.ce 1
.B "[Image Omitted]"
.PP
See also TQPushButton, TQToolButton, GUI Design Handbook: Radio Button, and Basic Widgets.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "TQRadioButton::TQRadioButton ( TQWidget * parent, const char * name = 0 )"
Constructs a radio button with no text.
.PP
The \fIparent\fR and \fIname\fR arguments are sent on to the TQWidget constructor.
.SH "TQRadioButton::TQRadioButton ( const TQString & text, TQWidget * parent, const char * name = 0 )"
Constructs a radio button with the text \fItext\fR.
.PP
The \fIparent\fR and \fIname\fR arguments are sent on to the TQWidget constructor.
.SH "TQKeySequence TQButton::accel () const"
Returns the accelerator associated with the button. See the "accel" property for details.
.SH "bool TQButton::autoRepeat () const"
Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details.
.SH "void TQButton::clicked ()\fC [signal]\fR"
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 animateClick() is called. This signal is \fInot\fR emitted if you call setDown().
.PP
The TQButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot.
.PP
\fBWarning:\fR Don't launch a model dialog in response to this signal for a button that has autoRepeat turned on.
.PP
See also pressed(), released(), toggled(), autoRepeat, and down.
.PP
Examples:
.)l chart/setdataform.cpp, listbox/listbox.cpp, network/clientserver/client/client.cpp, progressbar/progressbar.cpp, richtext/richtext.cpp, t2/main.cpp, and t4/main.cpp.
.SH "TQButtonGroup * TQButton::group () const"
Returns the group that this button belongs to.
.PP
If the button is not a member of any TQButtonGroup, this function returns 0.
.PP
See also TQButtonGroup.
.SH "bool TQRadioButton::isChecked () const"
Returns TRUE if the radio button is checked; otherwise returns FALSE. See the "checked" property for details.
.SH "bool TQButton::isDown () const"
Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details.
.SH "bool TQButton::isExclusiveToggle () const"
Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details.
.SH "bool TQButton::isOn () const"
Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details.
.SH "bool TQButton::isToggleButton () const"
Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details.
.SH "const TQPixmap * TQButton::pixmap () const"
Returns the pixmap shown on the button. See the "pixmap" property for details.
.SH "void TQButton::pressed ()\fC [signal]\fR"
This signal is emitted when the button is pressed down.
.PP
See also released() and clicked().
.PP
Examples:
.)l network/httpd/httpd.cpp and popup/popup.cpp.
.SH "void TQButton::released ()\fC [signal]\fR"
This signal is emitted when the button is released.
.PP
See also pressed(), clicked(), and toggled().
.SH "void TQButton::setAccel ( const TQKeySequence & )\fC [virtual]\fR"
Sets the accelerator associated with the button. See the "accel" property for details.
.SH "void TQButton::setAutoRepeat ( bool )\fC [virtual]\fR"
Sets whether autoRepeat is enabled. See the "autoRepeat" property for details.
.SH "void TQRadioButton::setChecked ( bool check )\fC [virtual slot]\fR"
Sets whether the radio button is checked to \fIcheck\fR. See the "checked" property for details.
.SH "void TQButton::setDown ( bool )\fC [virtual]\fR"
Sets whether the button is pressed. See the "down" property for details.
.SH "void TQButton::setPixmap ( const TQPixmap & )\fC [virtual]\fR"
Sets the pixmap shown on the button. See the "pixmap" property for details.
.SH "void TQButton::setText ( const TQString & )\fC [virtual]\fR"
Sets the text shown on the button. See the "text" property for details.
.SH "ToggleState TQButton::state () const"
Returns the state of the toggle button. See the "toggleState" property for details.
.SH "void TQButton::stateChanged ( int state )\fC [signal]\fR"
This signal is emitted whenever a toggle button changes state. \fIstate\fR is On if the button is on, NoChange if it is in the" no change" state or Off if the button is off.
.PP
This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called.
.PP
See also clicked() and TQButton::ToggleState.
.SH "TQString TQButton::text () const"
Returns the text shown on the button. See the "text" property for details.
.SH "void TQButton::toggle ()\fC [slot]\fR"
Toggles the state of a toggle button.
.PP
See also on, setOn(), toggled(), and toggleButton.
.SH "void TQButton::toggled ( bool on )\fC [signal]\fR"
This signal is emitted whenever a toggle button changes status. \fIon\fR is TRUE if the button is on, or FALSE if the button is off.
.PP
This may be the result of a user action, toggle() slot activation, or because setOn() was called.
.PP
See also clicked().
.PP
Example: listbox/listbox.cpp.
.SS "Property Documentation"
.SH "TQKeySequence accel"
This property holds the accelerator associated with the button.
.PP
This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed.
.PP
Set this property's value with setAccel() and get this property's value with accel().
.SH "bool autoMask"
This property holds whether the radio button is automatically masked.
.PP
See also TQWidget::autoMask.
.SH "bool autoRepeat"
This property holds whether autoRepeat is enabled.
.PP
If autoRepeat is enabled then the clicked() signal is emitted at regular intervals if the button is down. This property has no effect on toggle buttons. autoRepeat is off by default.
.PP
Set this property's value with setAutoRepeat() and get this property's value with autoRepeat().
.SH "bool checked"
This property holds whether the radio button is checked.
.PP
This property will not effect any other radio buttons unless they have been placed in the same TQButtonGroup. The default value is FALSE (unchecked).
.PP
Set this property's value with setChecked() and get this property's value with isChecked().
.SH "TQPixmap pixmap"
This property holds the pixmap shown on the button.
.PP
If the pixmap is monochrome (i.e. it is a TQBitmap or its depth 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.
.PP
pixmap() returns 0 if no pixmap was set.
.PP
Set this property's value with setPixmap() and get this property's value with pixmap().
.SH "TQString text"
This property holds the text shown on the button.
.PP
This property will return a TQString::null 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.
.PP
There is no default text.
.PP
Set this property's value with setText() and get this property's value with text().
.SH "SEE ALSO"
.BR http://doc.trolltech.com/tqradiobutton.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive TQt documentation is provided in HTML format; it is
located at $TQTDIR/doc/html and can be read using TQt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech.
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (tqradiobutton.3qt) and the Qt
version (3.3.8).
