Qt Reference Documentation

QPushButton Class Reference

The QPushButton widget provides a command button. More...

 #include <QPushButton>

Inherits: QAbstractButton.

Inherited by: QCommandLinkButton.


Public Functions

QPushButton ( QWidget * parent = 0 )
QPushButton ( const QString & text, QWidget * parent = 0 )
QPushButton ( const QIcon & icon, const QString & text, QWidget * parent = 0 )
~QPushButton ()
bool autoDefault () const
bool isDefault () const
bool isFlat () const
QMenu * menu () const
void setAutoDefault ( bool )
void setDefault ( bool )
void setFlat ( bool )
void setMenu ( QMenu * menu )

Reimplemented Public Functions

virtual QSize minimumSizeHint () const
virtual QSize sizeHint () const

Public Slots

void showMenu ()

Protected Functions

void initStyleOption ( QStyleOptionButton * option ) const

Reimplemented Protected Functions

virtual bool event ( QEvent * e )
virtual void focusInEvent ( QFocusEvent * e )
virtual void focusOutEvent ( QFocusEvent * e )
virtual bool hitButton ( const QPoint & pos ) const
virtual void keyPressEvent ( QKeyEvent * e )
virtual void paintEvent ( QPaintEvent * )

Additional Inherited Members

Detailed 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. A shortcut key can be specified by preceding the preferred character with an ampersand in the text. For example:

 QPushButton *button = new QPushButton("&Download", this);

In this example the shortcut is Alt+D. See the QShortcut documentation for details (to display an actual ampersand, use '&&').

Push buttons display a textual label, and optionally a small icon. These can be set using the constructors and changed later using setText() and setIcon(). If the button is disabled the appearance of the text and icon 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 shortcut. 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 presses 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 setCheckable()) 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 setMenu() to associate a popup menu with a push button.

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

Screenshot of a Macintosh style push buttonA push button shown in the Macintosh widget style.

Note that when a button's width becomes smaller than 50 or its height becomes smaller than 30, the button's corners are changed from round to square. Use the setMinimumSize() function to prevent this behavior.

Screenshot of a Windows XP style push buttonA push button shown in the Windows XP widget style.
Screenshot of a Plastique style push buttonA push button shown in the Plastique widget style.

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

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

Property Documentation

autoDefault : bool

This property holds whether the push button is an auto default button.

If this property is set to true then the push button is an auto default button.

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; otherwise it defaults to false.

See the default property for details of how default and auto-default interact.

Access functions:

bool autoDefault () const
void setAutoDefault ( bool )

default : bool

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

Default and autodefault buttons decide what happens when the user presses enter in a dialog.

A button with this property set to true (i.e., the dialog's default button,) will automatically be pressed when the user presses enter, with one exception: if an autoDefault button currently has focus, the autoDefault button is pressed. When the dialog has autoDefault buttons but no default button, pressing enter will press either the autoDefault button that currently has focus, or if no button has focus, the next autoDefault button in the focus chain.

In a dialog, only one push button at a time can 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 Spacebar when the button has focus.

If the default property is set to false on the current default button while the dialog is visible, a new default will automatically be assigned the next time a pushbutton in the dialog receives focus.

This property's default is false.

Access functions:

bool isDefault () const
void setDefault ( bool )

flat : bool

This property holds whether the button border is raised.

This property's default is false. If this property is set, most styles will not paint the button background unless the button is being pressed. setAutoFillBackground() can be used to ensure that the background is filled using the QPalette::Button brush.

Access functions:

bool isFlat () const
void setFlat ( bool )

Member Function Documentation

QPushButton::QPushButton ( QWidget * parent = 0 )

Constructs a push button with no text and a parent.

QPushButton::QPushButton ( const QString & text, QWidget * parent = 0 )

Constructs a push button with the parent parent and the text text.

QPushButton::QPushButton ( const QIcon & icon, const QString & text, QWidget * parent = 0 )

Constructs a push button with an icon and a text, and a parent.

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

QPushButton::~QPushButton ()

Destroys the push button.

bool QPushButton::event ( QEvent * e ) [virtual protected]

Reimplemented from QObject::event().

void QPushButton::focusInEvent ( QFocusEvent * e ) [virtual protected]

Reimplemented from QWidget::focusInEvent().

void QPushButton::focusOutEvent ( QFocusEvent * e ) [virtual protected]

Reimplemented from QWidget::focusOutEvent().

bool QPushButton::hitButton ( const QPoint & pos ) const [virtual protected]

Reimplemented from QAbstractButton::hitButton().

void QPushButton::initStyleOption ( QStyleOptionButton * option ) const [protected]

Initialize option with the values from this QPushButton. This method is useful for subclasses when they need a QStyleOptionButton, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom().

void QPushButton::keyPressEvent ( QKeyEvent * e ) [virtual protected]

Reimplemented from QWidget::keyPressEvent().

QMenu * QPushButton::menu () const

Returns the button's associated popup menu or 0 if no popup menu has been set.

See also setMenu().

QSize QPushButton::minimumSizeHint () const [virtual]

Reimplemented from QWidget::minimumSizeHint().

void QPushButton::paintEvent ( QPaintEvent * ) [virtual protected]

Reimplemented from QWidget::paintEvent().

void QPushButton::setMenu ( QMenu * menu )

Associates the popup menu menu with this push button. This turns the button into a menu button, which in some styles will produce a small triangle to the right of the button's text.

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

Screenshot of a Plastique style push button with popup menu.Screenshot of a Cleanlooks style push button with popup menu.Push buttons with popup menus shown in the Plastique widget style (left) and Cleanlooks widget style (right).

See also menu().

void QPushButton::showMenu () [slot]

Shows (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user.

QSize QPushButton::sizeHint () const [virtual]

Reimplemented from QWidget::sizeHint().