Revision control
Copy as Markdown
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#include "qquickabstractbutton_p.h"
#include "qquickabstractbutton_p_p.h"
#include "qquickactiongroup_p.h"
#include "qquickbuttongroup_p.h"
#include "qquickaction_p.h"
#include "qquickaction_p_p.h"
#include "qquickshortcutcontext_p_p.h"
#include "qquickdeferredexecute_p_p.h"
#include "qquickicon_p_p.h"
#include "qquicktooltip_p.h"
#include "qquicktooltip_p_p.h"
#include <QtCore/qloggingcategory.h>
#include <QtGui/qstylehints.h>
#include <QtGui/qguiapplication.h>
#if QT_CONFIG(shortcut)
# include <QtGui/private/qshortcutmap_p.h>
#endif
#if QT_CONFIG(accessibility)
#include <QtGui/private/qaccessiblehelper_p.h>
#endif
#include <QtGui/private/qguiapplication_p.h>
#include <QtGui/qpa/qplatformtheme.h>
#include <QtQuick/private/qquickevents_p_p.h>
#include <QtQuick/private/qquickevents_p_p.h>
#include <QtQuick/private/qquickaccessibleattached_p.h>
#include <QtQml/qqmllist.h>
QT_BEGIN_NAMESPACE
Q_STATIC_LOGGING_CATEGORY(lcButtonAction, "qt.quick.controls.abstractbutton.action")
#if !QT_CONFIG(shortcut)
Q_STATIC_LOGGING_CATEGORY(lcButtonMnemonics, "qt.quick.controls.abstractbutton.mnemonics")
#endif
/*!
\qmltype AbstractButton
\inherits Control
//! \nativetype QQuickAbstractButton
\inqmlmodule QtQuick.Controls
\since 5.7
\ingroup qtquickcontrols-buttons
\brief Abstract base type providing functionality common to buttons.
AbstractButton provides the interface for controls with button-like
behavior; for example, push buttons and checkable controls like
radio buttons and check boxes. As an abstract control, it has no delegate
implementations, leaving them to the types that derive from it.
\sa ButtonGroup, {Button Controls}
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::pressed()
This signal is emitted when the button is interactively pressed by the user via touch, mouse, or keyboard.
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::released()
This signal is emitted when the button is interactively released by the user via touch, mouse, or keyboard.
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::canceled()
This signal is emitted when the button loses mouse grab
while being pressed, or when it would emit the \l released
signal but the mouse cursor is not inside the button.
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::clicked()
This signal is emitted when the button is interactively clicked by the user via touch, mouse, or keyboard.
\sa click(), animateClick(), {Call a C++ function from QML when a Button is clicked}
*/
/*!
\since QtQuick.Controls 2.2 (Qt 5.9)
\qmlsignal QtQuick.Controls::AbstractButton::toggled()
This signal is emitted when a checkable button is interactively toggled by the user via touch, mouse, or keyboard.
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::pressAndHold()
This signal is emitted when the button is interactively pressed and held down by the user via touch or mouse.
It is not emitted when \l autoRepeat is enabled.
*/
/*!
\qmlsignal QtQuick.Controls::AbstractButton::doubleClicked()
This signal is emitted when the button is interactively double clicked by the user via touch or mouse.
*/
void QQuickAbstractButtonPrivate::init()
{
Q_Q(QQuickAbstractButton);
q->setActiveFocusOnTab(true);
#ifdef Q_OS_MACOS
q->setFocusPolicy(Qt::TabFocus);
#else
q->setFocusPolicy(Qt::StrongFocus);
#endif
q->setAcceptedMouseButtons(Qt::LeftButton);
#if QT_CONFIG(quicktemplates2_multitouch)
q->setAcceptTouchEvents(true);
#endif
#if QT_CONFIG(cursor)
q->setCursor(Qt::ArrowCursor);
#endif
setSizePolicy(QLayoutPolicy::Preferred, QLayoutPolicy::Fixed);
mnemonicEnabled = QGuiApplicationPrivate::platformTheme()->themeHint(
QPlatformTheme::MnemonicsEnabled).toBool();
}
QPointF QQuickAbstractButtonPrivate::centerPressPoint() const
{
return QPointF(qRound(width / 2), qRound(height / 2));
}
void QQuickAbstractButtonPrivate::setPressPoint(const QPointF &point)
{
pressPoint = point;
setMovePoint(point);
}
void QQuickAbstractButtonPrivate::setMovePoint(const QPointF &point)
{
Q_Q(QQuickAbstractButton);
bool xChange = !qFuzzyCompare(point.x(), movePoint.x());
bool yChange = !qFuzzyCompare(point.y(), movePoint.y());
movePoint = point;
if (xChange)
emit q->pressXChanged();
if (yChange)
emit q->pressYChanged();
}
bool QQuickAbstractButtonPrivate::handlePress(const QPointF &point, ulong timestamp)
{
Q_Q(QQuickAbstractButton);
if (pressed)
return true;
QQuickControlPrivate::handlePress(point, timestamp);
setPressPoint(point);
q->setPressed(true);
emit q->pressed();
if (autoRepeat)
startRepeatDelay();
else if (touchId != -1 || Qt::LeftButton == (pressButtons & Qt::LeftButton))
startPressAndHold();
else
stopPressAndHold();
// Tool tips on desktop should hide when their parent item is pressed.
if (touchId == -1)
QQuickToolTipAttachedPrivate::maybeSetVisibleImplicitly(q, false);
return true;
}
bool QQuickAbstractButtonPrivate::handleMove(const QPointF &point, ulong timestamp)
{
Q_Q(QQuickAbstractButton);
QQuickControlPrivate::handleMove(point, timestamp);
setMovePoint(point);
q->setPressed(keepPressed || q->contains(point));
if (!pressed && autoRepeat)
stopPressRepeat();
else if (holdTimer > 0 && (!pressed || QLineF(pressPoint, point).length() > QGuiApplication::styleHints()->startDragDistance()))
stopPressAndHold();
return true;
}
bool QQuickAbstractButtonPrivate::handleRelease(const QPointF &point, ulong timestamp)
{
Q_Q(QQuickAbstractButton);
// Store this here since the base class' handleRelease clears it.
const int pressTouchId = touchId;
QQuickControlPrivate::handleRelease(point, timestamp);
bool wasPressed = pressed;
setPressPoint(point);
q->setPressed(false);
pressButtons = Qt::NoButton;
const bool touchDoubleClick = pressTouchId != -1 && lastTouchReleaseTimestamp != 0
&& QQuickDeliveryAgentPrivate::isWithinDoubleClickInterval(timestamp - lastTouchReleaseTimestamp)
&& isDoubleClickConnected();
if (!wasHeld && wasPressed && (keepPressed || q->contains(point)))
q->nextCheckState();
if (wasPressed) {
if (wasHeld && pressTouchId != -1) {
// We were potentially showing a tool tip on long press; if we were, hide it now that
// we're no longer pressed.
QQuickToolTipAttachedPrivate::maybeSetVisibleImplicitly(q, false);
}
emit q->released();
if (!wasHeld && !wasDoubleClick)
trigger(touchDoubleClick);
} else {
emit q->canceled();
}
if (autoRepeat)
stopPressRepeat();
else
stopPressAndHold();
if (!touchDoubleClick) {
// This is not a double click yet, but it is potentially the
// first release before a double click.
if (pressTouchId != -1) {
// The corresponding press for this release was a touch press.
// Keep track of the timestamp of the release so that we can
// emit doubleClicked() if another one comes afterwards.
lastTouchReleaseTimestamp = timestamp;
}
} else {
// We just did a double click, so clear the release timestamp
// to prepare for any possible future double clicks.
lastTouchReleaseTimestamp = 0;
}
wasDoubleClick = false;
return true;
}
void QQuickAbstractButtonPrivate::handleUngrab()
{
Q_Q(QQuickAbstractButton);
QQuickControlPrivate::handleUngrab();
pressButtons = Qt::NoButton;
if (!pressed)
return;
q->setPressed(false);
stopPressRepeat();
stopPressAndHold();
wasDoubleClick = false;
lastTouchReleaseTimestamp = 0;
emit q->canceled();
}
bool QQuickAbstractButtonPrivate::acceptKeyClick(Qt::Key key) const
{
const auto buttonPressKeys = QGuiApplicationPrivate::platformTheme()->themeHint(QPlatformTheme::ButtonPressKeys).value<QList<Qt::Key>>();
return buttonPressKeys.contains(key);
}
bool QQuickAbstractButtonPrivate::isPressAndHoldConnected()
{
Q_Q(QQuickAbstractButton);
static const QMetaMethod method = [&]() {
const auto signal = &QQuickAbstractButton::pressAndHold;
return QMetaMethod::fromSignal(signal);
}();
return q->isSignalConnected(method);
}
bool QQuickAbstractButtonPrivate::isDoubleClickConnected()
{
Q_Q(QQuickAbstractButton);
static const QMetaMethod method = [&]() {
const auto signal = &QQuickAbstractButton::doubleClicked;
return QMetaMethod::fromSignal(signal);
}();
return q->isSignalConnected(method);
}
void QQuickAbstractButtonPrivate::startPressAndHold()
{
Q_Q(QQuickAbstractButton);
wasHeld = false;
stopPressAndHold();
if (isPressAndHoldConnected())
holdTimer = q->startTimer(QGuiApplication::styleHints()->mousePressAndHoldInterval());
}
void QQuickAbstractButtonPrivate::stopPressAndHold()
{
Q_Q(QQuickAbstractButton);
if (holdTimer > 0) {
q->killTimer(holdTimer);
holdTimer = 0;
}
}
void QQuickAbstractButtonPrivate::startRepeatDelay()
{
Q_Q(QQuickAbstractButton);
stopPressRepeat();
delayTimer = q->startTimer(repeatDelay);
}
void QQuickAbstractButtonPrivate::startPressRepeat()
{
Q_Q(QQuickAbstractButton);
stopPressRepeat();
repeatTimer = q->startTimer(repeatInterval);
}
void QQuickAbstractButtonPrivate::stopPressRepeat()
{
Q_Q(QQuickAbstractButton);
if (delayTimer > 0) {
q->killTimer(delayTimer);
delayTimer = 0;
}
if (repeatTimer > 0) {
q->killTimer(repeatTimer);
repeatTimer = 0;
}
}
#if QT_CONFIG(shortcut)
void QQuickAbstractButtonPrivate::grabShortcut()
{
Q_Q(QQuickAbstractButton);
if (shortcut.isEmpty())
return;
shortcutId = QGuiApplicationPrivate::instance()->shortcutMap.addShortcut(q, shortcut, Qt::WindowShortcut, QQuickShortcutContext::matcher);
if (!q->isEnabled())
QGuiApplicationPrivate::instance()->shortcutMap.setShortcutEnabled(false, shortcutId, q);
}
void QQuickAbstractButtonPrivate::ungrabShortcut()
{
Q_Q(QQuickAbstractButton);
if (!shortcutId)
return;
QGuiApplicationPrivate::instance()->shortcutMap.removeShortcut(shortcutId, q);
shortcutId = 0;
}
#endif
void QQuickAbstractButtonPrivate::actionTextChange()
{
Q_Q(QQuickAbstractButton);
if (explicitText)
return;
q->buttonChange(QQuickAbstractButton::ButtonTextChange);
}
void QQuickAbstractButtonPrivate::setText(const QString &newText, QQml::PropertyUtils::State propertyState)
{
Q_Q(QQuickAbstractButton);
const QString oldText = q->text();
explicitText = isExplicitlySet(propertyState);
text = newText;
if (oldText == q->text())
return;
q->buttonChange(QQuickAbstractButton::ButtonTextChange);
}
/*!
\internal
Whether the \l text supports \l {QShortcut#mnemonic}{mnemonics} keys. An
example of a mnemonic is "E&xit": a button with this text can be clicked
by the keyboard shortcut \c Alt+X, and the \c x will be underlined.
If \c true, the mnemonic indicator (\c &) is always removed from the
displayed text. Depending on the current platform's conventions, this may
also enable the corresponding keyboard shortcut and underline the mnemonic.
If \c false, the mnemonic indicator (\c &) will not be removed from
the text and the shortcut will be disabled. This allows \c & to
be used literally, as in \c {"Cats & Dogs"}.
This isn't exposed to QML: whether mnemonics are supported is determined
by the platform (QPlatformTheme::MnemonicsEnabled) by default, and forced
to \c false by certain derived types (such as \l ItemDelegate and
\l DelayButton) for which mnemonics don't make sense. It isn't something
app code should be able to toggle per-instance.
When Qt is \l {Qt Configure Options}{configured} with
\c -no-feature-shortcut, shortcuts are disabled, and this has no effect.
*/
void QQuickAbstractButtonPrivate::setMnemonicEnabled(bool enabled)
{
if (mnemonicEnabled == enabled)
return;
mnemonicEnabled = enabled;
#if QT_CONFIG(shortcut)
Q_Q(QQuickAbstractButton);
q->setShortcut(mnemonicEnabled ? QKeySequence::mnemonic(text) : QKeySequence());
#else
qCDebug(lcButtonMnemonics) << "The mnemonicEnabled property has no effect when Qt is configured"
<< "with -no-feature-shortcut";
#endif
}
void QQuickAbstractButtonPrivate::updateEffectiveIcon()
{
Q_Q(QQuickAbstractButton);
// We store effectiveIcon because we need to be able to tell if the icon has actually changed.
// If we only stored our icon and the action's icon, and resolved in the getter, we'd have
// no way of knowing what the old value was here. As an added benefit, we only resolve when
// something has changed, as opposed to doing it unconditionally in the icon() getter.
QQuickIcon newEffectiveIcon = action ? icon.resolve(action->icon()) : icon;
bool unchanged = newEffectiveIcon == effectiveIcon;
if (action) {
// We can't rely purely on QQuickIcon::operator== for our unchanged check, because it
// doesn't account for the color being resolved. QQuickIconLabelPrivate::syncImage and
// createImage rely on the color's resolve mask to determine if a color was set on it
// that should override the style default (see QQuickIconLabel::defaultIconColor for
// more info). If we didn't check the resolve mask
// and the user set the color to transparent (the default), the resolveMask of d->icon
// wouldn't indicate that the color was resolved and iconChanged wouldn't be emitted,
// leading to the user's request being ignored.
const bool actionIconColorResolved = QQuickIconPrivate::isResolved(action->icon(),
QQuickIconPrivate::ColorResolved);
const bool iconColorResolved = QQuickIconPrivate::isResolved(icon,
QQuickIconPrivate::ColorResolved);
unchanged = newEffectiveIcon == effectiveIcon;
// Only set it to false if there was a change in icon color that would otherwise
// be undetectable.
if (unchanged && !iconColorResolved && actionIconColorResolved)
unchanged = false;
// We need to mark the effective icon's color as resolved, too.
if (actionIconColorResolved)
newEffectiveIcon.resolveColor();
}
// Always update effectiveIcon because the color may have been resolved in icon,
// which isn't accounted for QQuickIcon::operator==.
effectiveIcon = newEffectiveIcon;
if (unchanged)
return;
if (action && !QQuickIconPrivate::isResolved(effectiveIcon, QQuickIconPrivate::ColorResolved)) {
// A color wasn't set on the button's icon (which should always win over an Action's).
if (QQuickIconPrivate::isResolved(action->icon(), QQuickIconPrivate::ColorResolved)) {
// A color was set on the action's icon; mark the effective icon's color as being
// explicitly set so that QQuickIconLabel can detect that it's set and respect it.
effectiveIcon.resolveColor();
}
}
emit q->iconChanged();
}
void QQuickAbstractButtonPrivate::click()
{
Q_Q(QQuickAbstractButton);
// If our Action's trigger signal handler disables us (or the action, which causes us to be
// disabled), we still want clicked to be emitted so that e.g. menus close when a menu item is
// clicked. That's why we check wasEnabledBeforeTrigger here.
if (effectiveEnable || wasEnabledBeforeTrigger)
emit q->clicked();
}
void QQuickAbstractButtonPrivate::accessiblePressAction()
{
Q_Q(QQuickAbstractButton);
q->click();
}
void QQuickAbstractButtonPrivate::accessibleToggleAction()
{
accessiblePressAction();
}
void QQuickAbstractButtonPrivate::trigger(bool doubleClick)
{
Q_Q(QQuickAbstractButton);
const QScopedValueRollback<bool> rollback(wasEnabledBeforeTrigger, effectiveEnable);
bool actionTriggered = false;
if (action && action->isEnabled())
actionTriggered = QQuickActionPrivate::get(action)->trigger(q, false);
// Don't emit the signals below if we were disabled or if our action already emitted its
// triggered signal (which we connect to click, which emits clicked, so would emit twice).
if (!wasEnabledBeforeTrigger || actionTriggered)
return;
if (!doubleClick)
emit q->clicked();
else
emit q->doubleClicked();
}
void QQuickAbstractButtonPrivate::toggle(bool value)
{
Q_Q(QQuickAbstractButton);
const bool wasChecked = checked;
q->setChecked(value);
if (wasChecked != checked)
emit q->toggled();
}
void QQuickAbstractButtonPrivate::cancelIndicator()
{
Q_Q(QQuickAbstractButton);
quickCancelDeferred(q, indicatorName());
}
void QQuickAbstractButtonPrivate::executeIndicator(bool complete)
{
Q_Q(QQuickAbstractButton);
if (indicator.wasExecuted())
return;
if (!indicator || complete)
quickBeginDeferred(q, indicatorName(), indicator);
if (complete)
quickCompleteDeferred(q, indicatorName(), indicator);
}
void QQuickAbstractButtonPrivate::itemImplicitWidthChanged(QQuickItem *item)
{
Q_Q(QQuickAbstractButton);
QQuickControlPrivate::itemImplicitWidthChanged(item);
if (item == indicator)
emit q->implicitIndicatorWidthChanged();
}
void QQuickAbstractButtonPrivate::itemImplicitHeightChanged(QQuickItem *item)
{
Q_Q(QQuickAbstractButton);
QQuickControlPrivate::itemImplicitHeightChanged(item);
if (item == indicator)
emit q->implicitIndicatorHeightChanged();
}
void QQuickAbstractButtonPrivate::itemDestroyed(QQuickItem *item)
{
Q_Q(QQuickAbstractButton);
QQuickControlPrivate::itemDestroyed(item);
if (item == indicator) {
indicator = nullptr;
emit q->implicitIndicatorWidthChanged();
emit q->implicitIndicatorHeightChanged();
}
}
QQuickAbstractButton *QQuickAbstractButtonPrivate::findCheckedButton() const
{
Q_Q(const QQuickAbstractButton);
if (group)
return group->checkedButton();
const QList<QQuickAbstractButton *> buttons = findExclusiveButtons();
// TODO: A singular QRadioButton can be unchecked, which seems logical,
// because there's nothing to be exclusive with. However, a RadioButton
// from QtQuick.Controls 1.x can never be unchecked, which is the behavior
// that QQuickRadioButton adopted. Uncommenting the following count check
// gives the QRadioButton behavior. Notice that tst_radiobutton.qml needs
// to be updated.
if (!autoExclusive /*|| buttons.count() == 1*/)
return nullptr;
for (QQuickAbstractButton *button : buttons) {
if (button->isChecked() && button != q)
return button;
}
return checked ? const_cast<QQuickAbstractButton *>(q) : nullptr;
}
QList<QQuickAbstractButton *> QQuickAbstractButtonPrivate::findExclusiveButtons() const
{
QList<QQuickAbstractButton *> buttons;
if (group) {
QQmlListProperty<QQuickAbstractButton> groupButtons = group->buttons();
int count = groupButtons.count(&groupButtons);
for (int i = 0; i < count; ++i) {
QQuickAbstractButton *button = qobject_cast<QQuickAbstractButton *>(groupButtons.at(&groupButtons, i));
if (button)
buttons += button;
}
} else if (parentItem) {
const auto childItems = parentItem->childItems();
for (QQuickItem *child : childItems) {
QQuickAbstractButton *button = qobject_cast<QQuickAbstractButton *>(child);
if (button && button->autoExclusive() && !QQuickAbstractButtonPrivate::get(button)->group)
buttons += button;
}
}
return buttons;
}
QQuickAbstractButton::QQuickAbstractButton(QQuickItem *parent)
: QQuickControl(*(new QQuickAbstractButtonPrivate), parent)
{
Q_D(QQuickAbstractButton);
d->init();
}
QQuickAbstractButton::QQuickAbstractButton(QQuickAbstractButtonPrivate &dd, QQuickItem *parent)
: QQuickControl(dd, parent)
{
Q_D(QQuickAbstractButton);
d->init();
}
QQuickAbstractButton::~QQuickAbstractButton()
{
Q_D(QQuickAbstractButton);
d->removeImplicitSizeListener(d->indicator);
if (d->group) {
auto *attached = qobject_cast<QQuickButtonGroupAttached *>(
qmlAttachedPropertiesObject<QQuickButtonGroup>(this, false));
if (attached)
attached->setGroup(nullptr);
else
d->group->removeButton(this);
}
#if QT_CONFIG(shortcut)
d->ungrabShortcut();
#endif
}
/*!
\qmlproperty string QtQuick.Controls::AbstractButton::text
This property holds a textual description of the button.
\note The text is used for accessibility purposes, so it makes sense to
set a textual description even if the content item is an image.
\sa icon, display, {Control::contentItem}{contentItem}
*/
QString QQuickAbstractButton::text() const
{
Q_D(const QQuickAbstractButton);
return d->explicitText || !d->action ? d->text : d->action->text();
}
void QQuickAbstractButton::setText(const QString &text)
{
Q_D(QQuickAbstractButton);
d->setText(text, QQml::PropertyUtils::State::ExplicitlySet);
}
void QQuickAbstractButton::resetText()
{
Q_D(QQuickAbstractButton);
d->setText(QString(), QQml::PropertyUtils::State::ImplicitlySet);
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::down
This property holds whether the button is visually down.
Unless explicitly set, this property follows the value of \l pressed. To
return to the default value, set this property to \c undefined.
\sa pressed
*/
bool QQuickAbstractButton::isDown() const
{
Q_D(const QQuickAbstractButton);
return d->down;
}
void QQuickAbstractButton::setDown(bool down)
{
Q_D(QQuickAbstractButton);
d->explicitDown = true;
if (d->down == down)
return;
d->down = down;
emit downChanged();
}
void QQuickAbstractButton::resetDown()
{
Q_D(QQuickAbstractButton);
if (!d->explicitDown)
return;
setDown(d->pressed);
d->explicitDown = false;
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::pressed
\readonly
This property holds whether the button is physically pressed. A button can
be pressed by either touch or key events.
\sa down
*/
bool QQuickAbstractButton::isPressed() const
{
Q_D(const QQuickAbstractButton);
return d->pressed;
}
void QQuickAbstractButton::setPressed(bool isPressed)
{
Q_D(QQuickAbstractButton);
if (d->pressed == isPressed)
return;
d->pressed = isPressed;
setAccessibleProperty("pressed", isPressed);
emit pressedChanged();
buttonChange(ButtonPressedChanged);
if (!d->explicitDown) {
setDown(d->pressed);
d->explicitDown = false;
}
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::checked
This property holds whether the button is checked.
Since Qt 6.2, setting this property no longer affects the
\l {AbstractButton::}{checkable} property. Explicitly set the
\c checkable property if needed.
\sa checkable
*/
bool QQuickAbstractButton::isChecked() const
{
Q_D(const QQuickAbstractButton);
return d->checked;
}
void QQuickAbstractButton::setChecked(bool checked)
{
Q_D(QQuickAbstractButton);
if (d->checked == checked)
return;
d->checked = checked;
if (d->action)
d->action->setChecked(checked);
setAccessibleProperty("checked", checked);
buttonChange(ButtonCheckedChange);
emit checkedChanged();
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::checkable
This property holds whether the button is checkable.
A checkable button toggles between checked (on) and unchecked (off) when
the user clicks on it or presses the space bar while the button has active
focus.
The default value is \c false.
\sa checked
*/
bool QQuickAbstractButton::isCheckable() const
{
Q_D(const QQuickAbstractButton);
return d->checkable;
}
void QQuickAbstractButton::setCheckable(bool checkable)
{
Q_D(QQuickAbstractButton);
if (d->checkable == checkable)
return;
d->checkable = checkable;
if (d->action)
d->action->setCheckable(checkable);
setAccessibleProperty("checkable", checkable);
buttonChange(ButtonCheckableChange);
emit checkableChanged();
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::autoExclusive
This property holds whether auto-exclusivity is enabled.
If auto-exclusivity is enabled, checkable buttons that belong to the same
parent item behave as if they were part of the same ButtonGroup. Only
one button can be checked at any time; checking another button automatically
unchecks the previously checked one.
\note The property has no effect on buttons that belong to a ButtonGroup.
RadioButton and TabButton are auto-exclusive by default.
*/
bool QQuickAbstractButton::autoExclusive() const
{
Q_D(const QQuickAbstractButton);
return d->autoExclusive;
}
void QQuickAbstractButton::setAutoExclusive(bool exclusive)
{
Q_D(QQuickAbstractButton);
if (d->autoExclusive == exclusive)
return;
d->autoExclusive = exclusive;
emit autoExclusiveChanged();
}
/*!
\qmlproperty bool QtQuick.Controls::AbstractButton::autoRepeat
This property holds whether the button repeats \l pressed(), \l released()
and \l clicked() signals while the button is pressed and held down.
If this property is set to \c true, the \l pressAndHold() signal will not
be emitted.
The default value is \c false.
The initial delay and the repetition interval are defined in milliseconds
by \l autoRepeatDelay and \l autoRepeatInterval.
*/
bool QQuickAbstractButton::autoRepeat() const
{
Q_D(const QQuickAbstractButton);
return d->autoRepeat;
}
void QQuickAbstractButton::setAutoRepeat(bool repeat)
{
Q_D(QQuickAbstractButton);
if (d->autoRepeat == repeat)
return;
d->stopPressRepeat();
d->autoRepeat = repeat;
emit autoRepeatChanged();
}
/*!
\qmlproperty Item QtQuick.Controls::AbstractButton::indicator
This property holds the indicator item.
*/
QQuickItem *QQuickAbstractButton::indicator() const
{
QQuickAbstractButtonPrivate *d = const_cast<QQuickAbstractButtonPrivate *>(d_func());
if (!d->indicator)
d->executeIndicator();
return d->indicator;
}
void QQuickAbstractButton::setIndicator(QQuickItem *indicator)
{
Q_D(QQuickAbstractButton);
if (d->indicator == indicator)
return;
QQuickControlPrivate::warnIfCustomizationNotSupported(this, indicator, QStringLiteral("indicator"));
if (!d->indicator.isExecuting())
d->cancelIndicator();
const qreal oldImplicitIndicatorWidth = implicitIndicatorWidth();
const qreal oldImplicitIndicatorHeight = implicitIndicatorHeight();
d->removeImplicitSizeListener(d->indicator);
QQuickControlPrivate::hideOldItem(d->indicator);
d->indicator = indicator;
if (indicator) {
if (!indicator->parentItem())
indicator->setParentItem(this);
indicator->setAcceptedMouseButtons(Qt::LeftButton);
d->addImplicitSizeListener(indicator);
}
if (!qFuzzyCompare(oldImplicitIndicatorWidth, implicitIndicatorWidth()))
emit implicitIndicatorWidthChanged();
if (!qFuzzyCompare(oldImplicitIndicatorHeight, implicitIndicatorHeight()))
emit implicitIndicatorHeightChanged();
if (!d->indicator.isExecuting())
emit indicatorChanged();
}
/*!
\qmlproperty string QtQuick.Controls::AbstractButton::icon.name
\qmlproperty url QtQuick.Controls::AbstractButton::icon.source
\qmlproperty int QtQuick.Controls::AbstractButton::icon.width
\qmlproperty int QtQuick.Controls::AbstractButton::icon.height
\qmlproperty color QtQuick.Controls::AbstractButton::icon.color
\qmlproperty bool QtQuick.Controls::AbstractButton::icon.cache
\since QtQuick.Controls 2.3
\include qquickicon.qdocinc grouped-properties
\sa text, display, {Icons in Qt Quick Controls}
*/
QQuickIcon QQuickAbstractButton::icon() const
{
Q_D(const QQuickAbstractButton);
return d->effectiveIcon;
}
void QQuickAbstractButton::setIcon(const QQuickIcon &icon)
{
Q_D(QQuickAbstractButton);
d->icon = icon;
d->icon.ensureRelativeSourceResolved(this);
d->updateEffectiveIcon();
}
/*!
\since QtQuick.Controls 2.3 (Qt 5.10)
\qmlproperty enumeration QtQuick.Controls::AbstractButton::display
This property determines how the \l icon and \l text are displayed within
the button.
\table
\header \li Display \li Result
\row \li \c AbstractButton.IconOnly
\li \image qtquickcontrols-button-icononly.png
{Button displaying only icon}
\row \li \c AbstractButton.TextOnly
\li \image qtquickcontrols-button-textonly.png
{Button displaying only text}
\row \li \c AbstractButton.TextBesideIcon (default)
\li \image qtquickcontrols-button-textbesideicon.png
{Button with text beside icon}
\row \li \c AbstractButton.TextUnderIcon
\li \image qtquickcontrols-button-textundericon.png
{Button with text under icon}
\endtable
\sa {Control::}{spacing}, {Control::}{padding}
*/
QQuickAbstractButton::Display QQuickAbstractButton::display() const
{
Q_D(const QQuickAbstractButton);
return d->display;
}
void QQuickAbstractButton::setDisplay(Display display)
{
Q_D(QQuickAbstractButton);
if (display == d->display)
return;
d->display = display;
emit displayChanged();
}
/*!
\since QtQuick.Controls 2.3 (Qt 5.10)
\qmlproperty Action QtQuick.Controls::AbstractButton::action
This property holds the button action.
\sa Action
*/
QQuickAction *QQuickAbstractButton::action() const
{
Q_D(const QQuickAbstractButton);
return d->action;
}
void QQuickAbstractButton::setAction(QQuickAction *action)
{
Q_D(QQuickAbstractButton);
qCDebug(lcButtonAction) << this << "setAction called with" << action;
if (d->action == action)
return;
const QString oldText = text();
if (QQuickAction *oldAction = d->action.data()) {
QQuickActionPrivate::get(oldAction)->unregisterItem(this);
QObjectPrivate::disconnect(oldAction, &QQuickAction::triggered, d, &QQuickAbstractButtonPrivate::click);
QObjectPrivate::disconnect(oldAction, &QQuickAction::textChanged, d, &QQuickAbstractButtonPrivate::actionTextChange);
QObjectPrivate::disconnect(oldAction, &QQuickAction::iconChanged, d, &QQuickAbstractButtonPrivate::updateEffectiveIcon);
disconnect(oldAction, &QQuickAction::checkedChanged, this, &QQuickAbstractButton::setChecked);
disconnect(oldAction, &QQuickAction::checkableChanged, this, &QQuickAbstractButton::setCheckable);
disconnect(oldAction, &QQuickAction::enabledChanged, this, &QQuickItem::setEnabled);
}
if (action) {
QQuickActionPrivate::get(action)->registerItem(this);
QObjectPrivate::connect(action, &QQuickAction::triggered, d, &QQuickAbstractButtonPrivate::click);
QObjectPrivate::connect(action, &QQuickAction::textChanged, d, &QQuickAbstractButtonPrivate::actionTextChange);
QObjectPrivate::connect(action, &QQuickAction::iconChanged, d, &QQuickAbstractButtonPrivate::updateEffectiveIcon);
connect(action, &QQuickAction::checkedChanged, this, &QQuickAbstractButton::setChecked);
connect(action, &QQuickAction::checkableChanged, this, &QQuickAbstractButton::setCheckable);
connect(action, &QQuickAction::enabledChanged, this, &QQuickItem::setEnabled);
setChecked(action->isChecked());
setCheckable(action->isCheckable());
setEnabled(action->isEnabled());
}
#if QT_CONFIG(accessibility)
auto attached = qobject_cast<QQuickAccessibleAttached*>(qmlAttachedPropertiesObject<QQuickAccessibleAttached>(this, true));
Q_ASSERT(attached);
attached->setProxying(qobject_cast<QQuickAccessibleAttached*>(qmlAttachedPropertiesObject<QQuickAccessibleAttached>(action, true)));
#endif
d->action = action;
if (oldText != text())
buttonChange(ButtonTextChange);
d->updateEffectiveIcon();
emit actionChanged();
}
/*!
\since QtQuick.Controls 2.4 (Qt 5.11)
\qmlproperty int QtQuick.Controls::AbstractButton::autoRepeatDelay
This property holds the initial delay of auto-repetition in milliseconds.
The default value is \c 300 ms.
\sa autoRepeat, autoRepeatInterval
*/
int QQuickAbstractButton::autoRepeatDelay() const
{
Q_D(const QQuickAbstractButton);
return d->repeatDelay;
}
void QQuickAbstractButton::setAutoRepeatDelay(int delay)
{
Q_D(QQuickAbstractButton);
if (d->repeatDelay == delay)
return;
d->repeatDelay = delay;
emit autoRepeatDelayChanged();
}
/*!
\since QtQuick.Controls 2.4 (Qt 5.11)
\qmlproperty int QtQuick.Controls::AbstractButton::autoRepeatInterval
This property holds the interval of auto-repetition in milliseconds.
The default value is \c 100 ms.
\sa autoRepeat, autoRepeatDelay
*/
int QQuickAbstractButton::autoRepeatInterval() const
{
Q_D(const QQuickAbstractButton);
return d->repeatInterval;
}
void QQuickAbstractButton::setAutoRepeatInterval(int interval)
{
Q_D(QQuickAbstractButton);
if (d->repeatInterval == interval)
return;
d->repeatInterval = interval;
emit autoRepeatIntervalChanged();
}
#if QT_CONFIG(shortcut)
/*!
\internal
This is the mnemonic shortcut that is derived from the text;
see \c QQuickAbstractButton::buttonChange().
*/
QKeySequence QQuickAbstractButton::shortcut() const
{
Q_D(const QQuickAbstractButton);
return d->shortcut;
}
void QQuickAbstractButton::setShortcut(const QKeySequence &shortcut)
{
Q_D(QQuickAbstractButton);
if (d->shortcut == shortcut)
return;
d->ungrabShortcut();
d->shortcut = shortcut;
if (isVisible() && d->mnemonicEnabled)
d->grabShortcut();
}
#endif
/*!
\readonly
\since QtQuick.Controls 2.4 (Qt 5.11)
\qmlproperty real QtQuick.Controls::AbstractButton::pressX
This property holds the x-coordinate of the last press.
\note The value is updated on touch moves, but left intact after touch release.
\sa pressY
*/
qreal QQuickAbstractButton::pressX() const
{
Q_D(const QQuickAbstractButton);
return d->movePoint.x();
}
/*!
\readonly
\since QtQuick.Controls 2.4 (Qt 5.11)
\qmlproperty real QtQuick.Controls::AbstractButton::pressY
This property holds the y-coordinate of the last press.
\note The value is updated on touch moves, but left intact after touch release.
\sa pressX
*/
qreal QQuickAbstractButton::pressY() const
{
Q_D(const QQuickAbstractButton);
return d->movePoint.y();
}
/*!
\since QtQuick.Controls 2.5 (Qt 5.12)
\qmlproperty real QtQuick.Controls::AbstractButton::implicitIndicatorWidth
\readonly
This property holds the implicit indicator width.
The value is equal to \c {indicator ? indicator.implicitWidth : 0}.
This is typically used, together with \l {Control::}{implicitContentWidth} and
\l {Control::}{implicitBackgroundWidth}, to calculate the \l {Item::}{implicitWidth}.
\sa implicitIndicatorHeight
*/
qreal QQuickAbstractButton::implicitIndicatorWidth() const
{
Q_D(const QQuickAbstractButton);
if (!d->indicator)
return 0;
return d->indicator->implicitWidth();
}
/*!
\since QtQuick.Controls 2.5 (Qt 5.12)
\qmlproperty real QtQuick.Controls::AbstractButton::implicitIndicatorHeight
\readonly
This property holds the implicit indicator height.
The value is equal to \c {indicator ? indicator.implicitHeight : 0}.
This is typically used, together with \l {Control::}{implicitContentHeight} and
\l {Control::}{implicitBackgroundHeight}, to calculate the \l {Item::}{implicitHeight}.
\sa implicitIndicatorWidth
*/
qreal QQuickAbstractButton::implicitIndicatorHeight() const
{
Q_D(const QQuickAbstractButton);
if (!d->indicator)
return 0;
return d->indicator->implicitHeight();
}
/*!
\qmlmethod void QtQuick.Controls::AbstractButton::toggle()
Toggles the checked state of the button.
\sa click(), animateClick()
*/
void QQuickAbstractButton::toggle()
{
Q_D(QQuickAbstractButton);
setChecked(!d->checked);
}
/*!
\since Qt 6.8
\qmlmethod void QtQuick.Controls::AbstractButton::click()
Simulates the button being clicked with no delay between press and release.
All signals associated with a click are emitted as appropriate.
If the \l [QML] {Item::} {focusPolicy} includes \c Qt.ClickFocus,
\l [QML] {Item::} {activeFocus} will become \c true.
This function does nothing if the button is
\l [QML] {Item::enabled} {disabled}.
Calling this function again before the button is released resets
the release timer.
\sa animateClick(), pressed(), released(), clicked()
*/
void QQuickAbstractButton::click()
{
Q_D(QQuickAbstractButton);
if (!isEnabled())
return;
// QQuickItemPrivate::deliverPointerEvent calls setFocusIfNeeded on real clicks,
// so we need to do it ourselves.
const bool setFocusOnPress = !QGuiApplication::styleHints()->setFocusOnTouchRelease();
if (setFocusOnPress && focusPolicy() & Qt::ClickFocus)
forceActiveFocus(Qt::MouseFocusReason);
const QPointF eventPos(d->width / 2, d->height / 2);
d->handlePress(eventPos, 0);
d->handleRelease(eventPos, 0);
}
/*!
\since Qt 6.8
\qmlmethod void QtQuick.Controls::AbstractButton::animateClick()
Simulates the button being clicked, with a 100 millisecond delay
between press and release, animating its visual state in the
process.
All signals associated with a click are emitted as appropriate.
If the \l [QML] {Item::} {focusPolicy} includes \c Qt.ClickFocus,
\l [QML] {Item::}{activeFocus} will become \c true.
This function does nothing if the button is
\l [QML] {Item::enabled} {disabled}.
Calling this function again before the button is released resets
the release timer.
\sa click(), pressed(), released(), clicked()
*/
void QQuickAbstractButton::animateClick()
{
Q_D(QQuickAbstractButton);
if (!isEnabled())
return;
// See comment in click() for why we do this.
const bool setFocusOnPress = !QGuiApplication::styleHints()->setFocusOnTouchRelease();
if (setFocusOnPress && focusPolicy() & Qt::ClickFocus)
forceActiveFocus(Qt::MouseFocusReason);
// If the timer was already running, kill it so we can restart it.
if (d->animateTimer != 0) {
killTimer(d->animateTimer);
d->animateTimer = 0;
} else {
d->handlePress(QPointF(d->width / 2, d->height / 2), 0);
}
d->animateTimer = startTimer(100);
}
void QQuickAbstractButton::componentComplete()
{
Q_D(QQuickAbstractButton);
d->executeIndicator(true);
QQuickControl::componentComplete();
}
bool QQuickAbstractButton::event(QEvent *event)
{
#if QT_CONFIG(shortcut)
Q_D(QQuickAbstractButton);
if (event->type() == QEvent::Shortcut) {
QShortcutEvent *se = static_cast<QShortcutEvent *>(event);
if (se->shortcutId() == d->shortcutId) {
d->trigger();
return true;
}
}
#endif
return QQuickControl::event(event);
}
void QQuickAbstractButton::focusOutEvent(QFocusEvent *event)
{
Q_D(QQuickAbstractButton);
QQuickControl::focusOutEvent(event);
if (d->touchId == -1) // don't ungrab on multi-touch if another control gets focused
d->handleUngrab();
}
void QQuickAbstractButton::keyPressEvent(QKeyEvent *event)
{
Q_D(QQuickAbstractButton);
QQuickControl::keyPressEvent(event);
if (d->acceptKeyClick(static_cast<Qt::Key>(event->key()))) {
d->setPressPoint(d->centerPressPoint());
setPressed(true);
if (d->autoRepeat)
d->startRepeatDelay();
emit pressed();
event->accept();
}
}
void QQuickAbstractButton::keyReleaseEvent(QKeyEvent *event)
{
Q_D(QQuickAbstractButton);
QQuickControl::keyReleaseEvent(event);
if (d->pressed && d->acceptKeyClick(static_cast<Qt::Key>(event->key()))) {
setPressed(false);
nextCheckState();
emit released();
d->trigger();
if (d->autoRepeat)
d->stopPressRepeat();
event->accept();
}
}
void QQuickAbstractButton::mousePressEvent(QMouseEvent *event)
{
if (!(event->buttons() & Qt::LeftButton)) {
event->ignore();
return;
}
Q_D(QQuickAbstractButton);
d->pressButtons = event->buttons();
QQuickControl::mousePressEvent(event);
}
void QQuickAbstractButton::mouseDoubleClickEvent(QMouseEvent *event)
{
Q_UNUSED(event);
Q_D(QQuickAbstractButton);
if (d->isDoubleClickConnected()) {
// don't call QQuickItem::mouseDoubleClickEvent(): it would ignore()
emit doubleClicked();
d->wasDoubleClick = true;
}
}
void QQuickAbstractButton::timerEvent(QTimerEvent *event)
{
Q_D(QQuickAbstractButton);
QQuickControl::timerEvent(event);
if (event->timerId() == d->holdTimer) {
d->stopPressAndHold();
d->wasHeld = true;
emit pressAndHold();
QQuickToolTipAttachedPrivate::maybeSetVisibleImplicitly(this, true);
} else if (event->timerId() == d->delayTimer) {
d->startPressRepeat();
} else if (event->timerId() == d->repeatTimer) {
emit released();
d->trigger();
emit pressed();
} else if (event->timerId() == d->animateTimer) {
const bool setFocusOnRelease = QGuiApplication::styleHints()->setFocusOnTouchRelease();
if (setFocusOnRelease && focusPolicy() & Qt::ClickFocus)
forceActiveFocus(Qt::MouseFocusReason);
d->handleRelease(QPointF(d->width / 2, d->height / 2), 0);
killTimer(d->animateTimer);
d->animateTimer = 0;
}
}
void QQuickAbstractButton::itemChange(ItemChange change, const ItemChangeData &value)
{
QQuickControl::itemChange(change, value);
#if QT_CONFIG(shortcut)
Q_D(QQuickAbstractButton);
if (change == ItemVisibleHasChanged && d->mnemonicEnabled) {
if (value.boolValue)
d->grabShortcut();
else
d->ungrabShortcut();
}
#endif
}
void QQuickAbstractButton::buttonChange(ButtonChange change)
{
Q_D(QQuickAbstractButton);
switch (change) {
case ButtonCheckedChange:
if (d->checked) {
QQuickAbstractButton *button = d->findCheckedButton();
if (button && button != this)
button->setChecked(false);
}
break;
case ButtonTextChange: {
const QString txt = text();
#if QT_CONFIG(accessibility)
maybeSetAccessibleName(qt_accStripAmp(txt));
#endif
#if QT_CONFIG(shortcut)
if (d->mnemonicEnabled)
setShortcut(QKeySequence::mnemonic(txt));
#endif
emit textChanged();
break;
}
default:
break;
}
}
void QQuickAbstractButton::nextCheckState()
{
Q_D(QQuickAbstractButton);
if (!d->checkable)
return;
if (d->checked) {
if (d->findCheckedButton() == this)
return;
if (d->action) {
// For non-exclusive groups checkedAction is null
if (const auto group = QQuickActionPrivate::get(d->action)->group)
if (group->checkedAction() == d->action)
return;
}
}
d->toggle(!d->checked);
}
#if QT_CONFIG(accessibility)
void QQuickAbstractButton::accessibilityActiveChanged(bool active)
{
QQuickControl::accessibilityActiveChanged(active);
Q_D(QQuickAbstractButton);
if (active) {
maybeSetAccessibleName(qt_accStripAmp(text()));
setAccessibleProperty("pressed", d->pressed);
setAccessibleProperty("checked", d->checked);
setAccessibleProperty("checkable", d->checkable);
}
}
QAccessible::Role QQuickAbstractButton::accessibleRole() const
{
Q_D(const QQuickAbstractButton);
if (d->checkable) {
return QAccessible::CheckBox;
}
return QAccessible::Button;
}
void QQuickAbstractButton::accessiblePressAction()
{
Q_D(QQuickAbstractButton);
d->accessiblePressAction();
}
void QQuickAbstractButton::accessibleToggleAction()
{
Q_D(QQuickAbstractButton);
d->accessibleToggleAction();
}
#endif
QT_END_NAMESPACE
#include "moc_qquickabstractbutton_p.cpp"