1/****************************************************************************
2**
3** Copyright (C) 2016 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
40#ifndef QPLATFORMSCREEN_H
41#define QPLATFORMSCREEN_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is part of the QPA API and is not meant to be used
48// in applications. Usage of this API may make your code
49// source and binary incompatible with future versions of Qt.
50//
51
52#include <QtGui/qtguiglobal.h>
53#include <QtCore/qmetatype.h>
54#include <QtCore/qnamespace.h>
55#include <QtCore/qcoreevent.h>
56#include <QtCore/qvariant.h>
57#include <QtCore/qrect.h>
58#include <QtCore/qobject.h>
59
60#include <QtGui/qcursor.h>
61#include <QtGui/qimage.h>
62#include <QtGui/qwindowdefs.h>
63#include <qpa/qplatformpixmap.h>
64
65QT_BEGIN_NAMESPACE
66
67
68class QPlatformBackingStore;
69class QPlatformScreenPrivate;
70class QPlatformWindow;
71class QPlatformCursor;
72class QScreen;
73class QSurfaceFormat;
74
75typedef QPair<qreal, qreal> QDpi;
76
77
78class Q_GUI_EXPORT QPlatformScreen
79{
80 Q_DECLARE_PRIVATE(QPlatformScreen)
81
82public:
83 Q_DISABLE_COPY_MOVE(QPlatformScreen)
84
85 enum SubpixelAntialiasingType { // copied from qfontengine_p.h since we can't include private headers
86 Subpixel_None,
87 Subpixel_RGB,
88 Subpixel_BGR,
89 Subpixel_VRGB,
90 Subpixel_VBGR
91 };
92
93 enum PowerState {
94 PowerStateOn,
95 PowerStateStandby,
96 PowerStateSuspend,
97 PowerStateOff
98 };
99
100 struct Mode {
101 QSize size;
102 qreal refreshRate;
103 };
104
105 QPlatformScreen();
106 virtual ~QPlatformScreen();
107
108 virtual bool isPlaceholder() const { return false; }
109
110 virtual QPixmap grabWindow(WId window, int x, int y, int width, int height) const;
111
112 virtual QRect geometry() const = 0;
113 virtual QRect availableGeometry() const {return geometry();}
114
115 virtual int depth() const = 0;
116 virtual QImage::Format format() const = 0;
117
118 virtual QSizeF physicalSize() const;
119 virtual QDpi logicalDpi() const;
120 virtual QDpi logicalBaseDpi() const;
121 virtual qreal devicePixelRatio() const;
122
123 virtual qreal refreshRate() const;
124
125 virtual Qt::ScreenOrientation nativeOrientation() const;
126 virtual Qt::ScreenOrientation orientation() const;
127
128 virtual QWindow *topLevelAt(const QPoint &point) const;
129 QWindowList windows() const;
130
131 virtual QList<QPlatformScreen *> virtualSiblings() const;
132 const QPlatformScreen *screenForPosition(const QPoint &point) const;
133
134 QScreen *screen() const;
135
136 //jl: should this function be in QPlatformIntegration
137 //jl: maybe screenForWindow is a better name?
138 static QPlatformScreen *platformScreenForWindow(const QWindow *window);
139
140 virtual QString name() const { return QString(); }
141
142 virtual QString manufacturer() const;
143 virtual QString model() const;
144 virtual QString serialNumber() const;
145
146 virtual QPlatformCursor *cursor() const;
147 virtual SubpixelAntialiasingType subpixelAntialiasingTypeHint() const;
148
149 virtual PowerState powerState() const;
150 virtual void setPowerState(PowerState state);
151
152 virtual QList<Mode> modes() const;
153
154 virtual int currentMode() const;
155 virtual int preferredMode() const;
156
157 static int angleBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b);
158 static QTransform transformBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &target);
159 static QRect mapBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &rect);
160
161 // The platform screen's geometry in device independent coordinates
162 QRect deviceIndependentGeometry() const;
163
164 static QDpi overrideDpi(const QDpi &in);
165
166protected:
167 void resizeMaximizedWindows();
168
169 QScopedPointer<QPlatformScreenPrivate> d_ptr;
170
171private:
172 friend class QScreenPrivate;
173};
174
175// Qt doesn't currently support running with no platform screen
176// QPA plugins can use this class to create a fake screen
177class Q_GUI_EXPORT QPlatformPlaceholderScreen : public QPlatformScreen {
178public:
179 // virtualSibling can be passed in to make the placeholder a sibling with other screens during
180 // the transitioning phase when the real screen is about to be removed, or the first real screen
181 // is about to be added. This is useful because Qt will currently recreate (but now show!)
182 // windows when they are moved from one virtual desktop to another, so if the last monitor is
183 // unplugged, then plugged in again, windows will be hidden unless the placeholder belongs to
184 // the same virtual desktop as the other screens.
185 QPlatformPlaceholderScreen(bool virtualSibling = true) : m_virtualSibling(virtualSibling) {}
186 bool isPlaceholder() const override { return true; }
187 QRect geometry() const override { return QRect(); }
188 QRect availableGeometry() const override { return QRect(); }
189 int depth() const override { return 32; }
190 QImage::Format format() const override { return QImage::Format::Format_RGB32; }
191 QList<QPlatformScreen *> virtualSiblings() const override;
192private:
193 bool m_virtualSibling = true;
194};
195
196QT_END_NAMESPACE
197
198#endif // QPLATFORMSCREEN_H
199