src/quick/items/qquickcanvas.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 QtDeclarative 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 QQUICKCANVAS_H
  43 #define QQUICKCANVAS_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 QSGEngine;
  56 class QQuickItem;
  57 class QSGTexture;
  58 class QInputMethodEvent;
  59 class QQuickCanvasPrivate;
  60 class QOpenGLFramebufferObject;
  61 class QDeclarativeIncubationController;
  62 class QInputMethodEvent;
  63
  64 class Q_QUICK_EXPORT QQuickCanvas : public QWindow
  65 {
  66     Q_OBJECT
  67     Q_PRIVATE_PROPERTY(QQuickCanvas::d_func(), QDeclarativeListProperty<QObject> data READ data DESIGNABLE false)
  68     Q_PROPERTY(QColor color READ clearColor WRITE setClearColor NOTIFY clearColorChanged)
  69     Q_CLASSINFO("DefaultProperty", "data")
  70     Q_DECLARE_PRIVATE(QQuickCanvas)
  71 public:
  72     enum CreateTextureOption {
  73         TextureHasAlphaChannel  = 0x0001,
  74         TextureHasMipmaps       = 0x0002,
  75         TextureOwnsGLTexture    = 0x0004
  76     };
  77
  78     Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
  79
  80     QQuickCanvas(QWindow *parent = 0);
  81
  82     virtual ~QQuickCanvas();
  83
  84     QQuickItem *rootItem() const;
  85     QQuickItem *activeFocusItem() const;
  86     QObject *focusObject() const;
  87
  88     QQuickItem *mouseGrabberItem() const;
  89
  90     bool sendEvent(QQuickItem *, QEvent *);
  91
  92     QSGEngine *sceneGraphEngine() const;
  93
  94     QImage grabFrameBuffer();
  95
  96     void setRenderTarget(QOpenGLFramebufferObject *fbo);
  97     QOpenGLFramebufferObject *renderTarget() const;
  98
  99     QDeclarativeIncubationController *incubationController() const;
 100
 101     virtual QAccessibleInterface *accessibleRoot() const;
 102
 103     // Scene graph specific functions
 104     QSGTexture *createTextureFromImage(const QImage &image) const;
 105     QSGTexture *createTextureFromId(uint id, const QSize &size, CreateTextureOptions options = CreateTextureOption(0)) const;
 106
 107     void setClearBeforeRendering(bool enabled);
 108     bool clearBeforeRendering() const;
 109
 110     void setClearColor(const QColor &color);
 111     QColor clearColor() const;
 112
 113     QOpenGLContext *openglContext() const;
 114
 115 Q_SIGNALS:
 116     void frameSwapped();
 117     void sceneGraphInitialized();
 118     void sceneGraphInvalidated();
 119     void beforeRendering();
 120     void afterRendering();
 121     void clearColorChanged(const QColor &);
 122
 123 protected:
 124     QQuickCanvas(QQuickCanvasPrivate &dd, QWindow *parent = 0);
 125
 126     virtual void exposeEvent(QExposeEvent *);
 127     virtual void resizeEvent(QResizeEvent *);
 128
 129     virtual void showEvent(QShowEvent *);
 130     virtual void hideEvent(QHideEvent *);
 131
 132     virtual void focusInEvent(QFocusEvent *);
 133     virtual void focusOutEvent(QFocusEvent *);
 134
 135     virtual bool event(QEvent *);
 136     virtual void keyPressEvent(QKeyEvent *);
 137     virtual void keyReleaseEvent(QKeyEvent *);
 138     virtual void mousePressEvent(QMouseEvent *);
 139     virtual void mouseReleaseEvent(QMouseEvent *);
 140     virtual void mouseDoubleClickEvent(QMouseEvent *);
 141     virtual void mouseMoveEvent(QMouseEvent *);
 142 #ifndef QT_NO_WHEELEVENT
 143     virtual void wheelEvent(QWheelEvent *);
 144 #endif
 145
 146 private Q_SLOTS:
 147     void maybeUpdate();
 148     void cleanupSceneGraph();
 149
 150 private:
 151     friend class QQuickItem;
 152     friend class QQuickCanvasRenderLoop;
 153     Q_DISABLE_COPY(QQuickCanvas)
 154 };
 155
 156 QT_END_NAMESPACE
 157
 158 Q_DECLARE_METATYPE(QQuickCanvas *)
 159
 160 QT_END_HEADER
 161
 162 #endif // QQUICKCANVAS_H
 163