diff options
Diffstat (limited to 'doc/man/man3/tqbutton.3qt')
| -rw-r--r-- | doc/man/man3/tqbutton.3qt | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/doc/man/man3/tqbutton.3qt b/doc/man/man3/tqbutton.3qt index cf1be83c2..74cd6752c 100644 --- a/doc/man/man3/tqbutton.3qt +++ b/doc/man/man3/tqbutton.3qt @@ -1,5 +1,5 @@ '\" t -.TH QButton 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQButton 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. @@ -7,9 +7,9 @@ .ad l .nh .SH NAME -QButton \- The abstract base class of button widgets, providing functionality common to buttons +TQButton \- The abstract base class of button widgets, providing functionality common to buttons .SH SYNOPSIS -\fC#include <ntqbutton.h>\fR +\fC#include <tqbutton.h>\fR .PP Inherits TQWidget. .PP @@ -18,10 +18,10 @@ Inherited by TQCheckBox, TQPushButton, TQRadioButton, and TQToolButton. .SS "Public Members" .in +1c .ti -1c -.BI "\fBQButton\fR ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.BI "\fBTQButton\fR ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" .br .ti -1c -.BI "\fB~QButton\fR ()" +.BI "\fB~TQButton\fR ()" .br .ti -1c .BI "TQString \fBtext\fR () const" @@ -75,7 +75,7 @@ Inherited by TQCheckBox, TQPushButton, TQRadioButton, and TQToolButton. .BI "bool \fBisExclusiveToggle\fR () const" .br .ti -1c -.BI "QButtonGroup * \fBgroup\fR () const" +.BI "TQButtonGroup * \fBgroup\fR () const" .br .in -1c .SS "Public Slots" @@ -166,17 +166,17 @@ Inherited by TQCheckBox, TQPushButton, TQRadioButton, and TQToolButton. .br .in -1c .SH DESCRIPTION -The QButton class is the abstract base class of button widgets, providing functionality common to buttons. +The TQButton class is the abstract base class of button widgets, providing functionality common to buttons. .PP \fBIf you want to create a button use TQPushButton.\fR .PP -The QButton class implements an \fIabstract\fR button, and lets subclasses specify how to reply to user actions and how to draw the button. +The TQButton class implements an \fIabstract\fR button, and lets subclasses specify how to reply to user actions and how to draw the button. .PP -QButton provides both push and toggle buttons. The TQRadioButton and TQCheckBox classes provide only toggle buttons; TQPushButton and TQToolButton provide both toggle and push buttons. +TQButton provides both push and toggle buttons. The TQRadioButton and TQCheckBox classes provide only toggle buttons; TQPushButton and TQToolButton provide both toggle and push buttons. .PP Any button can have either a text or pixmap label. setText() sets the button to be a text button and setPixmap() sets it to be a pixmap button. The text/pixmap is manipulated as necessary to create the "disabled" appearance when the button is disabled. .PP -QButton provides most of the states used for buttons: +TQButton provides most of the states used for buttons: .TP isDown() indicates whether the button is \fIpressed\fR down. .TP @@ -192,7 +192,7 @@ The difference between isDown() and isOn() is as follows: When the user clicks a .PP Default buttons (as used in many dialogs) are provided by TQPushButton::setDefault() and TQPushButton::setAutoDefault(). .PP -QButton provides five signals: <ol type=1> +TQButton provides five signals: <ol type=1> .TP pressed() is emitted when the button is pressed. E.g. with the mouse or when animateClick() is called. .TP @@ -204,7 +204,7 @@ toggled(bool) is emitted when the state of a toggle button changes. .TP stateChanged(int) is emitted when the state of a tristate toggle button changes. .PP -If the button is a text button with an ampersand (&) in its text, QButton creates an automatic accelerator key. This code creates a push button labelled "Ro<u>c</u>k & Roll" (where the c is underlined). The button gets an automatic accelerator key, Alt+C: +If the button is a text button with an ampersand (&) in its text, TQButton creates an automatic accelerator key. This code creates a push button labelled "Ro<u>c</u>k & Roll" (where the c is underlined). The button gets an automatic accelerator key, Alt+C: .PP .nf .br @@ -226,38 +226,38 @@ You can also set a custom accelerator using the setAccel() function. This is use .PP All of the buttons provided by TQt (TQPushButton, TQToolButton, TQCheckBox and TQRadioButton) can display both text and pixmaps. .PP -To subclass QButton, you must reimplement at least drawButton() (to draw the button's outline) and drawButtonLabel() (to draw its text or pixmap). It is generally advisable to reimplement sizeHint() as well, and sometimes hitButton() (to determine whether a button press is within the button). +To subclass TQButton, you must reimplement at least drawButton() (to draw the button's outline) and drawButtonLabel() (to draw its text or pixmap). It is generally advisable to reimplement sizeHint() as well, and sometimes hitButton() (to determine whether a button press is within the button). .PP -To reduce flickering, QButton::paintEvent() sets up a pixmap that the drawButton() function draws in. You should not reimplement paintEvent() for a subclass of QButton unless you want to take over all drawing. +To reduce flickering, TQButton::paintEvent() sets up a pixmap that the drawButton() function draws in. You should not reimplement paintEvent() for a subclass of TQButton unless you want to take over all drawing. .PP -See also QButtonGroup and Abstract Widget Classes. +See also TQButtonGroup and Abstract Widget Classes. .SS "Member Type Documentation" -.SH "QButton::ToggleState" +.SH "TQButton::ToggleState" This enum defines the state of a toggle button. .TP -\fCQButton::Off\fR - the button is in the "off" state +\fCTQButton::Off\fR - the button is in the "off" state .TP -\fCQButton::NoChange\fR - the button is in the default/unchanged state +\fCTQButton::NoChange\fR - the button is in the default/unchanged state .TP -\fCQButton::On\fR - the button is in the "on" state -.SH "QButton::ToggleType" +\fCTQButton::On\fR - the button is in the "on" state +.SH "TQButton::ToggleType" This enum type defines what a button can do in response to a mouse/keyboard press: .TP -\fCQButton::SingleShot\fR - pressing the button causes an action, then the button returns to the unpressed state. +\fCTQButton::SingleShot\fR - pressing the button causes an action, then the button returns to the unpressed state. .TP -\fCQButton::Toggle\fR - pressing the button toggles it between an On and an Off state. +\fCTQButton::Toggle\fR - pressing the button toggles it between an On and an Off state. .TP -\fCQButton::Tristate\fR - pressing the button cycles between the three states On, Off and NoChange +\fCTQButton::Tristate\fR - pressing the button cycles between the three states On, Off and NoChange .SH MEMBER FUNCTION DOCUMENTATION -.SH "QButton::QButton ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.SH "TQButton::TQButton ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" Constructs a standard button called \fIname\fR with parent \fIparent\fR, using the widget flags \fIf\fR. .PP -If \fIparent\fR is a QButtonGroup, this constructor calls QButtonGroup::insert(). -.SH "QButton::~QButton ()" +If \fIparent\fR is a TQButtonGroup, this constructor calls TQButtonGroup::insert(). +.SH "TQButton::~TQButton ()" Destroys the button. -.SH "QKeySequence QButton::accel () const" +.SH "QKeySequence TQButton::accel () const" Returns the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::animateClick ()\fC [slot]\fR" +.SH "void TQButton::animateClick ()\fC [slot]\fR" Performs an animated click: the button is pressed and released a short while later. .PP The pressed(), released(), clicked(), toggled(), and stateChanged() signals are emitted as appropriate. @@ -265,12 +265,12 @@ The pressed(), released(), clicked(), toggled(), and stateChanged() signals are This function does nothing if the button is disabled. .PP See also accel. -.SH "bool QButton::autoRepeat () const" +.SH "bool TQButton::autoRepeat () const" Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details. -.SH "void QButton::clicked ()\fC [signal]\fR" +.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 QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot. +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 @@ -278,96 +278,96 @@ 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 "void QButton::drawButton ( TQPainter * )\fC [virtual protected]\fR" +.SH "void TQButton::drawButton ( TQPainter * )\fC [virtual protected]\fR" Draws the button. The default implementation does nothing. .PP This virtual function is reimplemented by subclasses to draw real buttons. At some point, these reimplementations should call drawButtonLabel(). .PP See also drawButtonLabel() and paintEvent(). -.SH "void QButton::drawButtonLabel ( TQPainter * )\fC [virtual protected]\fR" +.SH "void TQButton::drawButtonLabel ( TQPainter * )\fC [virtual protected]\fR" Draws the button text or pixmap. .PP This virtual function is reimplemented by subclasses to draw real buttons. It is invoked by drawButton(). .PP See also drawButton() and paintEvent(). -.SH "QButtonGroup * QButton::group () const" +.SH "TQButtonGroup * TQButton::group () const" Returns the group that this button belongs to. .PP -If the button is not a member of any QButtonGroup, this function returns 0. +If the button is not a member of any TQButtonGroup, this function returns 0. .PP -See also QButtonGroup. -.SH "bool QButton::hitButton ( const TQPoint & pos ) const\fC [virtual protected]\fR" +See also TQButtonGroup. +.SH "bool TQButton::hitButton ( const TQPoint & pos ) const\fC [virtual protected]\fR" Returns TRUE if \fIpos\fR is inside the clickable button rectangle; otherwise returns FALSE. .PP By default, the clickable area is the entire widget. Subclasses may reimplement it, though. -.SH "bool QButton::isDown () const" +.SH "bool TQButton::isDown () const" Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details. -.SH "bool QButton::isExclusiveToggle () const" +.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 QButton::isOn () const" +.SH "bool TQButton::isOn () const" Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details. -.SH "bool QButton::isToggleButton () const" +.SH "bool TQButton::isToggleButton () const" Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details. -.SH "void QButton::paintEvent ( TQPaintEvent * )\fC [virtual protected]\fR" +.SH "void TQButton::paintEvent ( TQPaintEvent * )\fC [virtual protected]\fR" Handles paint events for buttons. Small and typically complex buttons are painted double-buffered to reduce flicker. The actually drawing is done in the virtual functions drawButton() and drawButtonLabel(). .PP See also drawButton() and drawButtonLabel(). .PP Reimplemented from TQWidget. -.SH "const TQPixmap * QButton::pixmap () const" +.SH "const TQPixmap * TQButton::pixmap () const" Returns the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::pressed ()\fC [signal]\fR" +.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 QButton::released ()\fC [signal]\fR" +.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 QButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" +.SH "void TQButton::setAccel ( const QKeySequence & )\fC [virtual]\fR" Sets the accelerator associated with the button. See the "accel" property for details. -.SH "void QButton::setAutoRepeat ( bool )\fC [virtual]\fR" +.SH "void TQButton::setAutoRepeat ( bool )\fC [virtual]\fR" Sets whether autoRepeat is enabled. See the "autoRepeat" property for details. -.SH "void QButton::setDown ( bool )\fC [virtual]\fR" +.SH "void TQButton::setDown ( bool )\fC [virtual]\fR" Sets whether the button is pressed. See the "down" property for details. -.SH "void QButton::setOn ( bool on )\fC [protected]\fR" +.SH "void TQButton::setOn ( bool on )\fC [protected]\fR" Sets the state of this button to On if \fIon\fR is TRUE; otherwise to Off. .PP See also toggleState. -.SH "void QButton::setPixmap ( const TQPixmap & )\fC [virtual]\fR" +.SH "void TQButton::setPixmap ( const TQPixmap & )\fC [virtual]\fR" Sets the pixmap shown on the button. See the "pixmap" property for details. -.SH "void QButton::setState ( ToggleState s )\fC [virtual protected]\fR" +.SH "void TQButton::setState ( ToggleState s )\fC [virtual protected]\fR" Sets the toggle state of the button to \fIs\fR. \fIs\fR can be Off, NoChange or On. -.SH "void QButton::setText ( const TQString & )\fC [virtual]\fR" +.SH "void TQButton::setText ( const TQString & )\fC [virtual]\fR" Sets the text shown on the button. See the "text" property for details. -.SH "void QButton::setToggleButton ( bool b )\fC [protected]\fR" +.SH "void TQButton::setToggleButton ( bool b )\fC [protected]\fR" If \fIb\fR is TRUE, this button becomes a toggle button; if \fIb\fR is FALSE, this button becomes a command button. .PP See also toggleButton. -.SH "void QButton::setToggleType ( ToggleType type )\fC [virtual protected]\fR" +.SH "void TQButton::setToggleType ( ToggleType type )\fC [virtual protected]\fR" Sets the toggle type of the button to \fItype\fR. .PP \fItype\fR can be set to SingleShot, Toggle and Tristate. -.SH "ToggleState QButton::state () const" +.SH "ToggleState TQButton::state () const" Returns the state of the toggle button. See the "toggleState" property for details. -.SH "void QButton::stateChanged ( int state )\fC [signal]\fR" +.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 QButton::ToggleState. -.SH "TQString QButton::text () const" +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 QButton::toggle ()\fC [slot]\fR" +.SH "void TQButton::toggle ()\fC [slot]\fR" Toggles the state of a toggle button. .PP See also on, setOn(), toggled(), and toggleButton. -.SH "ToggleType QButton::toggleType () const" +.SH "ToggleType TQButton::toggleType () const" Returns the type of toggle on the button. See the "toggleType" property for details. -.SH "void QButton::toggled ( bool on )\fC [signal]\fR" +.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. @@ -397,7 +397,7 @@ Set this property's value with setDown() and get this property's value with isDo .SH "bool exclusiveToggle" This property holds whether the button is an exclusive toggle. .PP -If this property is TRUE and the button is in a QButtonGroup, the button can only be toggled off by another one being toggled on. The default is FALSE. +If this property is TRUE and the button is in a TQButtonGroup, the button can only be toggled off by another one being toggled on. The default is FALSE. .PP Get this property's value with isExclusiveToggle(). .SH "bool on" @@ -439,12 +439,12 @@ This property holds the type of toggle on the button. .PP The default toggle type is SingleShot. .PP -See also QButton::ToggleType. +See also TQButton::ToggleType. .PP Get this property's value with toggleType(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqbutton.html +.BR http://doc.trolltech.com/tqbutton.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |