bc156f3307269b8197754f24a6398a9715424b99
[profile/ivi/qtdeclarative.git] / src / qtquick1 / util / qdeclarativeview.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: http://www.qt-project.org/
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 <QtWidgets/qgraphicssceneevent.h>
48 #include <QtWidgets/qgraphicsview.h>
49 #include <QtWidgets/qwidget.h>
50 #include <QtDeclarative/qdeclarativedebug.h>
51
52 QT_BEGIN_HEADER
53
54 QT_BEGIN_NAMESPACE
55
56 class QGraphicsObject;
57 class QDeclarativeEngine;
58 class QDeclarativeContext;
59 class QDeclarativeError;
60 class QDeclarativeItem;
61
62
63 class QDeclarativeViewPrivate;
64 class Q_QTQUICK1_EXPORT QDeclarativeView : public QGraphicsView
65 {
66     Q_OBJECT
67     Q_PROPERTY(ResizeMode resizeMode READ resizeMode WRITE setResizeMode)
68     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
69     Q_PROPERTY(QUrl source READ source WRITE setSource DESIGNABLE true)
70     Q_ENUMS(ResizeMode Status)
71 public:
72     explicit QDeclarativeView(QWidget *parent = 0);
73     QDeclarativeView(const QUrl &source, QWidget *parent = 0);
74     virtual ~QDeclarativeView();
75
76     QUrl source() const;
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 public Q_SLOTS:
96     void setSource(const QUrl&);
97
98 Q_SIGNALS:
99     void sceneResized(QSize size); // ???
100     void statusChanged(QDeclarativeView::Status);
101     void initialSizeChanged(QSize size);
102
103 private Q_SLOTS:
104     void continueExecute();
105
106 protected:
107     virtual void resizeEvent(QResizeEvent *);
108     virtual void paintEvent(QPaintEvent *event);
109     virtual void timerEvent(QTimerEvent*);
110     virtual void setRootObject(QObject *obj);
111     virtual bool eventFilter(QObject *watched, QEvent *e);
112
113 private:
114     Q_DISABLE_COPY(QDeclarativeView)
115     Q_DECLARE_PRIVATE(QDeclarativeView)
116 // Accessibility support:
117     friend class QAccessibleDeclarativeView;
118     QDeclarativeItem *accessibleRootItem() const;
119 };
120
121 QT_END_NAMESPACE
122
123 QT_END_HEADER
124
125 #endif // QDECLARATIVEVIEW_H