Initial import from the monolithic Qt.
[profile/ivi/qtdeclarative.git] / src / declarative / 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 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
14 ** this package.
15 **
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file.  Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23 **
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27 **
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
30 **
31 **
32 **
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 QT_MODULE(Declarative)
56
57 class QGraphicsObject;
58 class QDeclarativeEngine;
59 class QDeclarativeContext;
60 class QDeclarativeError;
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     void setSource(const QUrl&);
77
78     QDeclarativeEngine* engine() const;
79     QDeclarativeContext* rootContext() const;
80
81     QGraphicsObject *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 Q_SIGNALS:
96     void sceneResized(QSize size); // ???
97     void statusChanged(QDeclarativeView::Status);
98
99 private Q_SLOTS:
100     void continueExecute();
101
102 protected:
103     virtual void resizeEvent(QResizeEvent *);
104     virtual void paintEvent(QPaintEvent *event);
105     virtual void timerEvent(QTimerEvent*);
106     virtual void setRootObject(QObject *obj);
107     virtual bool eventFilter(QObject *watched, QEvent *e);
108
109 private:
110     Q_DISABLE_COPY(QDeclarativeView)
111     Q_DECLARE_PRIVATE(QDeclarativeView)
112 };
113
114 QT_END_NAMESPACE
115
116 QT_END_HEADER
117
118 #endif // QDECLARATIVEVIEW_H