QtBase  v6.3.1
qplatformwindow.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 #ifndef QPLATFORMWINDOW_H
40 #define QPLATFORMWINDOW_H
41 
42 //
43 // W A R N I N G
44 // -------------
45 //
46 // This file is part of the QPA API and is not meant to be used
47 // in applications. Usage of this API may make your code
48 // source and binary incompatible with future versions of Qt.
49 //
50 
51 #include <QtGui/qtguiglobal.h>
52 #include <QtCore/qscopedpointer.h>
53 #include <QtCore/qrect.h>
54 #include <QtCore/qmargins.h>
55 #include <QtCore/qstring.h>
56 #include <QtGui/qwindowdefs.h>
57 #include <QtGui/qwindow.h>
58 #include <qpa/qplatformopenglcontext.h>
59 #include <qpa/qplatformsurface.h>
60 
61 QT_BEGIN_NAMESPACE
62 
63 #define QWINDOWSIZE_MAX ((1<<24)-1)
64 
65 class QPlatformScreen;
66 class QPlatformWindowPrivate;
67 class QScreen;
68 class QWindow;
69 class QIcon;
70 class QRegion;
71 
72 class Q_GUI_EXPORT QPlatformWindow : public QPlatformSurface
73 {
74  Q_DECLARE_PRIVATE(QPlatformWindow)
75 public:
76  Q_DISABLE_COPY_MOVE(QPlatformWindow)
77 
78  explicit QPlatformWindow(QWindow *window);
79  ~QPlatformWindow() override;
80 
81  virtual void initialize();
82 
83  QWindow *window() const;
84  QPlatformWindow *parent() const;
85 
86  QPlatformScreen *screen() const override;
87 
88  virtual QSurfaceFormat format() const override;
89 
90  virtual void setGeometry(const QRect &rect);
91  virtual QRect geometry() const;
92  virtual QRect normalGeometry() const;
93 
94  virtual QMargins frameMargins() const;
95  virtual QMargins safeAreaMargins() const;
96 
97  virtual void setVisible(bool visible);
98  virtual void setWindowFlags(Qt::WindowFlags flags);
99  virtual void setWindowState(Qt::WindowStates state);
100 
101  virtual WId winId() const;
102  virtual void setParent(const QPlatformWindow *window);
103 
104  virtual void setWindowTitle(const QString &title);
105  virtual void setWindowFilePath(const QString &title);
106  virtual void setWindowIcon(const QIcon &icon);
107  virtual bool close();
108  virtual void raise();
109  virtual void lower();
110 
111  virtual bool isExposed() const;
112  virtual bool isActive() const;
113  virtual bool isAncestorOf(const QPlatformWindow *child) const;
114  virtual bool isEmbedded() const;
115  virtual bool isForeignWindow() const { return false; }
116  virtual QPoint mapToGlobal(const QPoint &pos) const;
117  QPointF mapToGlobalF(const QPointF &pos) const;
118  virtual QPoint mapFromGlobal(const QPoint &pos) const;
119  QPointF mapFromGlobalF(const QPointF &pos) const;
120 
121  virtual void propagateSizeHints();
122 
123  virtual void setOpacity(qreal level);
124  virtual void setMask(const QRegion &region);
125  virtual void requestActivateWindow();
126 
127  virtual void handleContentOrientationChange(Qt::ScreenOrientation orientation);
128 
129  virtual qreal devicePixelRatio() const;
130 
131  virtual bool setKeyboardGrabEnabled(bool grab);
132  virtual bool setMouseGrabEnabled(bool grab);
133 
134  virtual bool setWindowModified(bool modified);
135 
136  virtual bool windowEvent(QEvent *event);
137 
138  virtual bool startSystemResize(Qt::Edges edges);
139  virtual bool startSystemMove();
140 
141  virtual void setFrameStrutEventsEnabled(bool enabled);
142  virtual bool frameStrutEventsEnabled() const;
143 
144  virtual void setAlertState(bool enabled);
145  virtual bool isAlertState() const;
146 
147  virtual void invalidateSurface();
148 
149  static QRect initialGeometry(const QWindow *w, const QRect &initialGeometry,
150  int defaultWidth, int defaultHeight,
151  const QScreen **resultingScreenReturn = nullptr);
152 
153  virtual void requestUpdate();
154  bool hasPendingUpdateRequest() const;
155  virtual void deliverUpdateRequest();
156 
157  // Window property accessors. Platform plugins should use these
158  // instead of accessing QWindow directly.
159  QSize windowMinimumSize() const;
160  QSize windowMaximumSize() const;
161  QSize windowBaseSize() const;
162  QSize windowSizeIncrement() const;
163  QRect windowGeometry() const;
164  QRect windowFrameGeometry() const;
165  QRectF windowClosestAcceptableGeometry(const QRectF &nativeRect) const;
166  static QRectF closestAcceptableGeometry(const QWindow *w, const QRectF &nativeRect);
167 
168 protected:
169  static QString formatWindowTitle(const QString &title, const QString &separator);
170  QPlatformScreen *screenForGeometry(const QRect &newGeometry) const;
171  static QSize constrainWindowSize(const QSize &size);
172 
173  QScopedPointer<QPlatformWindowPrivate> d_ptr;
174 };
175 
176 QT_END_NAMESPACE
177 
178 #endif //QPLATFORMWINDOW_H
QEvent
The QEvent class is the base class of all event classes. Event objects contain event parameters.
Definition: qcoreevent.h:58
QIcon
The QIcon class provides scalable icons in different modes and states.
Definition: qicon.h:56
QMargins
The QMargins class defines the four margins of a rectangle.
Definition: qmargins.h:52
QPlatformSurface::format
virtual QSurfaceFormat format() const =0
QPlatformSurface::screen
virtual QPlatformScreen * screen() const =0
QPlatformSurface::QPlatformWindow
friend class QPlatformWindow
Definition: qplatformsurface.h:83
QPlatformWindow::d_ptr
QScopedPointer< QPlatformWindowPrivate > d_ptr
Definition: qplatformwindow.h:173
QPlatformWindow::isForeignWindow
virtual bool isForeignWindow() const
Definition: qplatformwindow.h:115
QPointF
The QPointF class defines a point in the plane using floating point precision.
Definition: qpoint.h:242
QPoint
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:52
QRectF
The QRectF class defines a finite rectangle in the plane using floating point precision.
Definition: qrect.h:511
QRect
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:59
QRegion
The QRegion class specifies a clip region for a painter.
Definition: qregion.h:63
QScreen
The QScreen class is used to query screen properties. \inmodule QtGui.
Definition: qscreen.h:68
QSize
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:55
QString
The QString class provides a Unicode character string.
Definition: qstring.h:388
QSurfaceFormat
The QSurfaceFormat class represents the format of a QSurface. \inmodule QtGui.
Definition: qsurfaceformat.h:53
QWindow
The QWindow class represents a window in the underlying windowing system.
Definition: qwindow.h:99
rect
rect
[4]
Definition: doc_src_styles.cpp:90
state
else opt state
[0]
Definition: doc_src_styles.cpp:58
QT_BEGIN_NAMESPACE
Definition: server.cpp:57
QT_END_NAMESPACE
Definition: qsharedpointer.cpp:1532
Qt::ScreenOrientation
ScreenOrientation
Definition: qnamespace.h:296
Q_DISABLE_COPY_MOVE
#define Q_DISABLE_COPY_MOVE(Class)
Definition: qglobal.h:519
qreal
QT_END_INCLUDE_NAMESPACE typedef double qreal
Definition: qglobal.h:341
level
GLenum GLuint GLint level
Definition: qopengles2ext.h:416
w
GLfloat GLfloat GLfloat w
[0]
Definition: qopengles2ext.h:789
size
GLenum GLuint GLintptr GLsizeiptr size
[1]
Definition: qopengles2ext.h:660
enabled
GLenum GLenum GLsizei const GLuint GLboolean enabled
Definition: qopengles2ext.h:150
flags
GLbitfield flags
Definition: qopengles2ext.h:1026
event
struct _cl_event * event
Definition: qopenglext.h:2998
icon
QIcon icon
[15]
Definition: src_corelib_global_qglobal.cpp:207
pos
pos
[7]
Definition: src_corelib_io_qsettings.cpp:104
title
QString title
[35]
Definition: src_corelib_kernel_qobject.cpp:384
child
QLayoutItem * child
[0]
Definition: src_gui_kernel_qlayout.cpp:72
setWindowState
w setWindowState(w->windowState() ^ Qt::WindowFullScreen)
[0]
window
aWidget window() -> setWindowTitle("New Window Title")
[2]
setParent
file setParent(multiPart)
initialize
socketLayer initialize(QAbstractSocket::TcpSocket, QAbstractSocket::IPv4Protocol)
parent
IUIAutomationTreeWalker __RPC__deref_out_opt IUIAutomationElement ** parent
Definition: uiaclientinterfaces_p.h:245
Generated by doxygen 1.9.1