src/declarative/items/qsgview.h

   1 // Commit: 0b83a2161261be525f01359397ab1c8c34827749
   2 /****************************************************************************
   3 **
   4 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   5 ** All rights reserved.
   6 ** Contact: Nokia Corporation (qt-info@nokia.com)
   7 **
   8 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   9 **
  10 ** $QT_BEGIN_LICENSE:LGPL$
  11 ** GNU Lesser General Public License Usage
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this
  15 ** file. Please review the following information to ensure the GNU Lesser
  16 ** General Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** GNU General Public License Usage
  24 ** Alternatively, this file may be used under the terms of the GNU General
  25 ** Public License version 3.0 as published by the Free Software Foundation
  26 ** and appearing in the file LICENSE.GPL included in the packaging of this
  27 ** file. Please review the following information to ensure the GNU General
  28 ** Public License version 3.0 requirements will be met:
  29 ** http://www.gnu.org/copyleft/gpl.html.
  30 **
  31 ** Other Usage
  32 ** Alternatively, this file may be used in accordance with the terms and
  33 ** conditions contained in a signed written agreement between you and Nokia.
  34 **
  35 **
  36 **
  37 **
  38 **
  39 ** $QT_END_LICENSE$
  40 **
  41 ****************************************************************************/
  42
  43 #ifndef QSGVIEW_H
  44 #define QSGVIEW_H
  45
  46 #include <qsgcanvas.h>
  47 #include <QtCore/qurl.h>
  48 #include <QtDeclarative/qdeclarativedebug.h>
  49
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 QT_MODULE(Declarative)
  55
  56 class QDeclarativeEngine;
  57 class QDeclarativeContext;
  58 class QDeclarativeError;
  59 class QSGItem;
  60
  61 class QSGViewPrivate;
  62 class Q_DECLARATIVE_EXPORT QSGView : public QSGCanvas
  63 {
  64     Q_OBJECT
  65     Q_PROPERTY(ResizeMode resizeMode READ resizeMode WRITE setResizeMode)
  66     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
  67     Q_PROPERTY(QUrl source READ source WRITE setSource DESIGNABLE true)
  68     Q_ENUMS(ResizeMode Status)
  69 public:
  70     explicit QSGView(QWidget *parent = 0, Qt::WindowFlags f = 0);
  71     explicit QSGView(const QGLFormat &format, QWidget *parent = 0, Qt::WindowFlags f = 0);
  72     QSGView(const QUrl &source, QWidget *parent = 0, Qt::WindowFlags f = 0);
  73     QSGView(const QUrl &source, const QGLFormat &format, QWidget *parent = 0, Qt::WindowFlags f = 0);
  74     virtual ~QSGView();
  75
  76     QUrl source() const;
  77
  78     QDeclarativeEngine* engine() const;
  79     QDeclarativeContext* rootContext() const;
  80
  81     QSGItem *rootObject() const;
  82
  83     enum ResizeMode { SizeViewToRootObject, SizeRootObjectToView };
  84     ResizeMode resizeMode() const;
  85     void setResizeMode(ResizeMode);
  86
  87     enum Status { Null, Ready, Loading, Error };
  88     Status status() const;
  89
  90     QList<QDeclarativeError> errors() const;
  91
  92     QSize sizeHint() const;
  93     QSize initialSize() const;
  94
  95 public Q_SLOTS:
  96     void setSource(const QUrl&);
  97
  98 Q_SIGNALS:
  99     void statusChanged(QSGView::Status);
 100
 101 private Q_SLOTS:
 102     void continueExecute();
 103
 104 protected:
 105     virtual void resizeEvent(QResizeEvent *);
 106     virtual void paintEvent(QPaintEvent *event);
 107     virtual void timerEvent(QTimerEvent*);
 108
 109     virtual void keyPressEvent(QKeyEvent *);
 110     virtual void keyReleaseEvent(QKeyEvent *);
 111     virtual void mousePressEvent(QMouseEvent *);
 112     virtual void mouseReleaseEvent(QMouseEvent *);
 113     virtual void mouseMoveEvent(QMouseEvent *);
 114 private:
 115     Q_DISABLE_COPY(QSGView)
 116     Q_DECLARE_PRIVATE(QSGView)
 117 };
 118
 119 QT_END_NAMESPACE
 120
 121 QT_END_HEADER
 122
 123 #endif // QSGVIEW_H