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

source code of qtdeclarative/src/quicktemplates/qquickpopup_p.h