QAbstractButton Class Reference

#include <qabstractbutton.h>

Inheritance diagram for QAbstractButton:

[legend]Collaboration diagram for QAbstractButton:

[legend]List of all members.

---

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::mnemonic}{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 {icon}{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.

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.

released() is emitted when the left mouse button is released.

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.

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().

See also:

QButtonGroup

Definition at line 38 of file qabstractbutton.h.

Public Slots
void	setIconSize (const QSize &size)
void	animateClick (int msec=100)
void	click ()
void	toggle ()
void	setChecked (bool)
Signals
void	pressed ()
void	released ()
void	clicked (bool checked=false)
void	toggled (bool checked)
Public Member Functions
	QAbstractButton (QWidget *parent=0)
	~QAbstractButton ()
void	setText (const QString &text)
QString	text () const
void	setIcon (const QIcon &icon)
QIcon	icon () const
QSize	iconSize () const
void	setShortcut (const QKeySequence &key)
QKeySequence	shortcut () const
void	setCheckable (bool)
bool	isCheckable () const
bool	isChecked () const
void	setDown (bool)
bool	isDown () const
void	setAutoRepeat (bool)
bool	autoRepeat () const
void	setAutoRepeatDelay (int)
int	autoRepeatDelay () const
void	setAutoRepeatInterval (int)
int	autoRepeatInterval () const
void	setAutoExclusive (bool)
bool	autoExclusive () const
QButtonGroup *	group () const
Protected Member Functions
virtual void	paintEvent (QPaintEvent *e)=0
virtual bool	hitButton (const QPoint &pos) const
virtual void	checkStateSet ()
virtual void	nextCheckState ()
bool	event (QEvent *e)
void	keyPressEvent (QKeyEvent *e)
void	keyReleaseEvent (QKeyEvent *e)
void	mousePressEvent (QMouseEvent *e)
void	mouseReleaseEvent (QMouseEvent *e)
void	mouseMoveEvent (QMouseEvent *e)
void	focusInEvent (QFocusEvent *e)
void	focusOutEvent (QFocusEvent *e)
void	changeEvent (QEvent *e)
void	timerEvent (QTimerEvent *e)
	QAbstractButton (QAbstractButtonPrivate &dd, QWidget *parent=0)
Friends
class	QButtonGroup

---

Constructor & Destructor Documentation

QAbstractButton::QAbstractButton

(

QWidget *

parent = 0

)

[explicit]

Constructs an abstract button with a parent.

Definition at line 555 of file qabstractbutton.cpp.

References d.

    :QWidget(*new QAbstractButtonPrivate, parent, 0)
{
    Q_D(QAbstractButton);
    d->init();
}

QAbstractButton::~QAbstractButton

(

)

Destroys the button.

Definition at line 565 of file qabstractbutton.cpp.

References d.

{
#ifndef QT_NO_BUTTONGROUP
    Q_D(QAbstractButton);
    if (d->group)
        d->group->removeButton(this);
#endif
}

QAbstractButton::QAbstractButton	(	QAbstractButtonPrivate &	dd,
		QWidget *	parent = 0
	)			[protected]

Definition at line 577 of file qabstractbutton.cpp.

References d.

    : QWidget(dd, parent, 0)
{
    Q_D(QAbstractButton);
    d->init();
}

---

Member Function Documentation

void QAbstractButton::setText

(

const QString &

text

)

Definition at line 601 of file qabstractbutton.cpp.

References d, QKeySequence::isEmpty(), QKeySequence::mnemonic(), QAccessible::NameChanged, setShortcut(), text(), QWidget::update(), QAccessible::updateAccessibility(), and QWidget::updateGeometry().

Referenced by QMessageBoxPrivate::_q_buttonClicked(), QCalendarWidgetPrivate::_q_monthChanged(), QCalendarWidgetPrivate::_q_yearEditingFinished(), Button::Button(), MainWindow::changeStyle(), CompositionWidget::CompositionWidget(), FtpWindow::connectOrDisconnect(), FindFileDialog::createButtons(), Q3CheckTableItem::createEditor(), GradientWidget::GradientWidget(), Main::Main(), qdesigner_internal::PaletteEditorButton::PaletteEditorButton(), PathDeformWidget::PathDeformWidget(), PathStrokeWidget::PathStrokeWidget(), Q3TabDialog::Q3TabDialog(), Q3Wizard::Q3Wizard(), QCheckBox::QCheckBox(), QPushButton::QPushButton(), QRadioButton::QRadioButton(), qdesigner_internal::Sentinel::Sentinel(), Q3TabDialog::setApplyButton(), Q3TabDialog::setCancelButton(), Q3ProgressDialog::setCancelButtonText(), QToolButton::setDefaultAction(), Q3TabDialog::setDefaultButton(), Q3TabDialog::setHelpButton(), QFileDialog::setLabelText(), Q3FileDialog::setMode(), Q3TabDialog::setOkButton(), QToolBoxPrivate::Page::setText(), Q3CheckTableItem::setText(), qdesigner_internal::StringListEditorButton::StringListEditorButton(), AnimationSaveWidget::toggleRecord(), QCalendarWidgetPrivate::updateHeader(), View::View(), and XFormWidget::XFormWidget().

{
    Q_D(QAbstractButton);
    if (d->text == text)
        return;
    d->text = text;
#ifndef QT_NO_SHORTCUT
    QKeySequence newMnemonic = QKeySequence::mnemonic(text);
    if (!newMnemonic.isEmpty())
        setShortcut(newMnemonic);
#endif
    update();
    updateGeometry();
#ifndef QT_NO_ACCESSIBILITY
    QAccessible::updateAccessibility(this, 0, QAccessible::NameChanged);
#endif
}

Here is the call graph for this function:

QString QAbstractButton::text

(

)

const

Definition at line 619 of file qabstractbutton.cpp.

References d.

Referenced by QFileDialog::accept(), Calculator::additiveOperatorClicked(), Button::Button(), Calculator::digitClicked(), qdesigner_internal::ButtonTaskMenu::editText(), getStyleOption(), QFileDialog::labelText(), Calculator::multiplicativeOperatorClicked(), QToolBoxButton::paintEvent(), QCheckBox::QCheckBox(), QPushButton::QPushButton(), QRadioButton::QRadioButton(), setText(), QCheckBox::sizeHint(), QRadioButton::sizeHint(), QPushButton::sizeHint(), QToolBoxButton::sizeHint(), QToolButton::sizeHint(), QToolBoxPrivate::Page::text(), QAccessibleButton::text(), QAccessibleToolButton::text(), and Calculator::unaryOperatorClicked().

{
    Q_D(const QAbstractButton);
    return d->text;
}

void QAbstractButton::setIcon

(

const QIcon &

icon

)

Definition at line 633 of file qabstractbutton.cpp.

References d, icon(), QWidget::update(), and QWidget::updateGeometry().

Referenced by QDialogButtonBoxPrivate::createButton(), MoviePlayer::createButtons(), QCalendarWidgetPrivate::createHeader(), SortingBox::createToolButton(), EditorWithReset::EditorWithReset(), FtpWindow::FtpWindow(), qdesigner_internal::GraphicsPropertyEditor::init(), TabbedBrowser::init(), ImageComposer::loadImage(), Main::Main(), PathStrokeWidget::PathStrokeWidget(), QBalloonTip::QBalloonTip(), QMenuBarExtension::QMenuBarExtension(), QPushButton::QPushButton(), qdesigner_internal::ResourceEditor::ResourceEditor(), qdesigner_internal::RoleEditor::RoleEditor(), QToolButton::setDefaultAction(), QToolBoxPrivate::Page::setIcon(), Q3ToolBarExtensionWidget::setOrientation(), QToolBarExtension::setOrientation(), QFileDialogPrivate::setupToolButtons(), QWorkspacePrivate::showMaximizeControls(), qdesigner_internal::SignalSlotEditorWindow::SignalSlotEditorWindow(), QDockWidgetPrivate::updateButtons(), Q3DockWindowHandle::updateGui(), and View::View().

{
    Q_D(QAbstractButton);
    d->icon = icon;
    update();
    updateGeometry();
}

Here is the call graph for this function:

QIcon QAbstractButton::icon

(

)

const

Definition at line 641 of file qabstractbutton.cpp.

References d.

Referenced by getStyleOption(), QToolBoxPrivate::Page::icon(), QToolBoxButton::minimumSizeHint(), QDockWidgetTitleButton::paintEvent(), QToolBoxButton::paintEvent(), QPushButton::QPushButton(), setIcon(), QDockWidgetTitleButton::sizeHint(), QPushButton::sizeHint(), QToolBoxButton::sizeHint(), and QToolButton::sizeHint().

{
    Q_D(const QAbstractButton);
    return d->icon;
}

QSize QAbstractButton::iconSize

(

)

const

Definition at line 1308 of file qabstractbutton.cpp.

References d, QStyle::pixelMetric(), QStyle::PM_ButtonIconSize, and QWidget::style().

Referenced by getStyleOption(), and QToolBoxButton::sizeHint().

{
    Q_D(const QAbstractButton);
    if (d->iconSize.isValid())
        return d->iconSize;
    int e = style()->pixelMetric(QStyle::PM_ButtonIconSize);
    return QSize(e, e);
}

Here is the call graph for this function:

void QAbstractButton::setShortcut

(

const QKeySequence &

key

)

Definition at line 653 of file qabstractbutton.cpp.

References d, QWidget::grabShortcut(), key, and QWidget::releaseShortcut().

Referenced by setText().

{
    Q_D(QAbstractButton);
    if (d->shortcutId != 0)
        releaseShortcut(d->shortcutId);
    d->shortcut = key;
    d->shortcutId = grabShortcut(key);
}

Here is the call graph for this function:

QKeySequence QAbstractButton::shortcut

(

)

const

Definition at line 662 of file qabstractbutton.cpp.

References d.

Referenced by QMessageBox::keyPressEvent().

{
    Q_D(const QAbstractButton);
    return d->shortcut;
}

void QAbstractButton::setCheckable

(

bool

)

Definition at line 677 of file qabstractbutton.cpp.

References d.

Referenced by CompositionWidget::CompositionWidget(), MoviePlayer::createButtons(), Window::createPushButtonGroup(), WidgetGallery::createTopRightGroupBox(), GradientWidget::GradientWidget(), PathDeformWidget::PathDeformWidget(), PathStrokeWidget::PathStrokeWidget(), qRadioButtonInit(), QToolButton::setDefaultAction(), View::View(), and XFormWidget::XFormWidget().

{
    Q_D(QAbstractButton);
    if (d->checkable == checkable)
        return;

    d->checkable = checkable;
    d->checked = false;
}

bool QAbstractButton::isCheckable

(

)

const

Definition at line 687 of file qabstractbutton.cpp.

References d.

Referenced by AccessibleFactory::create(), nextCheckState(), and Q3ButtonGroup::selected().

{
    Q_D(const QAbstractButton);
    return d->checkable;
}

bool QAbstractButton::isChecked

(

)

const

Definition at line 736 of file qabstractbutton.cpp.

References d.

Referenced by QButtonGroup::addButton(), WidgetGallery::changePalette(), MainWindow::changeSize(), LanguageChooser::checkBoxToggled(), QButtonGroupPrivate::detectCheckedButton(), Window::filterRegExpChanged(), MoviePlayer::fitToWindow(), getStyleOption(), Q3CheckTableItem::isChecked(), Screenshot::newScreenshot(), nextCheckState(), QDockWidgetTitleButton::paintEvent(), qdesigner_internal::OldSignalSlotDialog::populateSignalList(), qdesigner_internal::OldSignalSlotDialog::populateSlotList(), RegExpDialog::refresh(), Q3ButtonGroup::selected(), DetailsDialog::sendOffers(), Q3CheckTableItem::setContentFromEditor(), Screenshot::shootScreen(), qdesigner_internal::OldSignalSlotDialog::showAllSignalsSlots(), Window::sortChanged(), Window::textFilterChanged(), View::toggleAntialiasing(), View::toggleOpenGL(), AnimationSaveWidget::toggleRecord(), and ControllerWindow::updatePreview().

{
    Q_D(const QAbstractButton);
    return d->checked;
}

void QAbstractButton::setDown

(

bool

)

Definition at line 751 of file qabstractbutton.cpp.

References d.

Referenced by QFileDialogPrivate::_q_showDetails(), QFileDialogPrivate::_q_showList(), animateClick(), changeEvent(), QAccessibleToolButton::doAction(), QPushButton::focusOutEvent(), keyPressEvent(), mouseMoveEvent(), ColorButton::mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), QFileDialogPrivate::setupToolButtons(), and QPushButton::showMenu().

{
    Q_D(QAbstractButton);
    if (d->down == down)
        return;
    d->down = down;
    d->refresh();
    if (d->autoRepeat && d->down)
        d->repeatTimer.start(d->autoRepeatDelay, this);
    else
        d->repeatTimer.stop();
}

bool QAbstractButton::isDown

(

)

const

Definition at line 764 of file qabstractbutton.cpp.

References d.

Referenced by ColorButton::drawButton(), getStyleOption(), QToolBoxButton::paintEvent(), QDockWidgetTitleButton::paintEvent(), QCalToolButton::paintEvent(), QTableCornerButton::paintEvent(), and QFileDialogPrivate::viewMode().

{
    Q_D(const QAbstractButton);
    return d->down;
}

void QAbstractButton::setAutoRepeat

(

bool

)

Definition at line 781 of file qabstractbutton.cpp.

References d.

Referenced by QCalendarWidgetPrivate::createHeader(), QDesignerQ3WidgetStack::QDesignerQ3WidgetStack(), QDesignerStackedWidget::QDesignerStackedWidget(), and View::View().

{
    Q_D(QAbstractButton);
    if (d->autoRepeat == autoRepeat)
        return;
    d->autoRepeat = autoRepeat;
    if (d->autoRepeat && d->down)
        d->repeatTimer.start(d->autoRepeatDelay, this);
    else
        d->repeatTimer.stop();
}

bool QAbstractButton::autoRepeat

(

)

const

Definition at line 793 of file qabstractbutton.cpp.

References d.

{
    Q_D(const QAbstractButton);
    return d->autoRepeat;
}

void QAbstractButton::setAutoRepeatDelay

(

int

)

Definition at line 810 of file qabstractbutton.cpp.

References d.

Referenced by View::View().

{
    Q_D(QAbstractButton);
    d->autoRepeatDelay = autoRepeatDelay;
}

int QAbstractButton::autoRepeatDelay

(

)

const

Definition at line 816 of file qabstractbutton.cpp.

References d.

{
    Q_D(const QAbstractButton);
    return d->autoRepeatDelay;
}

void QAbstractButton::setAutoRepeatInterval

(

int

)

Definition at line 833 of file qabstractbutton.cpp.

References d.

Referenced by View::View().

{
    Q_D(QAbstractButton);
    d->autoRepeatInterval = autoRepeatInterval;
}

int QAbstractButton::autoRepeatInterval

(

)

const

Definition at line 839 of file qabstractbutton.cpp.

References d.

{
    Q_D(const QAbstractButton);
    return d->autoRepeatInterval;
}

void QAbstractButton::setAutoExclusive

(

bool

)

Definition at line 864 of file qabstractbutton.cpp.

References d.

Referenced by qRadioButtonInit().

{
    Q_D(QAbstractButton);
    d->autoExclusive = autoExclusive;
}

bool QAbstractButton::autoExclusive

(

)

const

Definition at line 870 of file qabstractbutton.cpp.

References d.

{
    Q_D(const QAbstractButton);
    return d->autoExclusive;
}

QButtonGroup * QAbstractButton::group

(

)

const

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

Definition at line 885 of file qabstractbutton.cpp.

References d.

Referenced by QButtonGroup::addButton(), and QButtonGroup::removeButton().

{
    Q_D(const QAbstractButton);
    return d->group;
}

void QAbstractButton::setIconSize

(

const QSize &

size

)

[slot]

Definition at line 1317 of file qabstractbutton.cpp.

References d, QWidget::isVisible(), QWidget::size(), QWidget::update(), and QWidget::updateGeometry().

Referenced by MoviePlayer::createButtons(), QToolBarPrivate::createItem(), SortingBox::createToolButton(), EditorWithReset::EditorWithReset(), ImageComposer::ImageComposer(), PathStrokeWidget::PathStrokeWidget(), QBalloonTip::QBalloonTip(), qdesigner_internal::RoleEditor::RoleEditor(), QWorkspacePrivate::showMaximizeControls(), and View::View().

{
    Q_D(QAbstractButton);
    if (d->iconSize == size)
        return;

    d->iconSize = size;
    updateGeometry();
    if (isVisible()) {
        update();
    }
}

void QAbstractButton::animateClick

(

int

msec = 100

)

[slot]

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

All signals associated with a click are emitted as appropriate.

This function does nothing if the button is disabled.

See also:

click()

Definition at line 903 of file qabstractbutton.cpp.

References d, QCoreApplication::flush(), QWidget::focusPolicy(), QWidget::isEnabled(), Qt::NoFocus, QWidget::repaint(), setDown(), and QWidget::setFocus().

Referenced by CompositionWidget::CompositionWidget(), QAccessibleTabBar::doAction(), QAccessibleButton::doAction(), event(), NewForm::on_treeWidget_itemActivated(), PathDeformWidget::PathDeformWidget(), GradientWidget::setDefault(), and XFormWidget::XFormWidget().

{
    if (!isEnabled())
        return;
    Q_D(QAbstractButton);
    if (d->checkable && focusPolicy() != Qt::NoFocus)
        setFocus();
    setDown(true);
    repaint(); //flush paint event before invoking potentially expensive operation
    QApplication::flush();
    d->emitPressed();
    d->animateTimer.start(msec, this);
}

void QAbstractButton::click

(

)

[slot]

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()

Definition at line 929 of file qabstractbutton.cpp.

References d, QWidget::isEnabled(), and nextCheckState().

Referenced by QDialog::keyPressEvent(), QPushButton::keyPressEvent(), and QAbstractButtonPrivate::moveFocus().

{
    if (!isEnabled())
        return;
    Q_D(QAbstractButton);
    QPointer<QAbstractButton> guard(this);
    d->down = true;
    d->emitPressed();
    if (guard) {
        d->down = false;
        nextCheckState();
        if (guard)
            d->emitReleased();
        if (guard)
            d->emitClicked();
    }
}

void QAbstractButton::toggle

(

)

[slot]

Toggles the state of a checkable button.

See also:

checked

Definition at line 953 of file qabstractbutton.cpp.

References d, and setChecked().

{
    Q_D(QAbstractButton);
    setChecked(!d->checked);
}

void QAbstractButton::setChecked

(

bool

)

[slot]

Definition at line 701 of file qabstractbutton.cpp.

References checkStateSet(), d, emit, and toggled().

Referenced by AnimationSaveWidget::AnimationSaveWidget(), CompositionWidget::CompositionWidget(), Q3CheckTableItem::createEditor(), Window::createFirstExclusiveGroup(), MainWindow::createGroupBox(), Window::createIconGroupBox(), Window::createNonExclusiveGroup(), Window::createPushButtonGroup(), Window::createSecondExclusiveGroup(), WidgetGallery::createTopLeftGroupBox(), WidgetGallery::createTopRightGroupBox(), ControllerWindow::createTypeGroupBox(), LanguageChooser::eventFilter(), GradientWidget::GradientWidget(), LanguageChooser::hideAll(), nextCheckState(), PathDeformWidget::PathDeformWidget(), PathStrokeWidget::PathStrokeWidget(), PermissionsTab::PermissionsTab(), PrintPanel::PrintPanel(), RegExpDialog::RegExpDialog(), Q3CheckTableItem::setChecked(), QCheckBox::setCheckState(), QToolButton::setDefaultAction(), qdesigner_internal::OldSignalSlotDialog::setShowAllSignalsSlots(), qdesigner_internal::OldSignalSlotDialog::setSignalSlot(), LanguageChooser::showAll(), toggle(), MoviePlayer::updateButtons(), View::View(), WidgetGallery::WidgetGallery(), and XFormWidget::XFormWidget().

{
    Q_D(QAbstractButton);
    if (!d->checkable || d->checked == checked) {
        if (!d->blockRefresh)
            checkStateSet();
        return;
    }

    if (!checked && d->queryCheckedButton() == this) {
        // the checked button of an exclusive or autoexclusive group cannot be  unchecked
#ifndef QT_NO_BUTTONGROUP
        if (d->group ? d->group->d_func()->exclusive : d->autoExclusive)
            return;
        if (d->group)
            d->group->d_func()->detectCheckedButton();
#else
        if (d->autoExclusive)
            return;
#endif
    }

    QPointer<QAbstractButton> guard(this);

    d->checked = checked;
    if (!d->blockRefresh)
        checkStateSet();
    d->refresh();

    if (guard && checked)
        d->notifyChecked();
    if (guard)
        emit toggled(checked);
}

void QAbstractButton::pressed

(

)

[signal]

This signal is emitted when the button is pressed down.

See also:

released(), clicked()

Referenced by QPushButton::setMenu().

void QAbstractButton::released

(

)

[signal]

This signal is emitted when the button is released.

See also:

pressed(), clicked(), toggled()

void QAbstractButton::clicked

(

bool

checked = false

)

[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(), toggled()

Referenced by ColorButton::ColorButton(), qdesigner_internal::PaletteEditorButton::PaletteEditorButton(), qdesigner_internal::QtBrushButton::QtBrushButton(), qdesigner_internal::QtColorButton::QtColorButton(), qdesigner_internal::StringListEditorButton::StringListEditorButton(), and qdesigner_internal::StyledButton::StyledButton().

void QAbstractButton::toggled

(

bool

checked

)

[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, clicked()

Referenced by setChecked().

void QAbstractButton::paintEvent

(

QPaintEvent *

e

)

[protected, pure virtual]

Reimplemented from QWidget.

bool QAbstractButton::hitButton

(

const QPoint &

pos

)

const [protected, virtual]

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.

Definition at line 991 of file qabstractbutton.cpp.

References QRect::contains(), QWidget::pos(), and QWidget::rect().

Referenced by QToolButton::hitButton(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

{
    return rect().contains(pos);
}

Here is the call graph for this function:

void QAbstractButton::checkStateSet

(

)

[protected, virtual]

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()

Definition at line 966 of file qabstractbutton.cpp.

Referenced by setChecked().

{
}

void QAbstractButton::nextCheckState

(

)

[protected, virtual]

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()

Definition at line 977 of file qabstractbutton.cpp.

References isCheckable(), isChecked(), and setChecked().

Referenced by click(), QToolButton::nextCheckState(), QCheckBox::nextCheckState(), and QAbstractButtonPrivate::notifyChecked().

{
    if (isCheckable())
        setChecked(!isChecked());
}

Here is the call graph for this function:

bool QAbstractButton::event

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 997 of file qabstractbutton.cpp.

References animateClick(), QEvent::ContextMenu, d, QWidget::event(), QWidget::focusPolicy(), QEvent::HoverEnter, QEvent::HoverLeave, QEvent::HoverMove, QShortcutEvent::isAmbiguous(), QWidget::isEnabled(), QEvent::MouseButtonDblClick, QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseMove, Qt::NoFocus, QWidget::setAttribute(), QWidget::setFocus(), QEvent::Shortcut, QShortcutEvent::shortcutId(), QEvent::TabletMove, QEvent::TabletPress, QEvent::TabletRelease, QEvent::type(), Qt::WA_KeyboardFocusChange, QEvent::Wheel, and QWidget::window().

Referenced by QDockWidgetTitleButton::enterEvent(), QCheckBox::event(), QToolButton::event(), QRadioButton::event(), QPushButton::event(), and QDockWidgetTitleButton::leaveEvent().

{
    // as opposed to other widgets, disabled buttons accept mouse
    // events. This avoids surprising click-through scenarios
    if (!isEnabled()) {
        switch(e->type()) {
        case QEvent::TabletPress:
        case QEvent::TabletRelease:
        case QEvent::TabletMove:
        case QEvent::MouseButtonPress:
        case QEvent::MouseButtonRelease:
        case QEvent::MouseButtonDblClick:
        case QEvent::MouseMove:
        case QEvent::HoverMove:
        case QEvent::HoverEnter:
        case QEvent::HoverLeave:
        case QEvent::ContextMenu:
#ifndef QT_NO_WHEELEVENT
        case QEvent::Wheel:
#endif
            return true;
        default:
            break;
        }
    }

#ifndef QT_NO_SHORTCUT
    if (e->type() == QEvent::Shortcut) {
        Q_D(QAbstractButton);
        QShortcutEvent *se = static_cast<QShortcutEvent *>(e);
        if (d->shortcutId != se->shortcutId())
            return false;
        if (focusPolicy() != Qt::NoFocus)
            setFocus();
        if (!se->isAmbiguous())
            animateClick();
        else
            window()->setAttribute(Qt::WA_KeyboardFocusChange);
        return true;
    }
#endif
    return QWidget::event(e);
}

Here is the call graph for this function:

void QAbstractButton::keyPressEvent

(

QKeyEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1108 of file qabstractbutton.cpp.

References d, QCoreApplication::flush(), QWidget::focusNextPrevChild(), QWidget::hasFocus(), QEvent::ignore(), QKeyEvent::isAutoRepeat(), QKeyEvent::key(), Qt::Key_Down, Qt::Key_Enter, Qt::Key_Escape, Qt::Key_Left, Qt::Key_Return, Qt::Key_Right, Qt::Key_Select, Qt::Key_Space, Qt::Key_Up, next, QWidget::repaint(), and setDown().

Referenced by QPushButton::keyPressEvent().

{
    Q_D(QAbstractButton);
    bool next = true;
    switch (e->key()) {
    case Qt::Key_Enter:
    case Qt::Key_Return:
        e->ignore();
        break;
    case Qt::Key_Select:
    case Qt::Key_Space:
        if (!e->isAutoRepeat()) {
            setDown(true);
            repaint(); //flush paint event before invoking potentially expensive operation
            QApplication::flush();
            d->emitPressed();
        }
        break;
    case Qt::Key_Up:
    case Qt::Key_Left:
        next = false;
        // fall through
    case Qt::Key_Right:
    case Qt::Key_Down:
#ifndef QT_NO_BUTTONGROUP
        if (d->group || d->autoExclusive) {
#else
        if (d->autoExclusive) {
#endif
            d->moveFocus(e->key());
            if (hasFocus()) // nothing happend, propagate
                e->ignore();
        } else {
            focusNextPrevChild(next);
        }
        break;
    case Qt::Key_Escape:
        if (d->down) {
            setDown(false);
            repaint(); //flush paint event before invoking potentially expensive operation
            QApplication::flush();
            d->emitReleased();
            break;
        }
        // fall through
    default:
        e->ignore();
    }
}

Here is the call graph for this function:

void QAbstractButton::keyReleaseEvent

(

QKeyEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1159 of file qabstractbutton.cpp.

References d, QEvent::ignore(), QKeyEvent::isAutoRepeat(), QKeyEvent::key(), Qt::Key_Select, and Qt::Key_Space.

{
    Q_D(QAbstractButton);
    switch (e->key()) {
    case Qt::Key_Select:
    case Qt::Key_Space:
        if (!e->isAutoRepeat() && d->down)
            d->click();
        break;
    default:
        e->ignore();
    }
}

Here is the call graph for this function:

void QAbstractButton::mousePressEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1042 of file qabstractbutton.cpp.

References QEvent::accept(), QMouseEvent::button(), d, QCoreApplication::flush(), hitButton(), QEvent::ignore(), Qt::LeftButton, QMouseEvent::pos(), QWidget::repaint(), and setDown().

Referenced by QToolButton::mousePressEvent(), and ColorButton::mousePressEvent().

{
    Q_D(QAbstractButton);
    if (e->button() != Qt::LeftButton) {
        e->ignore();
        return;
    }
    if (hitButton(e->pos())) {
        setDown(true);
        repaint(); //flush paint event before invoking potentially expensive operation
        QApplication::flush();
        d->emitPressed();
        e->accept();
    } else {
        e->ignore();
    }
}

Here is the call graph for this function:

void QAbstractButton::mouseReleaseEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1061 of file qabstractbutton.cpp.

References QEvent::accept(), QMouseEvent::button(), d, hitButton(), QEvent::ignore(), Qt::LeftButton, QMouseEvent::pos(), and setDown().

Referenced by ColorButton::mouseReleaseEvent(), and QToolButton::mouseReleaseEvent().

{
    Q_D(QAbstractButton);
    if (e->button() != Qt::LeftButton) {
        // clean up apperance if left button has been pressed
        if (d->down)
            setDown(false);
        e->ignore();
        return;
    }

    if (!d->down)
        return;

    if (hitButton(e->pos())) {
        d->click();
        e->accept();
    } else {
        setDown(false);
        e->ignore();
    }
}

Here is the call graph for this function:

void QAbstractButton::mouseMoveEvent

(

QMouseEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1085 of file qabstractbutton.cpp.

References QEvent::accept(), QMouseEvent::buttons(), d, QCoreApplication::flush(), hitButton(), QEvent::ignore(), Qt::LeftButton, QMouseEvent::pos(), QWidget::repaint(), and setDown().

Referenced by QRadioButton::mouseMoveEvent(), and QCheckBox::mouseMoveEvent().

{
    Q_D(QAbstractButton);
    if (!(e->buttons() & Qt::LeftButton)) {
        e->ignore();
        return;
    }

    if (hitButton(e->pos()) != d->down) {
        setDown(!d->down);
        repaint(); //flush paint event before invoking potentially expensive operation
        QApplication::flush();
        if (d->down)
            d->emitPressed();
        else
            d->emitReleased();
        e->accept();
    } else if (!hitButton(e->pos())) {
        e->ignore();
    }
}

Here is the call graph for this function:

void QAbstractButton::focusInEvent

(

QFocusEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1195 of file qabstractbutton.cpp.

References d, and QWidget::focusInEvent().

Referenced by QPushButton::focusInEvent().

{
    Q_D(QAbstractButton);
#ifdef QT_KEYPAD_NAVIGATION
    if (!QApplication::keypadNavigationEnabled())
#endif
    d->fixFocusPolicy();
    QWidget::focusInEvent(e);
}

Here is the call graph for this function:

void QAbstractButton::focusOutEvent

(

QFocusEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1206 of file qabstractbutton.cpp.

References d, QWidget::focusOutEvent(), Qt::PopupFocusReason, and QFocusEvent::reason().

Referenced by QPushButton::focusOutEvent().

{
    Q_D(QAbstractButton);
    if (e->reason() != Qt::PopupFocusReason)
        d->down = false;
    QWidget::focusOutEvent(e);
}

Here is the call graph for this function:

void QAbstractButton::changeEvent

(

QEvent *

e

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1215 of file qabstractbutton.cpp.

References QWidget::changeEvent(), QEvent::EnabledChange, QWidget::isEnabled(), setDown(), and QEvent::type().

Referenced by QToolButton::changeEvent().

{
//     Q_D(QAbstractButton);
    switch (e->type()) {
    case QEvent::EnabledChange:
        if (!isEnabled())
            setDown(false);
        break;
    default:
        break;
    }
    QWidget::changeEvent(e);
}

Here is the call graph for this function:

void QAbstractButton::timerEvent

(

QTimerEvent *

e

)

[protected, virtual]

Reimplemented from QObject.

Definition at line 1175 of file qabstractbutton.cpp.

References d, and QTimerEvent::timerId().

Referenced by QToolButton::timerEvent().

{
    Q_D(QAbstractButton);
    if (e->timerId() == d->repeatTimer.timerId()) {
        d->repeatTimer.start(d->autoRepeatInterval, this);
        if (d->down) {
            QPointer<QAbstractButton> guard(this);
            d->emitReleased();
            if (guard)
                d->emitClicked();
            if (guard)
                d->emitPressed();
        }
    } else if (e->timerId() == d->animateTimer.timerId()) {
        d->animateTimer.stop();
        d->click();
    }
}

Here is the call graph for this function:

---

Friends And Related Function Documentation

friend class QButtonGroup [friend]

Definition at line 153 of file qabstractbutton.h.

---

The documentation for this class was generated from the following files:

• src/gui/widgets/qabstractbutton.h
• src/gui/widgets/qabstractbutton.cpp

---