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