qquickdelaybutton.cpp

Go to the documentation of this file.

// 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 "qquickdelaybutton_p.h"
#include "qquickabstractbutton_p_p.h"
 
#include <QtQuick/private/qquickanimation_p.h>
#include <QtQuick/private/qquicktransition_p.h>
#include <QtQuick/private/qquicktransitionmanager_p_p.h>
 
QT_BEGIN_NAMESPACE
 
/*!
    \qmltype DelayButton
    \inherits AbstractButton
//!     \nativetype QQuickDelayButton
    \inqmlmodule QtQuick.Controls
    \since 5.9
    \ingroup qtquickcontrols-buttons
    \brief Check button that triggers when held down long enough.
 
    \image qtquickcontrols-delaybutton.gif
           {Delay button with progress indicator filling on long press}
 
    DelayButton is a checkable button that incorporates a delay before the
    button becomes \l {AbstractButton::}{checked} and the \l activated()
    signal is emitted. This delay prevents accidental presses.
 
    The current progress is expressed as a decimal value between \c 0.0
    and \c 1.0. The time it takes for \l activated() to be emitted is
    measured in milliseconds, and can be set with the \l delay property.
 
    The progress is indicated by a progress indicator on the button.
 
    \sa {Customizing DelayButton}, {Button Controls}
*/
 
/*!
    \qmlsignal QtQuick.Controls::DelayButton::activated()
 
    This signal is emitted when \l progress reaches \c 1.0.
*/
 
class QQuickDelayTransitionManager;
 
class QQuickDelayButtonPrivate : public QQuickAbstractButtonPrivate
{
    Q_DECLARE_PUBLIC(QQuickDelayButton)
 
public:
    void beginTransition(qreal to);
    void finishTransition();
    void cancelTransition();
 
    QPalette defaultPalette() const override { return QQuickTheme::palette(QQuickTheme::Button); }
 
    int delay = 300;
    qreal progress = 0.0;
    QQuickTransition *transition = nullptr;
    QScopedPointer<QQuickDelayTransitionManager> transitionManager;
};
 
class QQuickDelayTransitionManager : public QQuickTransitionManager
{
public:
    QQuickDelayTransitionManager(QQuickDelayButton *button) : m_button(button) { }
 
    void transition(QQuickTransition *transition, qreal progress);
 
protected:
    void finished() override;
 
private:
    QQuickDelayButton *m_button = nullptr;
};
 
void QQuickDelayTransitionManager::transition(QQuickTransition *transition, qreal progress)
{
    qmlExecuteDeferred(transition);
 
    QQmlProperty defaultTarget(m_button, QLatin1String("progress"));
    QQmlListProperty<QQuickAbstractAnimation> animations = transition->animations();
    const int count = animations.count(&animations);
    for (int i = 0; i < count; ++i) {
        QQuickAbstractAnimation *anim = animations.at(&animations, i);
        anim->setDefaultTarget(defaultTarget);
    }
 
    QList<QQuickStateAction> actions;
    actions << QQuickStateAction(m_button, QLatin1String("progress"), progress);
    QQuickTransitionManager::transition(actions, transition, m_button);
}
 
void QQuickDelayTransitionManager::finished()
{
    if (qFuzzyCompare(m_button->progress(), qreal(1.0)))
        emit m_button->activated();
}
 
void QQuickDelayButtonPrivate::beginTransition(qreal to)
{
    Q_Q(QQuickDelayButton);
    if (!transition) {
        q->setProgress(to);
        finishTransition();
        return;
    }
 
    if (!transitionManager)
        transitionManager.reset(new QQuickDelayTransitionManager(q));
 
    transitionManager->transition(transition, to);
}
 
void QQuickDelayButtonPrivate::finishTransition()
{
    Q_Q(QQuickDelayButton);
    if (qFuzzyCompare(progress, qreal(1.0)))
        emit q->activated();
}
 
void QQuickDelayButtonPrivate::cancelTransition()
{
    if (transitionManager)
        transitionManager->cancel();
}
 
QQuickDelayButton::QQuickDelayButton(QQuickItem *parent)
    : QQuickAbstractButton(*(new QQuickDelayButtonPrivate), parent)
{
    Q_D(QQuickDelayButton);
    setCheckable(true);
    // DelayButton is designed to be pressed and held, not clicked, so a
    // keyboard mnemonic shortcut doesn't make sense for it.
    d->setMnemonicEnabled(false);
}
 
/*!
    \qmlproperty int QtQuick.Controls::DelayButton::delay
 
    This property holds the time it takes (in milliseconds) for \l progress
    to reach \c 1.0 and emit \l activated().
 
    The default value is \c 3000 ms.
*/
int QQuickDelayButton::delay() const
{
    Q_D(const QQuickDelayButton);
    return d->delay;
}
 
void QQuickDelayButton::setDelay(int delay)
{
    Q_D(QQuickDelayButton);
    if (d->delay == delay)
        return;
 
    d->delay = delay;
    emit delayChanged();
}
 
/*!
    \qmlproperty real QtQuick.Controls::DelayButton::progress
 
    This property holds the current progress as displayed by the progress
    indicator, in the range \c 0.0 - \c 1.0.
*/
qreal QQuickDelayButton::progress() const
{
    Q_D(const QQuickDelayButton);
    return d->progress;
}
 
void QQuickDelayButton::setProgress(qreal progress)
{
    Q_D(QQuickDelayButton);
    if (qFuzzyCompare(d->progress, progress))
        return;
 
    d->progress = progress;
    emit progressChanged();
}
 
/*!
    \qmlproperty Transition QtQuick.Controls::DelayButton::transition
 
    This property holds the transition that is applied on the \l progress
    property when the button is pressed or released.
*/
QQuickTransition *QQuickDelayButton::transition() const
{
    Q_D(const QQuickDelayButton);
    return d->transition;
}
 
void QQuickDelayButton::setTransition(QQuickTransition *transition)
{
    Q_D(QQuickDelayButton);
    if (d->transition == transition)
        return;
 
    d->transition = transition;
    emit transitionChanged();
}
 
void QQuickDelayButton::buttonChange(ButtonChange change)
{
    Q_D(QQuickDelayButton);
    switch (change) {
    case ButtonCheckedChange:
        d->cancelTransition();
        setProgress(d->checked ? 1.0 : 0.0);
        break;
    case ButtonPressedChanged:
        if (!d->checked)
            d->beginTransition(d->pressed ? 1.0 : 0.0);
        break;
    default:
        QQuickAbstractButton::buttonChange(change);
        break;
    }
}
 
void QQuickDelayButton::nextCheckState()
{
    Q_D(QQuickDelayButton);
    setChecked(!d->checked && qFuzzyCompare(d->progress, qreal(1.0)));
}
 
QFont QQuickDelayButton::defaultFont() const
{
    return QQuickTheme::font(QQuickTheme::Button);
}
 
QT_END_NAMESPACE
 
#include "moc_qquickdelaybutton_p.cpp"