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
qquickcontrol_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 QQUICKCONTROL_P_H
6#define QQUICKCONTROL_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 <QtCore/qlocale.h>
20#include <QtGui/qpalette.h>
21#if QT_CONFIG(accessibility)
22#include <QtGui/qaccessible_base.h>
23#endif
24#include <QtQuick/qquickitem.h>
25#include <QtQuick/private/qquickpalette_p.h>
26#include <QtQuickTemplates2/private/qtquicktemplates2global_p.h>
27
28QT_BEGIN_NAMESPACE
29
30class QQuickControlPrivate;
31
32class Q_QUICKTEMPLATES2_EXPORT QQuickControl : public QQuickItem
33{
34 Q_OBJECT
35 Q_PROPERTY(QFont font READ font WRITE setFont RESET resetFont NOTIFY fontChanged FINAL)
36 Q_PROPERTY(qreal availableWidth READ availableWidth NOTIFY availableWidthChanged FINAL)
37 Q_PROPERTY(qreal availableHeight READ availableHeight NOTIFY availableHeightChanged FINAL)
38 Q_PROPERTY(qreal padding READ padding WRITE setPadding RESET resetPadding NOTIFY paddingChanged FINAL)
39 Q_PROPERTY(qreal topPadding READ topPadding WRITE setTopPadding RESET resetTopPadding NOTIFY topPaddingChanged FINAL)
40 Q_PROPERTY(qreal leftPadding READ leftPadding WRITE setLeftPadding RESET resetLeftPadding NOTIFY leftPaddingChanged FINAL)
41 Q_PROPERTY(qreal rightPadding READ rightPadding WRITE setRightPadding RESET resetRightPadding NOTIFY rightPaddingChanged FINAL)
42 Q_PROPERTY(qreal bottomPadding READ bottomPadding WRITE setBottomPadding RESET resetBottomPadding NOTIFY bottomPaddingChanged FINAL)
43 Q_PROPERTY(qreal spacing READ spacing WRITE setSpacing RESET resetSpacing NOTIFY spacingChanged FINAL)
44 Q_PROPERTY(QLocale locale READ locale WRITE setLocale RESET resetLocale NOTIFY localeChanged FINAL)
45 Q_PROPERTY(bool mirrored READ isMirrored NOTIFY mirroredChanged FINAL)
46 QT6_ONLY(Q_PROPERTY(Qt::FocusPolicy focusPolicy READ focusPolicy WRITE setFocusPolicy NOTIFY focusPolicyChanged FINAL))
47 Q_PROPERTY(Qt::FocusReason focusReason READ focusReason WRITE setFocusReason NOTIFY focusReasonChanged FINAL)
48 Q_PROPERTY(bool visualFocus READ hasVisualFocus NOTIFY visualFocusChanged FINAL)
49 Q_PROPERTY(bool hovered READ isHovered NOTIFY hoveredChanged FINAL)
50 Q_PROPERTY(bool hoverEnabled READ isHoverEnabled WRITE setHoverEnabled RESET resetHoverEnabled NOTIFY hoverEnabledChanged FINAL)
51 Q_PROPERTY(bool wheelEnabled READ isWheelEnabled WRITE setWheelEnabled NOTIFY wheelEnabledChanged FINAL)
52 Q_PROPERTY(QQuickItem *background READ background WRITE setBackground NOTIFY backgroundChanged FINAL)
53 Q_PROPERTY(QQuickItem *contentItem READ contentItem WRITE setContentItem NOTIFY contentItemChanged FINAL)
54 Q_PROPERTY(qreal baselineOffset READ baselineOffset WRITE setBaselineOffset RESET resetBaselineOffset NOTIFY baselineOffsetChanged FINAL)
55 // 2.5 (Qt 5.12)
56 Q_PROPERTY(qreal horizontalPadding READ horizontalPadding WRITE setHorizontalPadding RESET resetHorizontalPadding NOTIFY horizontalPaddingChanged FINAL REVISION(2, 5))
57 Q_PROPERTY(qreal verticalPadding READ verticalPadding WRITE setVerticalPadding RESET resetVerticalPadding NOTIFY verticalPaddingChanged FINAL REVISION(2, 5))
58 Q_PROPERTY(qreal implicitContentWidth READ implicitContentWidth NOTIFY implicitContentWidthChanged FINAL REVISION(2, 5))
59 Q_PROPERTY(qreal implicitContentHeight READ implicitContentHeight NOTIFY implicitContentHeightChanged FINAL REVISION(2, 5))
60 Q_PROPERTY(qreal implicitBackgroundWidth READ implicitBackgroundWidth NOTIFY implicitBackgroundWidthChanged FINAL REVISION(2, 5))
61 Q_PROPERTY(qreal implicitBackgroundHeight READ implicitBackgroundHeight NOTIFY implicitBackgroundHeightChanged FINAL REVISION(2, 5))
62 Q_PROPERTY(qreal topInset READ topInset WRITE setTopInset RESET resetTopInset NOTIFY topInsetChanged FINAL REVISION(2, 5))
63 Q_PROPERTY(qreal leftInset READ leftInset WRITE setLeftInset RESET resetLeftInset NOTIFY leftInsetChanged FINAL REVISION(2, 5))
64 Q_PROPERTY(qreal rightInset READ rightInset WRITE setRightInset RESET resetRightInset NOTIFY rightInsetChanged FINAL REVISION(2, 5))
65 Q_PROPERTY(qreal bottomInset READ bottomInset WRITE setBottomInset RESET resetBottomInset NOTIFY bottomInsetChanged FINAL REVISION(2, 5))
66 Q_CLASSINFO("DeferredPropertyNames", "background,contentItem")
67 QML_NAMED_ELEMENT(Control)
68 QML_ADDED_IN_VERSION(2, 0)
69
70public:
71 explicit QQuickControl(QQuickItem *parent = nullptr);
72 ~QQuickControl();
73
74 QFont font() const;
75 void setFont(const QFont &font);
76 void resetFont();
77
78 qreal availableWidth() const;
79 qreal availableHeight() const;
80
81 qreal padding() const;
82 void setPadding(qreal padding);
83 void resetPadding();
84
85 qreal topPadding() const;
86 void setTopPadding(qreal padding);
87 void resetTopPadding();
88
89 qreal leftPadding() const;
90 void setLeftPadding(qreal padding);
91 void resetLeftPadding();
92
93 qreal rightPadding() const;
94 void setRightPadding(qreal padding);
95 void resetRightPadding();
96
97 qreal bottomPadding() const;
98 void setBottomPadding(qreal padding);
99 void resetBottomPadding();
100
101 qreal spacing() const;
102 void setSpacing(qreal spacing);
103 void resetSpacing();
104
105 QLocale locale() const;
106 void setLocale(const QLocale &locale);
107 void resetLocale();
108
109 bool isMirrored() const;
110
111 Qt::FocusReason focusReason() const;
112 void setFocusReason(Qt::FocusReason reason);
113
114 bool hasVisualFocus() const;
115
116 bool isHovered() const;
117 void setHovered(bool hovered);
118
119 bool isHoverEnabled() const;
120 void setHoverEnabled(bool enabled);
121 void resetHoverEnabled();
122
123 bool isWheelEnabled() const;
124 void setWheelEnabled(bool enabled);
125
126 QQuickItem *background() const;
127 void setBackground(QQuickItem *background);
128
129 QQuickItem *contentItem() const;
130 void setContentItem(QQuickItem *item);
131
132 qreal baselineOffset() const;
133 void setBaselineOffset(qreal offset);
134 void resetBaselineOffset();
135
136 // 2.5 (Qt 5.12)
137 qreal horizontalPadding() const;
138 void setHorizontalPadding(qreal padding);
139 void resetHorizontalPadding();
140
141 qreal verticalPadding() const;
142 void setVerticalPadding(qreal padding);
143 void resetVerticalPadding();
144
145 qreal implicitContentWidth() const;
146 qreal implicitContentHeight() const;
147
148 qreal implicitBackgroundWidth() const;
149 qreal implicitBackgroundHeight() const;
150
151 qreal topInset() const;
152 void setTopInset(qreal inset);
153 void resetTopInset();
154
155 qreal leftInset() const;
156 void setLeftInset(qreal inset);
157 void resetLeftInset();
158
159 qreal rightInset() const;
160 void setRightInset(qreal inset);
161 void resetRightInset();
162
163 qreal bottomInset() const;
164 void setBottomInset(qreal inset);
165 void resetBottomInset();
166
167Q_SIGNALS:
168 void fontChanged();
169 void availableWidthChanged();
170 void availableHeightChanged();
171 void paddingChanged();
172 void topPaddingChanged();
173 void leftPaddingChanged();
174 void rightPaddingChanged();
175 void bottomPaddingChanged();
176 void spacingChanged();
177 void localeChanged();
178 void focusReasonChanged();
179 void mirroredChanged();
180 void visualFocusChanged();
181 void hoveredChanged();
182 void hoverEnabledChanged();
183 void wheelEnabledChanged();
184 void backgroundChanged();
185 void contentItemChanged();
186 void baselineOffsetChanged();
187 // 2.5 (Qt 5.12)
188 Q_REVISION(2, 5) void horizontalPaddingChanged();
189 Q_REVISION(2, 5) void verticalPaddingChanged();
190 Q_REVISION(2, 5) void implicitContentWidthChanged();
191 Q_REVISION(2, 5) void implicitContentHeightChanged();
192 Q_REVISION(2, 5) void implicitBackgroundWidthChanged();
193 Q_REVISION(2, 5) void implicitBackgroundHeightChanged();
194 Q_REVISION(2, 5) void topInsetChanged();
195 Q_REVISION(2, 5) void leftInsetChanged();
196 Q_REVISION(2, 5) void rightInsetChanged();
197 Q_REVISION(2, 5) void bottomInsetChanged();
198
199protected:
200 virtual QFont defaultFont() const;
201
202 QQuickControl(QQuickControlPrivate &dd, QQuickItem *parent);
203
204 void classBegin() override;
205 void componentComplete() override;
206
207 void itemChange(ItemChange change, const ItemChangeData &value) override;
208
209 void focusInEvent(QFocusEvent *event) override;
210 void focusOutEvent(QFocusEvent *event) override;
211#if QT_CONFIG(quicktemplates2_hover)
212 void hoverEnterEvent(QHoverEvent *event) override;
213 void hoverMoveEvent(QHoverEvent *event) override;
214 void hoverLeaveEvent(QHoverEvent *event) override;
215#endif
216 void mousePressEvent(QMouseEvent *event) override;
217 void mouseMoveEvent(QMouseEvent *event) override;
218 void mouseReleaseEvent(QMouseEvent *event) override;
219 void mouseUngrabEvent() override;
220#if QT_CONFIG(quicktemplates2_multitouch)
221 void touchEvent(QTouchEvent *event) override;
222 void touchUngrabEvent() override;
223#endif
224#if QT_CONFIG(wheelevent)
225 void wheelEvent(QWheelEvent *event) override;
226#endif
227
228 void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry) override;
229
230 virtual void fontChange(const QFont &newFont, const QFont &oldFont);
231#if QT_CONFIG(quicktemplates2_hover)
232 virtual void hoverChange();
233#endif
234 virtual void mirrorChange();
235 virtual void spacingChange(qreal newSpacing, qreal oldSpacing);
236 virtual void paddingChange(const QMarginsF &newPadding, const QMarginsF &oldPadding);
237 virtual void contentItemChange(QQuickItem *newItem, QQuickItem *oldItem);
238 virtual void localeChange(const QLocale &newLocale, const QLocale &oldLocale);
239 virtual void insetChange(const QMarginsF &newInset, const QMarginsF &oldInset);
240 virtual void enabledChange();
241
242#if QT_CONFIG(accessibility)
243 virtual QAccessible::Role accessibleRole() const;
244 virtual void accessibilityActiveChanged(bool active);
245#endif
246
247 // helper functions which avoid to check QT_CONFIG(accessibility)
248 QString accessibleName() const;
249 void maybeSetAccessibleName(const QString &name);
250
251 QVariant accessibleProperty(const char *propertyName);
252 bool setAccessibleProperty(const char *propertyName, const QVariant &value);
253
254private:
255 Q_DISABLE_COPY(QQuickControl)
256 Q_DECLARE_PRIVATE(QQuickControl)
257};
258
259QT_END_NAMESPACE
260
261#endif // QQUICKCONTROL_P_H
QAccessibleQuickControl::interface_cast
void * interface_cast(QAccessible::InterfaceType t) override
Definition qaccessiblequickcontrol.cpp:15
QAccessibleQuickControl::attributeValue
virtual QVariant attributeValue(QAccessible::Attribute key) const override
Definition qaccessiblequickcontrol.cpp:28
QAccessibleQuickControl::attributeKeys
virtual QList< QAccessible::Attribute > attributeKeys() const override
Definition qaccessiblequickcontrol.cpp:23
QAccessibleQuickControl::QAccessibleQuickControl
QAccessibleQuickControl(QQuickControl *control)
Definition qaccessiblequickcontrol.cpp:10
QMediaRecorderPrivate::control
QPlatformMediaRecorder * control
Definition qmediarecorder_p.h:39