|  | Home · All Classes · Modules

# QAbstractButton Class Reference
[QtGui module]

The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons. More...

Inherits QWidget.

Inherited by QCheckBox, QPushButton, QRadioButton and QToolButton.

### Methods

- __init__ (self, QWidget parent = None)
- animateClick (self, int msecs = 100)
- bool autoExclusive (self)
- bool autoRepeat (self)
- int autoRepeatDelay (self)
- int autoRepeatInterval (self)
- changeEvent (self, QEvent e)
- checkStateSet (self)
- click (self)
- bool event (self, QEvent e)
- focusInEvent (self, QFocusEvent e)
- focusOutEvent (self, QFocusEvent e)
- QButtonGroup group (self)
- bool hitButton (self, QPoint pos)
- QIcon icon (self)
- QSize iconSize (self)
- bool isCheckable (self)
- bool isChecked (self)
- bool isDown (self)
- keyPressEvent (self, QKeyEvent e)
- keyReleaseEvent (self, QKeyEvent e)
- mouseMoveEvent (self, QMouseEvent e)
- mousePressEvent (self, QMouseEvent e)
- mouseReleaseEvent (self, QMouseEvent e)
- nextCheckState (self)
- paintEvent (self, QPaintEvent e)
- setAutoExclusive (self, bool)
- setAutoRepeat (self, bool)
- setAutoRepeatDelay (self, int)
- setAutoRepeatInterval (self, int)
- setCheckable (self, bool)
- setChecked (self, bool)
- setDown (self, bool)
- setIcon (self, QIcon icon)
- setIconSize (self, QSize size)
- setShortcut (self, QKeySequence key)
- setText (self, QString text)
- QKeySequence shortcut (self)
- QString text (self)
- timerEvent (self, QTimerEvent e)
- toggle (self)

### Qt Signals

- void clicked (bool = 0)
- void pressed ()
- void released ()
- void toggled (bool)

## Detailed Description

The QAbstractButton class is the abstract base class of button widgets, providing functionality common to buttons.

This class implements an abstract button. Subclasses of this class handle user actions, and specify how the button is drawn.

QAbstractButton provides support for both push buttons and checkable (toggle) buttons. Checkable buttons are implemented in the QRadioButton and QCheckBox classes. Push buttons are implemented in the QPushButton and QToolButton classes; these also provide toggle behavior if required.

Any button can display a label containing text and an icon. setText() sets the text; setIcon() sets the icon. If a button is disabled, its label is changed to give the button a "disabled" appearance.

If the button is a text button with a string containing an ampersand ('&'), QAbstractButton automatically creates a shortcut key. For example:

     QPushButton *button = new QPushButton(tr("Ro&ck && Roll"), this);

The Alt+C shortcut is assigned to the button, i.e., when the user presses Alt+C the button will call animateClick(). See the QShortcut documentation for details (to display an actual ampersand, use '&&').

You can also set a custom shortcut key using the setShortcut() function. This is useful mostly for buttons that do not have any text, because they have no automatic shortcut.

     button->setIcon(QIcon(":/images/print.png"));
     button->setShortcut(tr("Alt+F7"));

All of the buttons provided by Qt (QPushButton, QToolButton, QCheckBox, and QRadioButton) can display both text and icons.

A button can be made the default button in a dialog are provided by QPushButton.setDefault() and QPushButton.setAutoDefault().

QAbstractButton provides most of the states used for buttons:

- isDown() indicates whether the button is pressed down.
- isChecked() indicates whether the button is checked. Only checkable buttons can be checked and unchecked (see below).
- isEnabled() indicates whether the button can be pressed by the user. Note: As opposed to other widgets, buttons derived from QAbstractButton accepts mouse and context menu events when disabled.
- setAutoRepeat() sets whether the button will auto-repeat if the user holds it down. autoRepeatDelay and autoRepeatInterval define how auto-repetition is done.
- setCheckable() sets whether the button is a toggle button or not.

The difference between isDown() and isChecked() is as follows. When the user clicks a toggle button to check it, the button is first pressed then released into the checked state. When the user clicks it again (to uncheck it), the button moves first to the pressed state, then to the unchecked state (isChecked() and isDown() are both false).

QAbstractButton provides four signals:

1. pressed() is emitted when the left mouse button is pressed while the mouse cursor is inside the button.
2. released() is emitted when the left mouse button is released.
3. clicked() is emitted when the button is first pressed and then released, when the shortcut key is typed, or when click() or animateClick() is called.
4. toggled() is emitted when the state of a toggle button changes.

To subclass QAbstractButton, you must reimplement at least paintEvent() to draw the button's outline and 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). For buttons with more than two states (like tri-state buttons), you will also have to reimplement checkStateSet() and nextCheckState().

## Method Documentation

### QAbstractButton.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an abstract button with a parent.

### QAbstractButton.animateClick (self, int msecs = 100)

This method is also a Qt slot with the C++ signature `void animateClick(int = 100)`.

Performs an animated click: the button is pressed immediately, and released msec milliseconds later (the default is 100 ms).

Calling this function again before the button was released will reset the release timer.

All signals associated with a click are emitted as appropriate.

This function does nothing if the button is disabled.

See also click().

### bool QAbstractButton.autoExclusive (self)

### bool QAbstractButton.autoRepeat (self)

### int QAbstractButton.autoRepeatDelay (self)

### int QAbstractButton.autoRepeatInterval (self)

### QAbstractButton.changeEvent (self, QEvent e)

Reimplemented from QWidget.changeEvent().

### QAbstractButton.checkStateSet (self)

This virtual handler is called when setChecked() was called, unless it was called from within nextCheckState(). It allows subclasses to reset their intermediate button states.

See also nextCheckState().

### QAbstractButton.click (self)

This method is also a Qt slot with the C++ signature `void click()`.

Performs a click.

All the usual signals associated with a click are emitted as appropriate. If the button is checkable, the state of the button is toggled.

This function does nothing if the button is disabled.

See also animateClick().

### bool QAbstractButton.event (self, QEvent e)

Reimplemented from QObject.event().

### QAbstractButton.focusInEvent (self, QFocusEvent e)

Reimplemented from QWidget.focusInEvent().

### QAbstractButton.focusOutEvent (self, QFocusEvent e)

Reimplemented from QWidget.focusOutEvent().

### QButtonGroup QAbstractButton.group (self)

Returns the group that this button belongs to.

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

See also QButtonGroup.

### bool QAbstractButton.hitButton (self, QPoint pos)

Returns true if pos is inside the clickable button rectangle; otherwise returns false.

By default, the clickable area is the entire widget. Subclasses may reimplement this function to provide support for clickable areas of different shapes and sizes.

### QIcon QAbstractButton.icon (self)

### QSize QAbstractButton.iconSize (self)

### bool QAbstractButton.isCheckable (self)

### bool QAbstractButton.isChecked (self)

### bool QAbstractButton.isDown (self)

### QAbstractButton.keyPressEvent (self, QKeyEvent e)

Reimplemented from QWidget.keyPressEvent().

### QAbstractButton.keyReleaseEvent (self, QKeyEvent e)

Reimplemented from QWidget.keyReleaseEvent().

### QAbstractButton.mouseMoveEvent (self, QMouseEvent e)

Reimplemented from QWidget.mouseMoveEvent().

### QAbstractButton.mousePressEvent (self, QMouseEvent e)

Reimplemented from QWidget.mousePressEvent().

### QAbstractButton.mouseReleaseEvent (self, QMouseEvent e)

Reimplemented from QWidget.mouseReleaseEvent().

### QAbstractButton.nextCheckState (self)

This virtual handler is called when a button is clicked. The default implementation calls setChecked(!isChecked()) if the button isCheckable(). It allows subclasses to implement intermediate button states.

See also checkStateSet().

### QAbstractButton.paintEvent (self, QPaintEvent e)

This method is abstract and should be reimplemented in any sub-class.

Reimplemented from QWidget.paintEvent().

### QAbstractButton.setAutoExclusive (self, bool)

### QAbstractButton.setAutoRepeat (self, bool)

### QAbstractButton.setAutoRepeatDelay (self, int)

### QAbstractButton.setAutoRepeatInterval (self, int)

### QAbstractButton.setCheckable (self, bool)

### QAbstractButton.setChecked (self, bool)

This method is also a Qt slot with the C++ signature `void setChecked(bool)`.

### QAbstractButton.setDown (self, bool)

### QAbstractButton.setIcon (self, QIcon icon)

### QAbstractButton.setIconSize (self, QSize size)

This method is also a Qt slot with the C++ signature `void setIconSize(const QSize&)`.

### QAbstractButton.setShortcut (self, QKeySequence key)

### QAbstractButton.setText (self, QString text)

### QKeySequence QAbstractButton.shortcut (self)

### QString QAbstractButton.text (self)

### QAbstractButton.timerEvent (self, QTimerEvent e)

Reimplemented from QObject.timerEvent().

### QAbstractButton.toggle (self)

This method is also a Qt slot with the C++ signature `void toggle()`.

Toggles the state of a checkable button.

See also checked.

## Qt Signal Documentation

### void clicked (bool = 0)

This is the default overload of this signal.

This signal is emitted when the button is activated (i.e. pressed down then released while the mouse cursor is inside the button), when the shortcut key is typed, or when click() or animateClick() is called. Notably, this signal is not emitted if you call setDown(), setChecked() or toggle().

If the button is checkable, checked is true if the button is checked, or false if the button is unchecked.

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

### void pressed ()

This is the default overload of this signal.

This signal is emitted when the button is pressed down.

See also released() and clicked().

### void released ()

This is the default overload of this signal.

This signal is emitted when the button is released.

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

### void toggled (bool)

This is the default overload of this signal.

This signal is emitted whenever a checkable button changes its state. checked is true if the button is checked, or false if the button is unchecked.

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

The states of buttons in exclusive button groups are updated before this signal is emitted. This means that slots can act on either the "off" signal or the "on" signal emitted by the buttons in the group whose states have changed.

For example, a slot that reacts to signals emitted by newly checked buttons but which ignores signals from buttons that have been unchecked can be implemented using the following pattern:

     void MyWidget.reactToToggle(bool checked)
     {
        if (checked) {
           // Examine the new button states.
           ...
        }
     }

Button groups can be created using the QButtonGroup class, and updates to the button states monitored with the QButtonGroup.buttonClicked() signal.

See also checked and clicked().