QPlatformWindow: Add Window masks.
[profile/ivi/qtbase.git] / src / gui / kernel / qplatformwindow.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
16 **
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
20 **
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
28 **
29 ** Other Usage
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 #ifndef QPLATFORMWINDOW_H
42 #define QPLATFORMWINDOW_H
43
44 //
45 //  W A R N I N G
46 //  -------------
47 //
48 // This file is part of the QPA API and is not meant to be used
49 // in applications. Usage of this API may make your code
50 // source and binary incompatible with future versions of Qt.
51 //
52
53 #include <QtCore/qscopedpointer.h>
54 #include <QtCore/qrect.h>
55 #include <QtCore/qmargins.h>
56 #include <QtCore/qstring.h>
57 #include <QtGui/qwindowdefs.h>
58 #include <QtGui/qwindow.h>
59 #include <qpa/qplatformopenglcontext.h>
60 #include <qpa/qplatformsurface.h>
61
62 QT_BEGIN_HEADER
63
64 QT_BEGIN_NAMESPACE
65
66
67 class QPlatformScreen;
68 class QPlatformWindowPrivate;
69 class QWindow;
70 class QIcon;
71 class QRegion;
72
73 class Q_GUI_EXPORT QPlatformWindow : public QPlatformSurface
74 {
75     Q_DECLARE_PRIVATE(QPlatformWindow)
76 public:
77     explicit QPlatformWindow(QWindow *window);
78     virtual ~QPlatformWindow();
79
80     QWindow *window() const;
81     QPlatformWindow *parent() const;
82
83     QPlatformScreen *screen() const;
84
85     virtual QSurfaceFormat format() const;
86
87     virtual void setGeometry(const QRect &rect);
88     virtual QRect geometry() const;
89
90     virtual QMargins frameMargins() const;
91
92     virtual void setVisible(bool visible);
93     virtual Qt::WindowFlags setWindowFlags(Qt::WindowFlags flags);
94     virtual Qt::WindowState setWindowState(Qt::WindowState state);
95
96     virtual WId winId() const;
97     virtual void setParent(const QPlatformWindow *window);
98
99     virtual void setWindowTitle(const QString &title);
100     virtual void setWindowIcon(const QIcon &icon);
101     virtual void raise();
102     virtual void lower();
103
104     virtual bool isExposed() const;
105
106     virtual void propagateSizeHints();
107
108     virtual void setOpacity(qreal level);
109     virtual void setMask(const QRegion &region);
110     virtual void requestActivateWindow();
111
112     virtual void handleContentOrientationChange(Qt::ScreenOrientation orientation);
113     virtual Qt::ScreenOrientation requestWindowOrientation(Qt::ScreenOrientation orientation);
114
115     virtual bool setKeyboardGrabEnabled(bool grab);
116     virtual bool setMouseGrabEnabled(bool grab);
117
118     virtual bool setWindowModified(bool modified);
119
120     virtual void windowEvent(QEvent *event);
121
122     virtual bool startSystemResize(const QPoint &pos, Qt::Corner corner);
123
124 protected:
125     QScopedPointer<QPlatformWindowPrivate> d_ptr;
126 private:
127     Q_DISABLE_COPY(QPlatformWindow)
128 };
129
130 QT_END_NAMESPACE
131
132 QT_END_HEADER
133 #endif //QPLATFORMWINDOW_H