src/quick/items/qquickwindow.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 QtQml 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
  42 #ifndef QQUICKWINDOW_H
  43 #define QQUICKWINDOW_H
  44
  45 #include <QtQuick/qtquickglobal.h>
  46 #include <QtCore/qmetatype.h>
  47 #include <QtGui/qopengl.h>
  48 #include <QtGui/qwindow.h>
  49 #include <QtGui/qevent.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class QQuickItem;
  56 class QSGTexture;
  57 class QInputMethodEvent;
  58 class QQuickWindowPrivate;
  59 class QOpenGLFramebufferObject;
  60 class QQmlIncubationController;
  61 class QInputMethodEvent;
  62
  63 class Q_QUICK_EXPORT QQuickWindow : public QWindow
  64 {
  65     Q_OBJECT
  66     Q_PRIVATE_PROPERTY(QQuickWindow::d_func(), QQmlListProperty<QObject> data READ data DESIGNABLE false)
  67     Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged)
  68     Q_PROPERTY(QQuickItem* contentItem READ contentItem CONSTANT FINAL)
  69     Q_CLASSINFO("DefaultProperty", "data")
  70     Q_DECLARE_PRIVATE(QQuickWindow)
  71 public:
  72     enum CreateTextureOption {
  73         TextureHasAlphaChannel  = 0x0001,
  74         TextureHasMipmaps       = 0x0002,
  75         TextureOwnsGLTexture    = 0x0004
  76     };
  77
  78     Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
  79
  80     QQuickWindow(QWindow *parent = 0);
  81
  82     virtual ~QQuickWindow();
  83
  84     QQuickItem *contentItem() const;
  85     //XXX rootItem renamed contentItem - this function must be removed before 5.0
  86     QQuickItem *rootItem() const { return contentItem(); }
  87
  88     QQuickItem *activeFocusItem() const;
  89     QObject *focusObject() const;
  90
  91     QQuickItem *mouseGrabberItem() const;
  92
  93     bool sendEvent(QQuickItem *, QEvent *);
  94
  95     QImage grabWindow();
  96
  97     void setRenderTarget(QOpenGLFramebufferObject *fbo);
  98     QOpenGLFramebufferObject *renderTarget() const;
  99
 100     void setRenderTarget(uint fboId, const QSize &size);
 101     uint renderTargetId() const;
 102     QSize renderTargetSize() const;
 103
 104     QQmlIncubationController *incubationController() const;
 105
 106 #ifndef QT_NO_ACCESSIBILITY
 107     virtual QAccessibleInterface *accessibleRoot() const;
 108 #endif
 109
 110     // Scene graph specific functions
 111     QSGTexture *createTextureFromImage(const QImage &image) const;
 112     QSGTexture *createTextureFromId(uint id, const QSize &size, CreateTextureOptions options = CreateTextureOption(0)) const;
 113
 114     void setClearBeforeRendering(bool enabled);
 115     bool clearBeforeRendering() const;
 116
 117     void setColor(const QColor &color);
 118     QColor color() const;
 119
 120     void setPersistentOpenGLContext(bool persistent);
 121     bool isPersistentOpenGLContext() const;
 122
 123     void setPersistentSceneGraph(bool persistent);
 124     bool isPersistentSceneGraph() const;
 125
 126     QOpenGLContext *openglContext() const;
 127
 128 Q_SIGNALS:
 129     void frameSwapped();
 130     void sceneGraphInitialized();
 131     void sceneGraphInvalidated();
 132     void beforeSynchronizing();
 133     void beforeRendering();
 134     void afterRendering();
 135     void colorChanged(const QColor &);
 136
 137 public Q_SLOTS:
 138     void update();
 139     void releaseResources();
 140
 141 protected:
 142     QQuickWindow(QQuickWindowPrivate &dd, QWindow *parent = 0);
 143
 144     virtual void exposeEvent(QExposeEvent *);
 145     virtual void resizeEvent(QResizeEvent *);
 146
 147     virtual void showEvent(QShowEvent *);
 148     virtual void hideEvent(QHideEvent *);
 149
 150     virtual void focusInEvent(QFocusEvent *);
 151     virtual void focusOutEvent(QFocusEvent *);
 152
 153     virtual bool event(QEvent *);
 154     virtual void keyPressEvent(QKeyEvent *);
 155     virtual void keyReleaseEvent(QKeyEvent *);
 156     virtual void mousePressEvent(QMouseEvent *);
 157     virtual void mouseReleaseEvent(QMouseEvent *);
 158     virtual void mouseDoubleClickEvent(QMouseEvent *);
 159     virtual void mouseMoveEvent(QMouseEvent *);
 160 #ifndef QT_NO_WHEELEVENT
 161     virtual void wheelEvent(QWheelEvent *);
 162 #endif
 163
 164 private Q_SLOTS:
 165     void maybeUpdate();
 166     void cleanupSceneGraph();
 167
 168 private:
 169     friend class QQuickItem;
 170     friend class QQuickWindowRenderLoop;
 171     Q_DISABLE_COPY(QQuickWindow)
 172 };
 173
 174 QT_END_NAMESPACE
 175
 176 Q_DECLARE_METATYPE(QQuickWindow *)
 177
 178 QT_END_HEADER
 179
 180 #endif // QQUICKWINDOW_H
 181