qquickscrollbar_p.h

Enable keyboard shortcuts

// 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

#ifndef QQUICKSCROLLBAR_P_H

#define QQUICKSCROLLBAR_P_H

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

//

#include <QtQuickTemplates2/private/qquickcontrol_p.h>

#include <QtQuickTemplates2/private/qquickindicatorbutton_p.h>

QT_BEGIN_NAMESPACE

class QQuickScrollBarAttached;

class QQuickScrollBarPrivate;

class Q_QUICKTEMPLATES2_EXPORT QQuickScrollBar : public QQuickControl

    Q_OBJECT

    Q_PROPERTY(qreal size READ size WRITE setSize NOTIFY sizeChanged FINAL)

    Q_PROPERTY(qreal position READ position WRITE setPosition NOTIFY positionChanged FINAL)

    Q_PROPERTY(qreal stepSize READ stepSize WRITE setStepSize NOTIFY stepSizeChanged FINAL)

    Q_PROPERTY(bool active READ isActive WRITE setActive NOTIFY activeChanged FINAL)

    Q_PROPERTY(bool pressed READ isPressed WRITE setPressed NOTIFY pressedChanged FINAL)

    Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation NOTIFY orientationChanged FINAL)

    // 2.2 (Qt 5.9)

    Q_PROPERTY(SnapMode snapMode READ snapMode WRITE setSnapMode NOTIFY snapModeChanged FINAL REVISION(2, 2))

    Q_PROPERTY(bool interactive READ isInteractive WRITE setInteractive RESET resetInteractive NOTIFY interactiveChanged FINAL REVISION(2, 2))

    Q_PROPERTY(Policy policy READ policy WRITE setPolicy NOTIFY policyChanged FINAL REVISION(2, 2))

    // 2.3 (Qt 5.10)

    Q_PROPERTY(bool horizontal READ isHorizontal NOTIFY orientationChanged FINAL REVISION(2, 3))

    Q_PROPERTY(bool vertical READ isVertical NOTIFY orientationChanged FINAL REVISION(2, 3))

    // 2.4 (Qt 5.11)

    Q_PROPERTY(qreal minimumSize READ minimumSize WRITE setMinimumSize NOTIFY minimumSizeChanged FINAL REVISION(2, 4))

    Q_PROPERTY(qreal visualSize READ visualSize NOTIFY visualSizeChanged FINAL REVISION(2, 4))

    Q_PROPERTY(qreal visualPosition READ visualPosition NOTIFY visualPositionChanged FINAL REVISION(2, 4))

    Q_PROPERTY(QQuickIndicatorButton *__decreaseVisual READ decreaseVisual CONSTANT FINAL)

    Q_PROPERTY(QQuickIndicatorButton *__increaseVisual READ increaseVisual CONSTANT FINAL)

    QML_NAMED_ELEMENT(ScrollBar)

    QML_ATTACHED(QQuickScrollBarAttached)

    QML_ADDED_IN_VERSION(2, 0)

public:

    explicit QQuickScrollBar(QQuickItem *parent = nullptr);

    static QQuickScrollBarAttached *qmlAttachedProperties(QObject *object);

    qreal size() const;

    qreal position() const;

    qreal stepSize() const;

    void setStepSize(qreal step);

    bool isActive() const;

    void setActive(bool active);

    bool isPressed() const;

    void setPressed(bool pressed);

    Qt::Orientation orientation() const;

    void setOrientation(Qt::Orientation orientation);

    // 2.2 (Qt 5.9)

    enum SnapMode {

        NoSnap,

        SnapAlways,

        SnapOnRelease

};

    Q_ENUM(SnapMode)

    SnapMode snapMode() const;

    void setSnapMode(SnapMode mode);

    bool isInteractive() const;

    void setInteractive(bool interactive);

    void resetInteractive();

    enum Policy {

        AsNeeded = Qt::ScrollBarAsNeeded,

        AlwaysOff = Qt::ScrollBarAlwaysOff,

        AlwaysOn = Qt::ScrollBarAlwaysOn

};

    Q_ENUM(Policy)

    Policy policy() const;

    void setPolicy(Policy policy);

    // 2.3 (Qt 5.10)

    bool isHorizontal() const;

    bool isVertical() const;

    // 2.4 (Qt 5.11)

    qreal minimumSize() const;

    void setMinimumSize(qreal minimumSize);

    qreal visualSize() const;

    qreal visualPosition() const;

    QQuickIndicatorButton *decreaseVisual();

    QQuickIndicatorButton *increaseVisual();

public Q_SLOTS:

    void increase();

    void decrease();

    void setSize(qreal size);

    void setPosition(qreal position);

Q_SIGNALS:

    void sizeChanged();

    void positionChanged();

    void stepSizeChanged();

    void activeChanged();

    void pressedChanged();

    void orientationChanged();

    // 2.2 (Qt 5.9)

    Q_REVISION(2, 2) void snapModeChanged();

    Q_REVISION(2, 2) void interactiveChanged();

    Q_REVISION(2, 2) void policyChanged();

    // 2.4 (Qt 5.11)

    Q_REVISION(2, 4) void minimumSizeChanged();

    Q_REVISION(2, 4) void visualSizeChanged();

    Q_REVISION(2, 4) void visualPositionChanged();

protected:

    void mousePressEvent(QMouseEvent *event) override;

#if QT_CONFIG(quicktemplates2_hover)

    void hoverChange() override;

    void hoverEnterEvent(QHoverEvent *event) override;

    void hoverMoveEvent(QHoverEvent *event) override;

    void hoverLeaveEvent(QHoverEvent *event) override;

#endif

    void classBegin() override;

    void componentComplete() override;

#if QT_CONFIG(accessibility)

    void accessibilityActiveChanged(bool active) override;

    QAccessible::Role accessibleRole() const override;

#endif

private:

    Q_DISABLE_COPY(QQuickScrollBar)

    Q_DECLARE_PRIVATE(QQuickScrollBar)

};

class QQuickScrollBarAttachedPrivate;

class Q_QUICKTEMPLATES2_EXPORT QQuickScrollBarAttached : public QObject

    Q_OBJECT

    Q_PROPERTY(QQuickScrollBar *horizontal READ horizontal WRITE setHorizontal NOTIFY horizontalChanged FINAL)

    Q_PROPERTY(QQuickScrollBar *vertical READ vertical WRITE setVertical NOTIFY verticalChanged FINAL)

public:

    explicit QQuickScrollBarAttached(QObject *parent = nullptr);

    ~QQuickScrollBarAttached();

    QQuickScrollBar *horizontal() const;

    void setHorizontal(QQuickScrollBar *horizontal);

    QQuickScrollBar *vertical() const;

    void setVertical(QQuickScrollBar *vertical);

Q_SIGNALS:

    void horizontalChanged();

    void verticalChanged();

private:

    Q_DISABLE_COPY(QQuickScrollBarAttached)

    Q_DECLARE_PRIVATE(QQuickScrollBarAttached)

};

QT_END_NAMESPACE

#endif // QQUICKSCROLLBAR_P_H