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
qwindow.h
Go to the documentation of this file.
1// Copyright (C) 2016 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 QWINDOW_H
5#define QWINDOW_H
6
7#include <QtGui/qtguiglobal.h>
8#include <QtCore/QObject>
9#include <QtCore/QEvent>
10#include <QtCore/QMargins>
11#include <QtCore/QRect>
12
13#include <QtCore/qnamespace.h>
14#include <QtCore/qnativeinterface.h>
15
16#include <QtGui/qsurface.h>
17#include <QtGui/qsurfaceformat.h>
18#include <QtGui/qwindowdefs.h>
19
20#include <QtGui/qicon.h>
21
22#ifndef QT_NO_CURSOR
23#include <QtGui/qcursor.h>
24#endif
25
26QT_BEGIN_NAMESPACE
27
28
29class QWindowPrivate;
30
31class QExposeEvent;
32class QPaintEvent;
33class QFocusEvent;
34class QMoveEvent;
35class QResizeEvent;
36class QShowEvent;
37class QHideEvent;
38class QCloseEvent;
39class QKeyEvent;
40class QMouseEvent;
41#if QT_CONFIG(wheelevent)
42class QWheelEvent;
43#endif
44class QTouchEvent;
45#if QT_CONFIG(tabletevent)
46class QTabletEvent;
47#endif
48
49class QPlatformSurface;
50class QPlatformWindow;
51class QBackingStore;
52class QScreen;
53class QAccessibleInterface;
54class QWindowContainer;
55#ifndef QT_NO_DEBUG_STREAM
56class QDebug;
57#endif
58#if QT_CONFIG(vulkan) || defined(Q_QDOC)
59class QVulkanInstance;
60#endif
61
62class Q_GUI_EXPORT QWindow : public QObject, public QSurface
63{
64 Q_OBJECT
65 Q_DECLARE_PRIVATE(QWindow)
66
67 // All properties which are declared here are inherited by QQuickWindow and therefore available in QML.
68 // So please think carefully about what it does to the QML namespace if you add any new ones,
69 // particularly the possible meanings these names might have in any specializations of Window.
70 // For example "state" (meaning windowState) is not a good property to declare, because it has
71 // a different meaning in QQuickItem, and users will tend to assume it is the same for Window.
72
73 // Any new properties which you add here MUST be versioned and MUST be documented both as
74 // C++ properties in qwindow.cpp AND as QML properties in qquickwindow.cpp.
75 // https://doc.qt.io/qt/qtqml-cppintegration-definetypes.html#type-revisions-and-versions
76
77 Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY windowTitleChanged)
78 Q_PROPERTY(Qt::WindowModality modality READ modality WRITE setModality NOTIFY modalityChanged)
79 Q_PROPERTY(Qt::WindowFlags flags READ flags WRITE setFlags)
80 Q_PROPERTY(int x READ x WRITE setX NOTIFY xChanged)
81 Q_PROPERTY(int y READ y WRITE setY NOTIFY yChanged)
82 Q_PROPERTY(int width READ width WRITE setWidth NOTIFY widthChanged)
83 Q_PROPERTY(int height READ height WRITE setHeight NOTIFY heightChanged)
84 Q_PROPERTY(int minimumWidth READ minimumWidth WRITE setMinimumWidth NOTIFY minimumWidthChanged)
85 Q_PROPERTY(int minimumHeight READ minimumHeight WRITE setMinimumHeight
86 NOTIFY minimumHeightChanged)
87 Q_PROPERTY(int maximumWidth READ maximumWidth WRITE setMaximumWidth NOTIFY maximumWidthChanged)
88 Q_PROPERTY(int maximumHeight READ maximumHeight WRITE setMaximumHeight
89 NOTIFY maximumHeightChanged)
90 Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged)
91 Q_PROPERTY(bool active READ isActive NOTIFY activeChanged REVISION(2, 1))
92 Q_PROPERTY(Visibility visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged
93 REVISION(2, 1))
94 Q_PROPERTY(Qt::ScreenOrientation contentOrientation READ contentOrientation
95 WRITE reportContentOrientationChange NOTIFY contentOrientationChanged)
96 Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged REVISION(2, 1))
97#ifdef Q_QDOC
98 Q_PROPERTY(QWindow* transientParent READ transientParent WRITE setTransientParent NOTIFY transientParentChanged)
99#else
100 Q_PRIVATE_PROPERTY(QWindow::d_func(), QWindow* transientParent MEMBER transientParent
101 WRITE setTransientParent NOTIFY transientParentChanged REVISION(2, 13))
102#endif
103
104public:
105 enum Visibility {
106 Hidden = 0,
107 AutomaticVisibility,
108 Windowed,
109 Minimized,
110 Maximized,
111 FullScreen
112 };
113 Q_ENUM(Visibility)
114
115 enum AncestorMode {
116 ExcludeTransients,
117 IncludeTransients
118 };
119 Q_ENUM(AncestorMode)
120
121 explicit QWindow(QScreen *screen = nullptr);
122 explicit QWindow(QWindow *parent);
123 ~QWindow();
124
125 void setSurfaceType(SurfaceType surfaceType);
126 SurfaceType surfaceType() const override;
127
128 bool isVisible() const;
129
130 Visibility visibility() const;
131 void setVisibility(Visibility v);
132
133 void create();
134
135 WId winId() const;
136
137 QWindow *parent(AncestorMode mode = ExcludeTransients) const;
138 void setParent(QWindow *parent);
139
140 bool isTopLevel() const;
141
142 bool isModal() const;
143 Qt::WindowModality modality() const;
144 void setModality(Qt::WindowModality modality);
145
146 void setFormat(const QSurfaceFormat &format);
147 QSurfaceFormat format() const override;
148 QSurfaceFormat requestedFormat() const;
149
150 void setFlags(Qt::WindowFlags flags);
151 Qt::WindowFlags flags() const;
152 void setFlag(Qt::WindowType, bool on = true);
153 Qt::WindowType type() const;
154
155 QString title() const;
156
157 void setOpacity(qreal level);
158 qreal opacity() const;
159
160 void setMask(const QRegion &region);
161 QRegion mask() const;
162
163 bool isActive() const;
164
165 void reportContentOrientationChange(Qt::ScreenOrientation orientation);
166 Qt::ScreenOrientation contentOrientation() const;
167
168 qreal devicePixelRatio() const;
169
170 Qt::WindowState windowState() const;
171 Qt::WindowStates windowStates() const;
172 void setWindowState(Qt::WindowState state);
173 void setWindowStates(Qt::WindowStates states);
174
175 void setTransientParent(QWindow *parent);
176 QWindow *transientParent() const;
177
178 bool isAncestorOf(const QWindow *child, AncestorMode mode = IncludeTransients) const;
179
180 bool isExposed() const;
181
182 inline int minimumWidth() const { return minimumSize().width(); }
183 inline int minimumHeight() const { return minimumSize().height(); }
184 inline int maximumWidth() const { return maximumSize().width(); }
185 inline int maximumHeight() const { return maximumSize().height(); }
186
187 QSize minimumSize() const;
188 QSize maximumSize() const;
189 QSize baseSize() const;
190 QSize sizeIncrement() const;
191
192 void setMinimumSize(const QSize &size);
193 void setMaximumSize(const QSize &size);
194 void setBaseSize(const QSize &size);
195 void setSizeIncrement(const QSize &size);
196
197 QRect geometry() const;
198
199 QMargins frameMargins() const;
200 QRect frameGeometry() const;
201
202 QPoint framePosition() const;
203 void setFramePosition(const QPoint &point);
204
205 QMargins safeAreaMargins() const;
206
207 inline int width() const { return geometry().width(); }
208 inline int height() const { return geometry().height(); }
209 inline int x() const { return geometry().x(); }
210 inline int y() const { return geometry().y(); }
211
212 QSize size() const override { return geometry().size(); }
213 inline QPoint position() const { return geometry().topLeft(); }
214
215 void setPosition(const QPoint &pt);
216 void setPosition(int posx, int posy);
217
218 void resize(const QSize &newSize);
219 void resize(int w, int h);
220
221 void setFilePath(const QString &filePath);
222 QString filePath() const;
223
224 void setIcon(const QIcon &icon);
225 QIcon icon() const;
226
227 void destroy();
228
229 QPlatformWindow *handle() const;
230
231 bool setKeyboardGrabEnabled(bool grab);
232 bool setMouseGrabEnabled(bool grab);
233
234 QScreen *screen() const;
235 void setScreen(QScreen *screen);
236
237 virtual QAccessibleInterface *accessibleRoot() const;
238 virtual QObject *focusObject() const;
239
240 QPointF mapToGlobal(const QPointF &pos) const;
241 QPointF mapFromGlobal(const QPointF &pos) const;
242 QPoint mapToGlobal(const QPoint &pos) const;
243 QPoint mapFromGlobal(const QPoint &pos) const;
244
245#ifndef QT_NO_CURSOR
246 QCursor cursor() const;
247 void setCursor(const QCursor &);
248 void unsetCursor();
249#endif
250
251 static QWindow *fromWinId(WId id);
252
253#if QT_CONFIG(vulkan) || defined(Q_QDOC)
254 void setVulkanInstance(QVulkanInstance *instance);
255 QVulkanInstance *vulkanInstance() const;
256#endif
257
258 QT_DECLARE_NATIVE_INTERFACE_ACCESSOR(QWindow)
259
260public Q_SLOTS:
261 Q_REVISION(2, 1) void requestActivate();
262
263 void setVisible(bool visible);
264
265 void show();
266 void hide();
267
268 void showMinimized();
269 void showMaximized();
270 void showFullScreen();
271 void showNormal();
272
273 bool close();
274 void raise();
275 void lower();
276 bool startSystemResize(Qt::Edges edges);
277 bool startSystemMove();
278
279 void setTitle(const QString &);
280
281 void setX(int arg);
282 void setY(int arg);
283 void setWidth(int arg);
284 void setHeight(int arg);
285 void setGeometry(int posx, int posy, int w, int h);
286 void setGeometry(const QRect &rect);
287
288 void setMinimumWidth(int w);
289 void setMinimumHeight(int h);
290 void setMaximumWidth(int w);
291 void setMaximumHeight(int h);
292
293 Q_REVISION(2, 1) void alert(int msec);
294
295 Q_REVISION(2, 3) void requestUpdate();
296
297Q_SIGNALS:
298 void screenChanged(QScreen *screen);
299 void modalityChanged(Qt::WindowModality modality);
300 void windowStateChanged(Qt::WindowState windowState);
301 Q_REVISION(2, 2) void windowTitleChanged(const QString &title);
302
303 void xChanged(int arg);
304 void yChanged(int arg);
305
306 void widthChanged(int arg);
307 void heightChanged(int arg);
308
309 void minimumWidthChanged(int arg);
310 void minimumHeightChanged(int arg);
311 void maximumWidthChanged(int arg);
312 void maximumHeightChanged(int arg);
313
314 Q_REVISION(6, 9) void safeAreaMarginsChanged(QMargins arg);
315
316 void visibleChanged(bool arg);
317 Q_REVISION(2, 1) void visibilityChanged(QWindow::Visibility visibility);
318 Q_REVISION(2, 1) void activeChanged();
319 void contentOrientationChanged(Qt::ScreenOrientation orientation);
320
321 void focusObjectChanged(QObject *object);
322
323 Q_REVISION(2, 1) void opacityChanged(qreal opacity);
324
325 Q_REVISION(2, 13) void transientParentChanged(QWindow *transientParent);
326
327protected:
328 virtual void exposeEvent(QExposeEvent *);
329 virtual void resizeEvent(QResizeEvent *);
330 virtual void paintEvent(QPaintEvent *);
331 virtual void moveEvent(QMoveEvent *);
332 virtual void focusInEvent(QFocusEvent *);
333 virtual void focusOutEvent(QFocusEvent *);
334
335 virtual void showEvent(QShowEvent *);
336 virtual void hideEvent(QHideEvent *);
337 virtual void closeEvent(QCloseEvent *);
338
339 virtual bool event(QEvent *) override;
340 virtual void keyPressEvent(QKeyEvent *);
341 virtual void keyReleaseEvent(QKeyEvent *);
342 virtual void mousePressEvent(QMouseEvent *);
343 virtual void mouseReleaseEvent(QMouseEvent *);
344 virtual void mouseDoubleClickEvent(QMouseEvent *);
345 virtual void mouseMoveEvent(QMouseEvent *);
346#if QT_CONFIG(wheelevent)
347 virtual void wheelEvent(QWheelEvent *);
348#endif
349 virtual void touchEvent(QTouchEvent *);
350#if QT_CONFIG(tabletevent)
351 virtual void tabletEvent(QTabletEvent *);
352#endif
353 virtual bool nativeEvent(const QByteArray &eventType, void *message, qintptr *result);
354
355 QWindow(QWindowPrivate &dd, QWindow *parent);
356
357private:
358 Q_PRIVATE_SLOT(d_func(), void _q_clearAlert())
359 QPlatformSurface *surfaceHandle() const override;
360
361 Q_DISABLE_COPY(QWindow)
362
363 friend class QGuiApplication;
364 friend class QGuiApplicationPrivate;
365 friend class QWindowContainer;
366 friend Q_GUI_EXPORT QWindowPrivate *qt_window_private(QWindow *window);
367};
368
369#ifndef Q_QDOC
370// should these be seen by clang-qdoc?
371template <> inline QWindow *qobject_cast<QWindow*>(QObject *o)
372{
373 if (!o || !o->isWindowType()) return nullptr;
374 return static_cast<QWindow*>(o);
375}
376template <> inline const QWindow *qobject_cast<const QWindow*>(const QObject *o)
377{
378 if (!o || !o->isWindowType()) return nullptr;
379 return static_cast<const QWindow*>(o);
380}
381#endif // !Q_QDOC
382
383#ifndef QT_NO_DEBUG_STREAM
384Q_GUI_EXPORT QDebug operator<<(QDebug, const QWindow *);
385#endif
386
387QT_END_NAMESPACE
388
389#endif // QWINDOW_H
QOffscreenSurface
\inmodule QtGui
Definition qoffscreensurface.h:21
QPlatformSurface
The QPlatformSurface class provides an abstraction for a surface.
Definition qplatformsurface.h:30
QWindow
\inmodule QtGui
Definition qwindow.h:63
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21
operator<<
Q_CORE_EXPORT QDebug operator<<(QDebug debug, QDir::Filters filters)
Definition qdir.cpp:2462