Merge remote-tracking branch 'gerrit/master' into newdocs
[profile/ivi/qtbase.git] / src / gui / kernel / qplatformwindow.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 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 #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 void setWindowFlags(Qt::WindowFlags flags);
94     virtual void 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 setWindowFilePath(const QString &title);
101     virtual void setWindowIcon(const QIcon &icon);
102     virtual void raise();
103     virtual void lower();
104
105     virtual bool isExposed() const;
106     virtual bool isActive() const;
107     virtual bool isEmbedded(const QPlatformWindow *parentWindow) const;
108     virtual QPoint mapToGlobal(const QPoint &pos) const;
109     virtual QPoint mapFromGlobal(const QPoint &pos) const;
110
111     virtual void propagateSizeHints();
112
113     virtual void setOpacity(qreal level);
114     virtual void setMask(const QRegion &region);
115     virtual void requestActivateWindow();
116
117     virtual void handleContentOrientationChange(Qt::ScreenOrientation orientation);
118     virtual Qt::ScreenOrientation requestWindowOrientation(Qt::ScreenOrientation orientation);
119
120     virtual bool setKeyboardGrabEnabled(bool grab);
121     virtual bool setMouseGrabEnabled(bool grab);
122
123     virtual bool setWindowModified(bool modified);
124
125     virtual void windowEvent(QEvent *event);
126
127     virtual bool startSystemResize(const QPoint &pos, Qt::Corner corner);
128
129     virtual void setFrameStrutEventsEnabled(bool enabled);
130     virtual bool frameStrutEventsEnabled() const;
131
132 protected:
133     QScopedPointer<QPlatformWindowPrivate> d_ptr;
134 private:
135     Q_DISABLE_COPY(QPlatformWindow)
136 };
137
138 QT_END_NAMESPACE
139
140 QT_END_HEADER
141 #endif //QPLATFORMWINDOW_H