blob: 0fa48980ed8a774d8ccb481df8e71647cd4ceda0 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Quick Templates 2 module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QQUICKABSTRACTBUTTON_P_H
#define QQUICKABSTRACTBUTTON_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/qquickicon_p.h>
QT_BEGIN_NAMESPACE
class QQuickAction;
class QQuickAbstractButtonPrivate;
class Q_QUICKTEMPLATES2_PRIVATE_EXPORT QQuickAbstractButton : public QQuickControl
{
Q_OBJECT
Q_PROPERTY(QString text READ text WRITE setText RESET resetText NOTIFY textChanged FINAL)
Q_PROPERTY(bool down READ isDown WRITE setDown NOTIFY downChanged RESET resetDown FINAL)
Q_PROPERTY(bool pressed READ isPressed NOTIFY pressedChanged FINAL)
Q_PROPERTY(bool checked READ isChecked WRITE setChecked NOTIFY checkedChanged FINAL)
Q_PROPERTY(bool checkable READ isCheckable WRITE setCheckable NOTIFY checkableChanged FINAL)
Q_PROPERTY(bool autoExclusive READ autoExclusive WRITE setAutoExclusive NOTIFY autoExclusiveChanged FINAL)
Q_PROPERTY(bool autoRepeat READ autoRepeat WRITE setAutoRepeat NOTIFY autoRepeatChanged FINAL)
Q_PROPERTY(QQuickItem *indicator READ indicator WRITE setIndicator NOTIFY indicatorChanged FINAL)
// 2.3 (Qt 5.10)
Q_PROPERTY(QQuickIcon icon READ icon WRITE setIcon NOTIFY iconChanged FINAL REVISION 3)
Q_PROPERTY(Display display READ display WRITE setDisplay NOTIFY displayChanged FINAL REVISION 3)
Q_PROPERTY(QQuickAction *action READ action WRITE setAction NOTIFY actionChanged FINAL REVISION 3)
// 2.4 (Qt 5.11)
Q_PROPERTY(int autoRepeatDelay READ autoRepeatDelay WRITE setAutoRepeatDelay NOTIFY autoRepeatDelayChanged FINAL REVISION 4)
Q_PROPERTY(int autoRepeatInterval READ autoRepeatInterval WRITE setAutoRepeatInterval NOTIFY autoRepeatIntervalChanged FINAL REVISION 4)
Q_PROPERTY(qreal pressX READ pressX NOTIFY pressXChanged FINAL REVISION 4)
Q_PROPERTY(qreal pressY READ pressY NOTIFY pressYChanged FINAL REVISION 4)
// 2.5 (Qt 5.12)
Q_PROPERTY(qreal implicitIndicatorWidth READ implicitIndicatorWidth NOTIFY implicitIndicatorWidthChanged FINAL REVISION 5)
Q_PROPERTY(qreal implicitIndicatorHeight READ implicitIndicatorHeight NOTIFY implicitIndicatorHeightChanged FINAL REVISION 5)
Q_CLASSINFO("DeferredPropertyNames", "background,contentItem,indicator")
public:
explicit QQuickAbstractButton(QQuickItem *parent = nullptr);
~QQuickAbstractButton();
QString text() const;
void setText(const QString &text);
void resetText();
bool isDown() const;
void setDown(bool down);
void resetDown();
bool isPressed() const;
void setPressed(bool pressed);
bool isChecked() const;
void setChecked(bool checked);
bool isCheckable() const;
void setCheckable(bool checkable);
bool autoExclusive() const;
void setAutoExclusive(bool exclusive);
bool autoRepeat() const;
void setAutoRepeat(bool repeat);
QQuickItem *indicator() const;
void setIndicator(QQuickItem *indicator);
// 2.3 (Qt 5.10)
QQuickIcon icon() const;
void setIcon(const QQuickIcon &icon);
enum Display {
IconOnly,
TextOnly,
TextBesideIcon,
TextUnderIcon
};
Q_ENUM(Display)
Display display() const;
void setDisplay(Display display);
QQuickAction *action() const;
void setAction(QQuickAction *action);
#if QT_CONFIG(shortcut)
QKeySequence shortcut() const;
void setShortcut(const QKeySequence &shortcut);
#endif
// 2.4 (Qt 5.11)
int autoRepeatDelay() const;
void setAutoRepeatDelay(int delay);
int autoRepeatInterval() const;
void setAutoRepeatInterval(int interval);
qreal pressX() const;
qreal pressY() const;
// 2.5 (Qt 5.12)
qreal implicitIndicatorWidth() const;
qreal implicitIndicatorHeight() const;
public Q_SLOTS:
void toggle();
Q_SIGNALS:
void pressed();
void released();
void canceled();
void clicked();
void pressAndHold();
void doubleClicked();
void textChanged();
void downChanged();
void pressedChanged();
void checkedChanged();
void checkableChanged();
void autoExclusiveChanged();
void autoRepeatChanged();
void indicatorChanged();
// 2.2 (Qt 5.9)
Q_REVISION(2) void toggled();
// 2.3 (Qt 5.10)
Q_REVISION(3) void iconChanged();
Q_REVISION(3) void displayChanged();
Q_REVISION(3) void actionChanged();
// 2.4 (Qt 5.11)
Q_REVISION(4) void autoRepeatDelayChanged();
Q_REVISION(4) void autoRepeatIntervalChanged();
Q_REVISION(4) void pressXChanged();
Q_REVISION(4) void pressYChanged();
// 2.5 (Qt 5.12)
Q_REVISION(5) void implicitIndicatorWidthChanged();
Q_REVISION(5) void implicitIndicatorHeightChanged();
protected:
QQuickAbstractButton(QQuickAbstractButtonPrivate &dd, QQuickItem *parent);
void componentComplete() override;
bool event(QEvent *event) override;
void focusOutEvent(QFocusEvent *event) override;
void keyPressEvent(QKeyEvent *event) override;
void keyReleaseEvent(QKeyEvent *event) override;
void mousePressEvent(QMouseEvent *event) override;
void mouseDoubleClickEvent(QMouseEvent *event) override;
void timerEvent(QTimerEvent *event) override;
void itemChange(ItemChange change, const ItemChangeData &value) override;
enum ButtonChange {
ButtonCheckedChange,
ButtonCheckableChange,
ButtonPressedChanged,
ButtonTextChange
};
virtual void buttonChange(ButtonChange change);
virtual void nextCheckState();
#if QT_CONFIG(accessibility)
void accessibilityActiveChanged(bool active) override;
QAccessible::Role accessibleRole() const override;
#endif
private:
Q_DISABLE_COPY(QQuickAbstractButton)
Q_DECLARE_PRIVATE(QQuickAbstractButton)
};
QT_END_NAMESPACE
QML_DECLARE_TYPE(QQuickAbstractButton)
#endif // QQUICKABSTRACTBUTTON_P_H