Qt 4.8
qwindowsurface_p.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
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 
59 
60 class QPaintDevice;
61 class QRegion;
62 class QRect;
63 class QPoint;
64 class QImage;
66 class QPlatformWindow;
67 
69 {
70 public:
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 &region, 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;
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 &region);
115  QRegion staticContents() const;
116 
117 protected:
118  bool hasStaticContents() const;
119 
120 private:
122 };
123 
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 
132 {
133  return (features() & feature) != 0;
134 }
135 
137 
138 #endif // QWINDOWSURFACE_P_H
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QPointer< QWidget > widget
#define Q_DECLARE_FLAGS(Flags, Enum)
The Q_DECLARE_FLAGS() macro expands to.
Definition: qglobal.h:2348
QRect rect(const QWidget *widget) const
Returns the rectangle for widget in the coordinates of this window surface.
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
The QWidget class is the base class of all user interface objects.
Definition: qwidget.h:150
QRect translated(int dx, int dy) const
Returns a copy of the rectangle that is translated dx along the x axis and dy along the y axis...
Definition: qrect.h:328
The QPlatformWindow class provides an abstraction for top-level windows.
NSWindow * window
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
The Q_DECLARE_OPERATORS_FOR_FLAGS() macro declares global operator|() functions for Flags...
Definition: qglobal.h:2355
The QImage class provides a hardware-independent image representation that allows direct access to th...
Definition: qimage.h:87
The QRegion class specifies a clip region for a painter.
Definition: qregion.h:68
The QWindowSurface class provides the drawing area for top-level windows.
static bool hasFeature(const QDockWidgetPrivate *priv, QDockWidget::DockWidgetFeature feature)
Definition: qdockwidget.cpp:74
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
bool hasFeature(WindowSurfaceFeature feature) const
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
Q_CORE_EXPORT QTextStream & flush(QTextStream &s)
The QSize class defines the size of a two-dimensional object using integer point precision.
Definition: qsize.h:53
QWindowSurfacePrivate * d_ptr
static int area(const QSize &s)
Definition: qicon.cpp:155