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
qquickpopup_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 QQUICKPOPUP_P_H
6#define QQUICKPOPUP_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/qobject.h>
20#include <QtCore/qmargins.h>
21#include <QtGui/qevent.h>
22#include <QtCore/qlocale.h>
23#include <QtGui/qfont.h>
24#include <QtGui/qpalette.h>
25#include <QtQuickTemplates2/private/qtquicktemplates2global_p.h>
26#include <QtQml/qqml.h>
27#include <QtQml/qqmllist.h>
28#include <QtQml/qqmlparserstatus.h>
29#include <QtQuick/qquickitem.h>
30#include <QtQuick/private/qquicksafearea_p.h>
31#include <QtQuick/private/qquickattachedpropertypropagatortarget_p.h>
32
33#if QT_CONFIG(accessibility)
34#include <QtGui/qaccessible.h>
35#endif
36
37QT_BEGIN_NAMESPACE
38
39class QQuickWindow;
40class QQuickPopupAnchors;
41class QQuickPopupPrivate;
42class QQuickTransition;
43
44class Q_QUICKTEMPLATES2_EXPORT QQuickPopup
45 : public QObject
46 , public QQmlParserStatus
47 , private QQuickSafeAreaAttachable
48 , public QQuickAttachedPropertyPropagatorTarget
49{
50 Q_OBJECT
51 Q_INTERFACES(QQmlParserStatus)
52 Q_INTERFACES(QQuickSafeAreaAttachable)
53 Q_INTERFACES(QQuickAttachedPropertyPropagatorTarget)
54 Q_PROPERTY(qreal x READ x WRITE setX NOTIFY xChanged FINAL)
55 Q_PROPERTY(qreal y READ y WRITE setY NOTIFY yChanged FINAL)
56 Q_PROPERTY(qreal z READ z WRITE setZ RESET resetZ NOTIFY zChanged FINAL)
57 Q_PROPERTY(qreal width READ width WRITE setWidth RESET resetWidth NOTIFY widthChanged FINAL)
58 Q_PROPERTY(qreal height READ height WRITE setHeight RESET resetHeight NOTIFY heightChanged FINAL)
59 Q_PROPERTY(qreal implicitWidth READ implicitWidth WRITE setImplicitWidth NOTIFY implicitWidthChanged FINAL)
60 Q_PROPERTY(qreal implicitHeight READ implicitHeight WRITE setImplicitHeight NOTIFY implicitHeightChanged FINAL)
61 Q_PROPERTY(qreal contentWidth READ contentWidth WRITE setContentWidth NOTIFY contentWidthChanged FINAL)
62 Q_PROPERTY(qreal contentHeight READ contentHeight WRITE setContentHeight NOTIFY contentHeightChanged FINAL)
63 Q_PROPERTY(qreal availableWidth READ availableWidth NOTIFY availableWidthChanged FINAL)
64 Q_PROPERTY(qreal availableHeight READ availableHeight NOTIFY availableHeightChanged FINAL)
65 Q_PROPERTY(qreal margins READ margins WRITE setMargins RESET resetMargins NOTIFY marginsChanged FINAL)
66 Q_PROPERTY(qreal topMargin READ topMargin WRITE setTopMargin RESET resetTopMargin NOTIFY topMarginChanged FINAL)
67 Q_PROPERTY(qreal leftMargin READ leftMargin WRITE setLeftMargin RESET resetLeftMargin NOTIFY leftMarginChanged FINAL)
68 Q_PROPERTY(qreal rightMargin READ rightMargin WRITE setRightMargin RESET resetRightMargin NOTIFY rightMarginChanged FINAL)
69 Q_PROPERTY(qreal bottomMargin READ bottomMargin WRITE setBottomMargin RESET resetBottomMargin NOTIFY bottomMarginChanged FINAL)
70 Q_PROPERTY(qreal padding READ padding WRITE setPadding RESET resetPadding NOTIFY paddingChanged FINAL)
71 Q_PROPERTY(qreal topPadding READ topPadding WRITE setTopPadding RESET resetTopPadding NOTIFY topPaddingChanged FINAL)
72 Q_PROPERTY(qreal leftPadding READ leftPadding WRITE setLeftPadding RESET resetLeftPadding NOTIFY leftPaddingChanged FINAL)
73 Q_PROPERTY(qreal rightPadding READ rightPadding WRITE setRightPadding RESET resetRightPadding NOTIFY rightPaddingChanged FINAL)
74 Q_PROPERTY(qreal bottomPadding READ bottomPadding WRITE setBottomPadding RESET resetBottomPadding NOTIFY bottomPaddingChanged FINAL)
75 Q_PROPERTY(QLocale locale READ locale WRITE setLocale RESET resetLocale NOTIFY localeChanged FINAL)
76 Q_PROPERTY(QFont font READ font WRITE setFont RESET resetFont NOTIFY fontChanged FINAL)
77 Q_PROPERTY(QQuickItem *parent READ parentItem WRITE setParentItem RESET resetParentItem NOTIFY parentChanged FINAL)
78 Q_PROPERTY(QQuickItem *background READ background WRITE setBackground NOTIFY backgroundChanged FINAL)
79 Q_PROPERTY(QQuickItem *contentItem READ contentItem WRITE setContentItem NOTIFY contentItemChanged FINAL)
80 Q_PRIVATE_PROPERTY(QQuickPopup::d_func(), QQmlListProperty<QObject> contentData READ contentData VIRTUAL)
81 Q_PRIVATE_PROPERTY(QQuickPopup::d_func(), QQmlListProperty<QQuickItem> contentChildren READ contentChildren NOTIFY contentChildrenChanged FINAL)
82 Q_PROPERTY(bool clip READ clip WRITE setClip NOTIFY clipChanged FINAL)
83 Q_PROPERTY(bool focus READ hasFocus WRITE setFocus NOTIFY focusChanged FINAL)
84 Q_PROPERTY(bool activeFocus READ hasActiveFocus NOTIFY activeFocusChanged FINAL)
85 Q_PROPERTY(bool modal READ isModal WRITE setModal NOTIFY modalChanged FINAL)
86 Q_PROPERTY(bool dim READ dim WRITE setDim RESET resetDim NOTIFY dimChanged FINAL)
87 Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged FINAL)
88 Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged FINAL)
89 Q_PROPERTY(qreal scale READ scale WRITE setScale NOTIFY scaleChanged FINAL)
90 Q_PROPERTY(ClosePolicy closePolicy READ closePolicy WRITE setClosePolicy RESET resetClosePolicy NOTIFY closePolicyChanged FINAL)
91 Q_PROPERTY(TransformOrigin transformOrigin READ transformOrigin WRITE setTransformOrigin FINAL)
92 Q_PROPERTY(QQuickTransition *enter READ enter WRITE setEnter NOTIFY enterChanged FINAL)
93 Q_PROPERTY(QQuickTransition *exit READ exit WRITE setExit NOTIFY exitChanged FINAL)
94 // 2.1 (Qt 5.8)
95 Q_PROPERTY(qreal spacing READ spacing WRITE setSpacing RESET resetSpacing NOTIFY spacingChanged FINAL REVISION(2, 1))
96 // 2.3 (Qt 5.10)
97 Q_PROPERTY(bool opened READ isOpened NOTIFY openedChanged FINAL REVISION(2, 3))
98 Q_PROPERTY(bool mirrored READ isMirrored NOTIFY mirroredChanged FINAL REVISION(2, 3))
99 Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled NOTIFY enabledChanged FINAL REVISION(2, 3))
100 Q_PRIVATE_PROPERTY(QQuickPopup::d_func(), QQuickPalette *palette READ palette WRITE setPalette RESET resetPalette NOTIFY paletteChanged REVISION(2, 3))
101 // 2.5 (Qt 5.12)
102 Q_PROPERTY(qreal horizontalPadding READ horizontalPadding WRITE setHorizontalPadding RESET resetHorizontalPadding NOTIFY horizontalPaddingChanged FINAL)
103 Q_PROPERTY(qreal verticalPadding READ verticalPadding WRITE setVerticalPadding RESET resetVerticalPadding NOTIFY verticalPaddingChanged FINAL)
104 Q_PRIVATE_PROPERTY(QQuickPopup::d_func(), QQuickPopupAnchors *anchors READ getAnchors DESIGNABLE false CONSTANT FINAL REVISION(2, 5))
105 Q_PROPERTY(qreal implicitContentWidth READ implicitContentWidth NOTIFY implicitContentWidthChanged FINAL REVISION(2, 5))
106 Q_PROPERTY(qreal implicitContentHeight READ implicitContentHeight NOTIFY implicitContentHeightChanged FINAL REVISION(2, 5))
107 Q_PROPERTY(qreal implicitBackgroundWidth READ implicitBackgroundWidth NOTIFY implicitBackgroundWidthChanged FINAL REVISION(2, 5))
108 Q_PROPERTY(qreal implicitBackgroundHeight READ implicitBackgroundHeight NOTIFY implicitBackgroundHeightChanged FINAL REVISION(2, 5))
109 Q_PROPERTY(qreal topInset READ topInset WRITE setTopInset RESET resetTopInset NOTIFY topInsetChanged FINAL REVISION(2, 5))
110 Q_PROPERTY(qreal leftInset READ leftInset WRITE setLeftInset RESET resetLeftInset NOTIFY leftInsetChanged FINAL REVISION(2, 5))
111 Q_PROPERTY(qreal rightInset READ rightInset WRITE setRightInset RESET resetRightInset NOTIFY rightInsetChanged FINAL REVISION(2, 5))
112 Q_PROPERTY(qreal bottomInset READ bottomInset WRITE setBottomInset RESET resetBottomInset NOTIFY bottomInsetChanged FINAL REVISION(2, 5))
113 Q_PROPERTY(PopupType popupType READ popupType WRITE setPopupType NOTIFY popupTypeChanged FINAL REVISION(6, 8))
114 Q_CLASSINFO("DeferredPropertyNames", "background,contentItem")
115 Q_CLASSINFO("DefaultProperty", "contentData")
116 QML_NAMED_ELEMENT(Popup)
117 QML_ADDED_IN_VERSION(2, 0)
118
119public:
120 explicit QQuickPopup(QObject *parent = nullptr);
121 ~QQuickPopup();
122
123 qreal x() const;
124 void setX(qreal x);
125
126 qreal y() const;
127 void setY(qreal y);
128
129 QPointF position() const;
130 void setPosition(const QPointF &pos);
131
132 qreal z() const;
133 void setZ(qreal z);
134 void resetZ();
135
136 qreal width() const;
137 void setWidth(qreal width);
138 void resetWidth();
139
140 qreal height() const;
141 void setHeight(qreal height);
142 void resetHeight();
143
144 qreal implicitWidth() const;
145 void setImplicitWidth(qreal width);
146
147 qreal implicitHeight() const;
148 void setImplicitHeight(qreal height);
149
150 qreal contentWidth() const;
151 void setContentWidth(qreal width);
152
153 qreal contentHeight() const;
154 void setContentHeight(qreal height);
155
156 qreal availableWidth() const;
157 qreal availableHeight() const;
158
159 qreal margins() const;
160 void setMargins(qreal margins);
161 void resetMargins();
162
163 qreal topMargin() const;
164 void setTopMargin(qreal margin);
165 void resetTopMargin();
166
167 qreal leftMargin() const;
168 void setLeftMargin(qreal margin);
169 void resetLeftMargin();
170
171 qreal rightMargin() const;
172 void setRightMargin(qreal margin);
173 void resetRightMargin();
174
175 qreal bottomMargin() const;
176 void setBottomMargin(qreal margin);
177 void resetBottomMargin();
178
179 qreal padding() const;
180 void setPadding(qreal padding);
181 void resetPadding();
182
183 qreal topPadding() const;
184 void setTopPadding(qreal padding);
185 void resetTopPadding();
186
187 qreal leftPadding() const;
188 void setLeftPadding(qreal padding);
189 void resetLeftPadding();
190
191 qreal rightPadding() const;
192 void setRightPadding(qreal padding);
193 void resetRightPadding();
194
195 qreal bottomPadding() const;
196 void setBottomPadding(qreal padding);
197 void resetBottomPadding();
198
199 QLocale locale() const;
200 void setLocale(const QLocale &locale);
201 void resetLocale();
202
203 QFont font() const;
204 void setFont(const QFont &font);
205 void resetFont();
206
207 QQuickWindow *window() const;
208 QQuickItem *popupItem() const;
209
210 QQuickItem *parentItem() const;
211 void setParentItem(QQuickItem *parent);
212 void resetParentItem();
213
214 QQuickItem *background() const;
215 void setBackground(QQuickItem *background);
216
217 QQuickItem *contentItem() const;
218 void setContentItem(QQuickItem *item);
219
220 bool clip() const;
221 void setClip(bool clip);
222
223 bool hasFocus() const;
224 void setFocus(bool focus);
225
226 bool hasActiveFocus() const;
227
228 bool isModal() const;
229 void setModal(bool modal);
230
231 bool dim() const;
232 void setDim(bool dim);
233 void resetDim();
234
235 virtual bool isVisible() const;
236 virtual void setVisible(bool visible);
237
238 qreal opacity() const;
239 virtual void setOpacity(qreal opacity);
240
241 qreal scale() const;
242 void setScale(qreal scale);
243
244 enum ClosePolicyFlag {
245 NoAutoClose = 0x00,
246 CloseOnPressOutside = 0x01,
247 CloseOnPressOutsideParent = 0x02,
248 CloseOnReleaseOutside = 0x04,
249 CloseOnReleaseOutsideParent = 0x08,
250 CloseOnEscape = 0x10
251 };
252 Q_DECLARE_FLAGS(ClosePolicy, ClosePolicyFlag)
253 Q_FLAG(ClosePolicy)
254
255 ClosePolicy closePolicy() const;
256 void setClosePolicy(ClosePolicy policy);
257 void resetClosePolicy();
258
259 // keep in sync with Item.TransformOrigin
260 enum TransformOrigin {
261 TopLeft, Top, TopRight,
262 Left, Center, Right,
263 BottomLeft, Bottom, BottomRight
264 };
265 Q_ENUM(TransformOrigin)
266
267 TransformOrigin transformOrigin() const;
268 void setTransformOrigin(TransformOrigin);
269
270 QQuickTransition *enter() const;
271 void setEnter(QQuickTransition *transition);
272
273 QQuickTransition *exit() const;
274 void setExit(QQuickTransition *transition);
275
276 bool filtersChildMouseEvents() const;
277 void setFiltersChildMouseEvents(bool filter);
278
279 Q_INVOKABLE void forceActiveFocus(Qt::FocusReason reason = Qt::OtherFocusReason);
280
281 // 2.1 (Qt 5.8)
282 qreal spacing() const;
283 void setSpacing(qreal spacing);
284 void resetSpacing();
285
286 // 2.3 (Qt 5.10)
287 bool isOpened() const;
288 bool isMirrored() const;
289
290 bool isEnabled() const;
291 void setEnabled(bool enabled);
292
293 // 2.5 (Qt 5.12)
294 qreal horizontalPadding() const;
295 void setHorizontalPadding(qreal padding);
296 void resetHorizontalPadding();
297
298 qreal verticalPadding() const;
299 void setVerticalPadding(qreal padding);
300 void resetVerticalPadding();
301
302 qreal implicitContentWidth() const;
303 qreal implicitContentHeight() const;
304
305 qreal implicitBackgroundWidth() const;
306 qreal implicitBackgroundHeight() const;
307
308 qreal topInset() const;
309 void setTopInset(qreal inset);
310 void resetTopInset();
311
312 qreal leftInset() const;
313 void setLeftInset(qreal inset);
314 void resetLeftInset();
315
316 qreal rightInset() const;
317 void setRightInset(qreal inset);
318 void resetRightInset();
319
320 qreal bottomInset() const;
321 void setBottomInset(qreal inset);
322 void resetBottomInset();
323
324 void setWindowModality(const Qt::WindowModality modality);
325
326 enum PopupType {
327 Item,
328 Window,
329 Native
330 };
331 Q_ENUM(PopupType)
332
333 PopupType popupType() const;
334 void setPopupType(PopupType);
335
336public Q_SLOTS:
337 void open();
338 void close();
339
340Q_SIGNALS:
341 void opened();
342 void closed();
343 void aboutToShow();
344 void aboutToHide();
345 void xChanged();
346 void yChanged();
347 void zChanged();
348 void widthChanged();
349 void heightChanged();
350 void implicitWidthChanged();
351 void implicitHeightChanged();
352 void contentWidthChanged();
353 void contentHeightChanged();
354 void availableWidthChanged();
355 void availableHeightChanged();
356 void marginsChanged();
357 void topMarginChanged();
358 void leftMarginChanged();
359 void rightMarginChanged();
360 void bottomMarginChanged();
361 void paddingChanged();
362 void topPaddingChanged();
363 void leftPaddingChanged();
364 void rightPaddingChanged();
365 void bottomPaddingChanged();
366 void fontChanged();
367 void localeChanged();
368 void parentChanged();
369 void backgroundChanged();
370 void contentItemChanged();
371 void contentChildrenChanged();
372 void clipChanged();
373 void focusChanged();
374 void activeFocusChanged();
375 void modalChanged();
376 void dimChanged();
377 void visibleChanged();
378 void opacityChanged();
379 void scaleChanged();
380 void closePolicyChanged();
381 void enterChanged();
382 void exitChanged();
383 void windowChanged(QQuickWindow *window);
384 // 2.1 (Qt 5.8)
385 Q_REVISION(2, 1) void spacingChanged();
386 // 2.3 (Qt 5.10)
387 Q_REVISION(2, 3) void openedChanged();
388 Q_REVISION(2, 3) void mirroredChanged();
389 Q_REVISION(2, 3) void enabledChanged();
390 Q_REVISION(2, 3) void paletteChanged();
391 Q_REVISION(2, 3) void paletteCreated();
392 // 2.5 (Qt 5.12)
393 Q_REVISION(2, 5) void horizontalPaddingChanged();
394 Q_REVISION(2, 5) void verticalPaddingChanged();
395 Q_REVISION(2, 5) void implicitContentWidthChanged();
396 Q_REVISION(2, 5) void implicitContentHeightChanged();
397 Q_REVISION(2, 5) void implicitBackgroundWidthChanged();
398 Q_REVISION(2, 5) void implicitBackgroundHeightChanged();
399 Q_REVISION(2, 5) void topInsetChanged();
400 Q_REVISION(2, 5) void leftInsetChanged();
401 Q_REVISION(2, 5) void rightInsetChanged();
402 Q_REVISION(2, 5) void bottomInsetChanged();
403 Q_REVISION(6, 8) void popupTypeChanged();
404
405protected:
406 QQuickPopup(QQuickPopupPrivate &dd, QObject *parent);
407
408 void classBegin() override;
409 void componentComplete() override;
410 bool isComponentComplete() const;
411
412 virtual bool childMouseEventFilter(QQuickItem *child, QEvent *event);
413 virtual void focusInEvent(QFocusEvent *event);
414 virtual void focusOutEvent(QFocusEvent *event);
415 virtual void keyPressEvent(QKeyEvent *event);
416 virtual void keyReleaseEvent(QKeyEvent *event);
417 virtual void mousePressEvent(QMouseEvent *event);
418 virtual void mouseMoveEvent(QMouseEvent *event);
419 virtual void mouseReleaseEvent(QMouseEvent *event);
420 virtual void mouseDoubleClickEvent(QMouseEvent *event);
421 virtual void mouseUngrabEvent();
422 virtual bool overlayEvent(QQuickItem *item, QEvent *event);
423#if QT_CONFIG(quicktemplates2_multitouch)
424 virtual void touchEvent(QTouchEvent *event);
425 virtual void touchUngrabEvent();
426#endif
427#if QT_CONFIG(wheelevent)
428 virtual void wheelEvent(QWheelEvent *event);
429#endif
430
431 virtual void contentItemChange(QQuickItem *newItem, QQuickItem *oldItem);
432 virtual void contentSizeChange(const QSizeF &newSize, const QSizeF &oldSize);
433 virtual void fontChange(const QFont &newFont, const QFont &oldFont);
434 virtual void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry);
435 virtual void localeChange(const QLocale &newLocale, const QLocale &oldLocale);
436 virtual void itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data);
437 virtual void marginsChange(const QMarginsF &newMargins, const QMarginsF &oldMargins);
438 virtual void paddingChange(const QMarginsF &newPadding, const QMarginsF &oldPadding);
439 virtual void spacingChange(qreal newSpacing, qreal oldSpacing);
440 virtual void insetChange(const QMarginsF &newInset, const QMarginsF &oldInset);
441
442 virtual QFont defaultFont() const;
443
444#if QT_CONFIG(accessibility)
445 QAccessible::Role effectiveAccessibleRole() const;
446private:
447 virtual QAccessible::Role accessibleRole() const;
448protected:
449 virtual void accessibilityActiveChanged(bool active);
450#endif
451
452 QString accessibleName() const;
453 void maybeSetAccessibleName(const QString &name);
454
455 QVariant accessibleProperty(const char *propertyName);
456 bool setAccessibleProperty(const char *propertyName, const QVariant &value);
457
458private:
459 QQuickItem *findParentItem() const;
460
461 QQuickItem *safeAreaAttachmentItem() override;
462
463 QQuickItem *attacheeItem() const override;
464 QtPrivate::QQuickAttachedPropertyPropagator *attachedParent(
465 const QMetaObject *attachedType) const override;
466
467 Q_DISABLE_COPY(QQuickPopup)
468 Q_DECLARE_PRIVATE(QQuickPopup)
469 friend class QQuickPopupWindow;
470 friend class QQuickPopupItem;
471 friend class QQuickOverlay;
472 friend class QQuickOverlayPrivate;
473};
474
475Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickPopup::ClosePolicy)
476
477QT_END_NAMESPACE
478
479#endif // QQUICKPOPUP_P_H
QAccessibleQuickPopupItem::QAccessibleQuickPopupItem
QAccessibleQuickPopupItem(QQuickPopupItem *popupItem)
Definition qaccessiblequickpopupitem.cpp:10
QAccessibleQuickPopupItem::state
QAccessible::State state() const override
Definition qaccessiblequickpopupitem.cpp:15
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qrandomaccessasyncfile_darwin.mm:17