src/gui/painting/qwindowsurface_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  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
  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 &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:
 121     QWindowSurfacePrivate *d_ptr;
 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
 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