Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qquickabstractbutton_p.h
Go to the documentation of this file.
1// Copyright (C) 2017 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QQUICKABSTRACTBUTTON_P_H
6#define QQUICKABSTRACTBUTTON_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <QtQuickTemplates2/private/qquickcontrol_p.h>
20#include <QtQuickTemplates2/private/qquickicon_p.h>
21
22QT_BEGIN_NAMESPACE
23
24class QQuickAction;
25class QQuickAbstractButtonPrivate;
26
27class Q_QUICKTEMPLATES2_EXPORT QQuickAbstractButton : public QQuickControl
28{
29 Q_OBJECT
30 Q_PROPERTY(QString text READ text WRITE setText RESET resetText NOTIFY textChanged FINAL)
31 Q_PROPERTY(bool down READ isDown WRITE setDown NOTIFY downChanged RESET resetDown FINAL)
32 Q_PROPERTY(bool pressed READ isPressed NOTIFY pressedChanged FINAL)
33 Q_PROPERTY(bool checked READ isChecked WRITE setChecked NOTIFY checkedChanged FINAL)
34 Q_PROPERTY(bool checkable READ isCheckable WRITE setCheckable NOTIFY checkableChanged FINAL)
35 Q_PROPERTY(bool autoExclusive READ autoExclusive WRITE setAutoExclusive NOTIFY autoExclusiveChanged FINAL)
36 Q_PROPERTY(bool autoRepeat READ autoRepeat WRITE setAutoRepeat NOTIFY autoRepeatChanged FINAL)
37 Q_PROPERTY(QQuickItem *indicator READ indicator WRITE setIndicator NOTIFY indicatorChanged FINAL)
38 // 2.3 (Qt 5.10)
39 Q_PROPERTY(QQuickIcon icon READ icon WRITE setIcon NOTIFY iconChanged FINAL REVISION(2, 3))
40 Q_PROPERTY(Display display READ display WRITE setDisplay NOTIFY displayChanged FINAL REVISION(2, 3))
41 Q_PROPERTY(QQuickAction *action READ action WRITE setAction NOTIFY actionChanged FINAL REVISION(2, 3))
42 // 2.4 (Qt 5.11)
43 Q_PROPERTY(int autoRepeatDelay READ autoRepeatDelay WRITE setAutoRepeatDelay NOTIFY autoRepeatDelayChanged FINAL REVISION(2, 4))
44 Q_PROPERTY(int autoRepeatInterval READ autoRepeatInterval WRITE setAutoRepeatInterval NOTIFY autoRepeatIntervalChanged FINAL REVISION(2, 4))
45 Q_PROPERTY(qreal pressX READ pressX NOTIFY pressXChanged FINAL REVISION(2, 4))
46 Q_PROPERTY(qreal pressY READ pressY NOTIFY pressYChanged FINAL REVISION(2, 4))
47 // 2.5 (Qt 5.12)
48 Q_PROPERTY(qreal implicitIndicatorWidth READ implicitIndicatorWidth NOTIFY implicitIndicatorWidthChanged FINAL REVISION(2, 5))
49 Q_PROPERTY(qreal implicitIndicatorHeight READ implicitIndicatorHeight NOTIFY implicitIndicatorHeightChanged FINAL REVISION(2, 5))
50 Q_CLASSINFO("DeferredPropertyNames", "background,contentItem,indicator")
51 QML_NAMED_ELEMENT(AbstractButton)
52 QML_ADDED_IN_VERSION(2, 0)
53
54public:
55 explicit QQuickAbstractButton(QQuickItem *parent = nullptr);
56 ~QQuickAbstractButton();
57
58 QString text() const;
59 void setText(const QString &text);
60 void resetText();
61
62 bool isDown() const;
63 void setDown(bool down);
64 void resetDown();
65
66 bool isPressed() const;
67 void setPressed(bool pressed);
68
69 bool isChecked() const;
70 void setChecked(bool checked);
71
72 bool isCheckable() const;
73 void setCheckable(bool checkable);
74
75 bool autoExclusive() const;
76 void setAutoExclusive(bool exclusive);
77
78 bool autoRepeat() const;
79 void setAutoRepeat(bool repeat);
80
81 QQuickItem *indicator() const;
82 void setIndicator(QQuickItem *indicator);
83
84 // 2.3 (Qt 5.10)
85 QQuickIcon icon() const;
86 void setIcon(const QQuickIcon &icon);
87
88 enum Display {
89 IconOnly,
90 TextOnly,
91 TextBesideIcon,
92 TextUnderIcon
93 };
94 Q_ENUM(Display)
95
96 Display display() const;
97 void setDisplay(Display display);
98
99 QQuickAction *action() const;
100 void setAction(QQuickAction *action);
101
102#if QT_CONFIG(shortcut)
103 QKeySequence shortcut() const;
104 void setShortcut(const QKeySequence &shortcut);
105#endif
106
107 // 2.4 (Qt 5.11)
108 int autoRepeatDelay() const;
109 void setAutoRepeatDelay(int delay);
110
111 int autoRepeatInterval() const;
112 void setAutoRepeatInterval(int interval);
113
114 qreal pressX() const;
115 qreal pressY() const;
116
117 // 2.5 (Qt 5.12)
118 qreal implicitIndicatorWidth() const;
119 qreal implicitIndicatorHeight() const;
120
121public Q_SLOTS:
122 void toggle();
123 Q_REVISION(6, 8) void click();
124 Q_REVISION(6, 8) void animateClick();
125
126Q_SIGNALS:
127 void pressed();
128 void released();
129 void canceled();
130 void clicked();
131 void pressAndHold();
132 void doubleClicked();
133 void textChanged();
134 void downChanged();
135 void pressedChanged();
136 void checkedChanged();
137 void checkableChanged();
138 void autoExclusiveChanged();
139 void autoRepeatChanged();
140 void indicatorChanged();
141 // 2.2 (Qt 5.9)
142 Q_REVISION(2, 2) void toggled();
143 // 2.3 (Qt 5.10)
144 Q_REVISION(2, 3) void iconChanged();
145 Q_REVISION(2, 3) void displayChanged();
146 Q_REVISION(2, 3) void actionChanged();
147 // 2.4 (Qt 5.11)
148 Q_REVISION(2, 4) void autoRepeatDelayChanged();
149 Q_REVISION(2, 4) void autoRepeatIntervalChanged();
150 Q_REVISION(2, 4) void pressXChanged();
151 Q_REVISION(2, 4) void pressYChanged();
152 // 2.5 (Qt 5.12)
153 Q_REVISION(2, 5) void implicitIndicatorWidthChanged();
154 Q_REVISION(2, 5) void implicitIndicatorHeightChanged();
155
156protected:
157 QQuickAbstractButton(QQuickAbstractButtonPrivate &dd, QQuickItem *parent);
158
159 void componentComplete() override;
160
161 bool event(QEvent *event) override;
162 void focusOutEvent(QFocusEvent *event) override;
163 void keyPressEvent(QKeyEvent *event) override;
164 void keyReleaseEvent(QKeyEvent *event) override;
165 void mousePressEvent(QMouseEvent *event) override;
166 void mouseDoubleClickEvent(QMouseEvent *event) override;
167 void timerEvent(QTimerEvent *event) override;
168
169 void itemChange(ItemChange change, const ItemChangeData &value) override;
170
171 enum ButtonChange {
172 ButtonCheckedChange,
173 ButtonCheckableChange,
174 ButtonPressedChanged,
175 ButtonTextChange
176 };
177 virtual void buttonChange(ButtonChange change);
178
179 virtual void nextCheckState();
180
181#if QT_CONFIG(accessibility)
182 void accessibilityActiveChanged(bool active) override;
183 QAccessible::Role accessibleRole() const override;
184 Q_INVOKABLE void accessiblePressAction();
185#endif
186
187private:
188 Q_DISABLE_COPY(QQuickAbstractButton)
189 Q_DECLARE_PRIVATE(QQuickAbstractButton)
190};
191
192QT_END_NAMESPACE
193
194#endif // QQUICKABSTRACTBUTTON_P_H