QPushButton(3qt)

NAME
QPushButton - Command button

SYNOPSIS
#include <qpushbutton.h>

Inherits QButton.

  Public Members
QPushButton ( QWidget * parent, const char * name = 0 )
QPushButton ( const QString & text, QWidget * parent, const char * name = 0 )
QPushButton ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )
~QPushButton ()
void setToggleButton ( bool )
bool autoDefault () const
virtual void setAutoDefault ( bool autoDef )
bool isDefault () const
virtual void setDefault ( bool def )
virtual void setIsMenuButton ( bool enable ) (obsolete)
bool isMenuButton () const (obsolete)
void setPopup ( QPopupMenu * popup )
QPopupMenu * popup () const
void setIconSet ( const QIconSet & )
QIconSet * iconSet () const
void setFlat ( bool )
bool isFlat () const

  Public Slots
virtual void setOn ( bool )

  Important Inherited Members
QString text () const
virtual void setText ( const QString & )
const QPixmap * pixmap () const
virtual void setPixmap ( const QPixmap & )
QKeySequence accel () const
virtual void setAccel ( const QKeySequence & )
bool isToggleButton () const
virtual void setDown ( bool )
bool isDown () const
bool isOn () const
ToggleState state () const
bool autoRepeat () const
virtual void setAutoRepeat ( bool )
bool isExclusiveToggle () const
QButtonGroup * group () const
void toggle ()
void pressed ()
void released ()
void clicked ()
void toggled ( bool on )
void stateChanged ( int state )

  Properties
bool autoDefault - whether the push button is the auto default button
bool autoMask - whether the button is automatically masked (read only)
bool default - whether the push button is the default button
bool flat - whether the border is disabled
QIconSet iconSet - the icon set on the push button
bool menuButton - whether the push button has a menu button on it (read only) (obsolete)
bool on - whether the push button is toggled
bool toggleButton - whether the button is a toggle button

DESCRIPTION
The QPushButton widget provides a command button.

The push button, or command button, is perhaps the most commonly used widget in any graphical user interface. Push (click) a button to command the computer to perform some action, or to answer a question. Typical buttons are OK, Apply, Cancel, Close, Yes, No and Help.

A command button is rectangular and typically displays a text label describing its action. An underscored character in the label (signified by preceding it with an ampersand in the text) indicates an accelerator key, e.g.

    QPushButton *pb = new QPushButton( "&Download", this );
In this example the accelerator is Alt+D, and the label text will be displayed as <u>D</u>ownload.

Push buttons can display a textual label or a pixmap, and optionally a small icon. These can be set using the constructors and changed later using setText(), setPixmap() and setIconSet(). If the button is disabled the appearance of the text or pixmap and iconset will be manipulated with respect to the GUI style to make the button look "disabled".

A push button emits the signal clicked() when it is activated by the mouse, the Spacebar or by a keyboard accelerator. Connect to this signal to perform the button's action. Push buttons also provide less commonly used signals, for example, pressed() and released().

Command buttons in dialogs are by default auto-default buttons, i.e. they become the default push button automatically when they receive the keyboard input focus. A default button is a push button that is activated when the user hits the Enter or Return key in a dialog. You can change this with setAutoDefault(). Note that auto-default buttons reserve a little extra space which is necessary to draw a default-button indicator. If you do not want this space around your buttons, call setAutoDefault(FALSE).

Being so central, the button widget has grown to accommodate a great many variations in the past decade. The Microsoft style guide now shows about ten different states of Windows push buttons and the text implies that there are dozens more when all the combinations of features are taken into consideration.

The most important modes or states are:

Available or not (grayed out, disabled).

Standard push button, toggling push button or menu button.

On or off (only for toggling push buttons).

Default or normal. The default button in a dialog can generally be "clicked" using the Enter or Return key.

Auto-repeat or not.

Pressed down or not.

As a general rule, use a push button when the application or dialog window performs an action when the user clicks on it (such as Apply, Cancel, Close and Help) and when the widget is supposed to have a wide, rectangular shape with a text label. Small, typically square buttons that change the state of the window rather than performing an action (such as the buttons in the top-right corner of the QFileDialog) are not command buttons, but tool buttons. Qt provides a special class (QToolButton) for these buttons.

If you need toggle behavior (see setToggleButton()) or a button that auto-repeats the activation signal when being pushed down like the arrows in a scroll bar (see setAutoRepeat()), a command button is probably not what you want. When in doubt, use a tool button.

A variation of a command button is a menu button. These provide not just one command, but several, since when they are clicked they pop up a menu of options. Use the method setPopup() to associate a popup menu with a push button.

Other classes of buttons are option buttons (see QRadioButton) and check boxes (see QCheckBox).

[Image Omitted]

[Image Omitted]

In Qt, the QButton base class provides most of the modes and other API, and QPushButton provides GUI logic. See QButton for more information about the API.

See also QToolButton, QRadioButton, QCheckBox, GUI Design Handbook: Push Button and Basic Widgets.

MEMBER FUNCTION DOCUMENTATION

QPushButton::QPushButton ( QWidget * parent, const char * name = 0 )
Constructs a push button with no text.

The parent and name arguments are sent to the QWidget constructor.

QPushButton::QPushButton ( const QString & text, QWidget * parent, const char * name = 0 )
Constructs a push button called name with the parent parent and the text text.

QPushButton::QPushButton ( const QIconSet & icon, const QString & text, QWidget * parent, const char * name = 0 )
Constructs a push button with an icon and a text.

Note that you can also pass a QPixmap object as an icon (thanks to the implicit type conversion provided by C++).

The parent and name arguments are sent to the QWidget constructor.

QPushButton::~QPushButton ()
Destroys the push button

QKeySequence QButton::accel () const
Returns the accelerator associated with the button. See the "accel" property for details.

bool QPushButton::autoDefault () const
Returns TRUE if the push button is the auto default button; otherwise returns FALSE. See the "autoDefault" property for details.

bool QButton::autoRepeat () const
Returns TRUE if autoRepeat is enabled; otherwise returns FALSE. See the "autoRepeat" property for details.

void QButton::clicked () [signal]
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.

The QButtonGroup::clicked() signal does the same job, if you want to connect several buttons to the same slot.

See also pressed(), released() and toggled().

Examples:

QButtonGroup * QButton::group () const
Returns a pointer to the group of which this button is a member.

If the button is not a member of any QButtonGroup, this function returns 0.

See also QButtonGroup.

QIconSet * QPushButton::iconSet () const
Returns the icon set on the push button. See the "iconSet" property for details.

bool QPushButton::isDefault () const
Returns TRUE if the push button is the default button; otherwise returns FALSE. See the "default" property for details.

bool QButton::isDown () const
Returns TRUE if the button is pressed; otherwise returns FALSE. See the "down" property for details.

bool QButton::isExclusiveToggle () const
Returns TRUE if the button is an exclusive toggle; otherwise returns FALSE. See the "exclusiveToggle" property for details.

bool QPushButton::isFlat () const
Returns TRUE if the border is disabled; otherwise returns FALSE. See the "flat" property for details.

bool QPushButton::isMenuButton () const
Returns TRUE if the push button has a menu button on it; otherwise returns FALSE. See the "menuButton" property for details.

bool QButton::isOn () const
Returns TRUE if the button is toggled; otherwise returns FALSE. See the "on" property for details.

bool QButton::isToggleButton () const
Returns TRUE if the button is a toggle button; otherwise returns FALSE. See the "toggleButton" property for details.

const QPixmap * QButton::pixmap () const
Returns the pixmap shown on the button. See the "pixmap" property for details.

QPopupMenu * QPushButton::popup () const
Returns the button's associated popup menu or 0 if no popup menu has been defined.

See also setPopup().

void QButton::pressed () [signal]
This signal is emitted when the button is pressed down.

See also released() and clicked().

Examples:

void QButton::released () [signal]
This signal is emitted when the button is released.

See also pressed(), clicked() and toggled().

void QButton::setAccel ( const QKeySequence & ) [virtual]
Sets the accelerator associated with the button. See the "accel" property for details.

void QPushButton::setAutoDefault ( bool autoDef ) [virtual]
Sets whether the push button is the auto default button to autoDef. See the "autoDefault" property for details.

void QButton::setAutoRepeat ( bool ) [virtual]
Sets whether autoRepeat is enabled. See the "autoRepeat" property for details.

void QPushButton::setDefault ( bool def ) [virtual]
Sets whether the push button is the default button to def. See the "default" property for details.

void QButton::setDown ( bool ) [virtual]
Sets whether the button is pressed. See the "down" property for details.

void QPushButton::setFlat ( bool )
Sets whether the border is disabled. See the "flat" property for details.

void QPushButton::setIconSet ( const QIconSet & )
Sets the icon set on the push button. See the "iconSet" property for details.

void QPushButton::setIsMenuButton ( bool enable ) [virtual]
This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

void QPushButton::setOn ( bool ) [virtual slot]
Sets whether the push button is toggled. See the "on" property for details.

void QButton::setPixmap ( const QPixmap & ) [virtual]
Sets the pixmap shown on the button. See the "pixmap" property for details.

void QPushButton::setPopup ( QPopupMenu * popup )
Associates the popup menu popup with this push button and thus turns it into a menu button.

Ownership of the popup menu is not transferred to the push button.

See also popup().

Example: qdir/qdir.cpp.

void QButton::setText ( const QString & ) [virtual]
Sets the text shown on the button. See the "text" property for details.

void QPushButton::setToggleButton ( bool )
Sets whether the button is a toggle button. See the "toggleButton" property for details.

ToggleState QButton::state () const
Returns TRUE if the button is toggled; otherwise returns FALSE. See the "toggleState" property for details.

void QButton::stateChanged ( int state ) [signal]
This signal is emitted whenever a toggle button changes status. state is 2 if the button is on, 1 if it is in the" no change" state or 0 if the button is off.

This may be the result of a user action, toggle() slot activation, setState(), or because setOn() was called.

See also clicked().

QString QButton::text () const
Returns the text shown on the button. See the "text" property for details.

void QButton::toggle () [slot]
Toggles the state of a toggle button.

See also on, on, toggled() and toggleButton.

void QButton::toggled ( bool on ) [signal]
This signal is emitted whenever a toggle button changes status. on is TRUE if the button is on, or FALSE if the button is off.

This may be the result of a user action, toggle() slot activation, or because setOn() was called.

See also clicked().

Example: listbox/listbox.cpp.

  Property Documentation

QKeySequence accel
This property holds the accelerator associated with the button.

This property is 0 if there is no accelerator set. If you set this property to 0 then any current accelerator is removed.

Set this property's value with setAccel() and get this property's value with accel().

bool autoDefault
This property holds whether the push button is the auto default button.

If this property is set to TRUE then the push button is the auto default button in a dialog.

An auto-default button automatically becomes the default push button in a dialog when it receives the keyboard input focus.

In some GUI styles a default button is drawn with an extra frame around it, up to 3 pixels or more. Qt automatically keeps this space free around auto-default buttons, i.e., auto-default buttons may have a slightly larger size hint.

This property's default is TRUE for buttons that have a QDialog parent, else FALSE.

Set this property's value with setAutoDefault() and get this property's value with autoDefault().

bool autoMask
This property holds whether the button is automatically masked.

See also QWidget::autoMask.

bool autoRepeat
This property holds whether autoRepeat is enabled.

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.

Set this property's value with setAutoRepeat() and get this property's value with autoRepeat().

bool default
This property holds whether the push button is the default button.

If this property is set to TRUE then the push button will be pressed if the user hits the Enter key in a dialog.

The current default button gets clicked when the user presses the Enter key, independently of which widget in the dialog currently has the keyboard input focus. Only one push button can at any time be the default button. This button is then displayed with an additional frame (depending on the GUI style).

The default button behavior is provided only in dialogs. Buttons can always be clicked from the keyboard by pressing Return or the spacebar when the button has focus.

This property's default is FALSE.

Set this property's value with setDefault() and get this property's value with isDefault().

bool flat
This property holds whether the border is disabled.

This property's default is FALSE.

Set this property's value with setFlat() and get this property's value with isFlat().

QIconSet iconSet
This property holds the icon set on the push button.

This property will return 0 if the push button has no iconset

Set this property's value with setIconSet() and get this property's value with iconSet().

bool menuButton
This property holds whether the push button has a menu button on it.

This property is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

If this property is set to TRUE, then a down arrow is drawn on the push button to indicate that a menu will pop up if the user clicks on the arrow.

Get this property's value with isMenuButton().

bool on
This property holds whether the push button is toggled.

This property should only be set for toggle push buttons. The default value is FALSE.

See also on, toggle(), toggled() and toggleButton.

Set this property's value with setOn().

QPixmap pixmap
This property holds the pixmap shown on the button.

If the pixmap is monochrome (i.e., it is a QBitmap 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.

pixmap() returns 0 if no pixmap was set.

Set this property's value with setPixmap() and get this property's value with pixmap().

QString text
This property holds the text shown on the button.

This property will return a null string 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 after the '&' as the accelerator key.

There is no default text.

Set this property's value with setText() and get this property's value with text().

bool toggleButton
This property holds whether the button is a toggle button.

Toggle buttons have an on/off state similar to check boxes. A push button is initially not a toggle button.

See also on, toggle(), toggleButton and toggled().

Set this property's value with setToggleButton().

SEE ALSO
http://doc.trolltech.com/qpushbutton.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt 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.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qpushbutton.3qt) and the Qt version (3.0.3).