1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file. Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QWINDOWSURFACE_P_H
43 #define QWINDOWSURFACE_P_H
44
45 //
46 // W A R N I N G
47 // -------------
48 //
49 // This file is not part of the Qt API. It exists for the convenience
50 // of other Qt classes. This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include <QtGui/qwidget.h>
57
58 QT_BEGIN_NAMESPACE
59
60 class QPaintDevice;
61 class QRegion;
62 class QRect;
63 class QPoint;
64 class QImage;
65 class QWindowSurfacePrivate;
66 class QPlatformWindow;
67
68 class Q_GUI_EXPORT QWindowSurface
69 {
70 public:
71 enum WindowSurfaceFeature {
72 PartialUpdates = 0x00000001, // Supports doing partial updates.
73 PreservedContents = 0x00000002, // Supports doing flush without first doing a repaint.
74 StaticContents = 0x00000004, // Supports having static content regions when being resized.
75 AllFeatures = 0xffffffff // For convenience
76 };
77 Q_DECLARE_FLAGS(WindowSurfaceFeatures, WindowSurfaceFeature)
78
79 QWindowSurface(QWidget *window, bool setDefaultSurface = true);
80 virtual ~QWindowSurface();
81
82 QWidget *window() const;
83
84 virtual QPaintDevice *paintDevice() = 0;
85
86 // 'widget' can be a child widget, in which case 'region' is in child widget coordinates and
87 // offset is the (child) widget's offset in relation to the window surface. On QWS, 'offset'
88 // can be larger than just the offset from the top-level widget as there may also be window
89 // decorations which are painted into the window surface.
90 virtual void flush(QWidget *widget, const QRegion ®ion, const QPoint &offset) = 0;
91 #if !defined(Q_WS_QPA)
92 virtual void setGeometry(const QRect &rect);
93 QRect geometry() const;
94 #else
95 virtual void resize(const QSize &size);
96 QSize size() const;
geometry()97 inline QRect geometry() const { return QRect(QPoint(), size()); } //### cleanup before Qt 5
98 #endif
99
100 virtual bool scroll(const QRegion &area, int dx, int dy);
101
102 virtual void beginPaint(const QRegion &);
103 virtual void endPaint(const QRegion &);
104
105 virtual QImage* buffer(const QWidget *widget);
106 virtual QPixmap grabWidget(const QWidget *widget, const QRect& rectangle = QRect()) const;
107
108 virtual QPoint offset(const QWidget *widget) const;
109 inline QRect rect(const QWidget *widget) const;
110
111 bool hasFeature(WindowSurfaceFeature feature) const;
112 virtual WindowSurfaceFeatures features() const;
113
114 void setStaticContents(const QRegion ®ion);
115 QRegion staticContents() const;
116
117 protected:
118 bool hasStaticContents() const;
119
120 private:
121 QWindowSurfacePrivate *d_ptr;
122 };
123
Q_DECLARE_OPERATORS_FOR_FLAGS(QWindowSurface::WindowSurfaceFeatures)124 Q_DECLARE_OPERATORS_FOR_FLAGS(QWindowSurface::WindowSurfaceFeatures)
125
126 inline QRect QWindowSurface::rect(const QWidget *widget) const
127 {
128 return widget->rect().translated(offset(widget));
129 }
130
hasFeature(WindowSurfaceFeature feature)131 inline bool QWindowSurface::hasFeature(WindowSurfaceFeature feature) const
132 {
133 return (features() & feature) != 0;
134 }
135
136 QT_END_NAMESPACE
137
138 #endif // QWINDOWSURFACE_P_H
139