Docs - add missing images and code, clean up sections
[profile/ivi/qtdeclarative.git] / src / qml / qml / qquickworkerscript_p.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 QtQml 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 QQUICKWORKERSCRIPT_P_H
43 #define QQUICKWORKERSCRIPT_P_H
44
45 //
46 //  W A R N I N G
47 //  -------------
48 //
49 // This file is not part of the Qt API.  It exists purely as an
50 // implementation detail.  This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55
56 #include "qqml.h"
57 #include "qqmlparserstatus.h"
58
59 #include <QtCore/qthread.h>
60 #include <QtQml/qjsvalue.h>
61 #include <QtCore/qurl.h>
62
63 QT_BEGIN_HEADER
64
65 QT_BEGIN_NAMESPACE
66
67
68 class QQuickWorkerScript;
69 class QQuickWorkerScriptEnginePrivate;
70 class QQuickWorkerScriptEngine : public QThread
71 {
72 Q_OBJECT
73 public:
74     QQuickWorkerScriptEngine(QQmlEngine *parent = 0);
75     virtual ~QQuickWorkerScriptEngine();
76
77     int registerWorkerScript(QQuickWorkerScript *);
78     void removeWorkerScript(int);
79     void executeUrl(int, const QUrl &);
80     void sendMessage(int, const QByteArray &);
81
82 protected:
83     virtual void run();
84
85 private:
86     QQuickWorkerScriptEnginePrivate *d;
87 };
88
89 class QQmlV8Function;
90 class QQmlV8Handle;
91 class Q_AUTOTEST_EXPORT QQuickWorkerScript : public QObject, public QQmlParserStatus
92 {
93     Q_OBJECT
94     Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
95
96     Q_INTERFACES(QQmlParserStatus)
97 public:
98     QQuickWorkerScript(QObject *parent = 0);
99     virtual ~QQuickWorkerScript();
100
101     QUrl source() const;
102     void setSource(const QUrl &);
103
104 public slots:
105     void sendMessage(QQmlV8Function*);
106
107 signals:
108     void sourceChanged();
109     void message(const QQmlV8Handle &messageObject);
110
111 protected:
112     virtual void classBegin();
113     virtual void componentComplete();
114     virtual bool event(QEvent *);
115
116 private:
117     QQuickWorkerScriptEngine *engine();
118     QQuickWorkerScriptEngine *m_engine;
119     int m_scriptId;
120     QUrl m_source;
121     bool m_componentComplete;
122 };
123
124 QT_END_NAMESPACE
125
126 QML_DECLARE_TYPE(QQuickWorkerScript)
127
128 QT_END_HEADER
129
130 #endif // QQUICKWORKERSCRIPT_P_H