src/declarative/qml/qdeclarativeworkerscript_p.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 QDECLARATIVEWORKERSCRIPT_P_H
  43 #define QDECLARATIVEWORKERSCRIPT_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 "qdeclarative.h"
  57 #include "qdeclarativeparserstatus.h"
  58
  59 #include <QtCore/qthread.h>
  60 #include <QtScript/qscriptvalue.h>
  61 #include <QtCore/qurl.h>
  62
  63 QT_BEGIN_HEADER
  64
  65 QT_BEGIN_NAMESPACE
  66
  67 QT_MODULE(Declarative)
  68
  69 class QDeclarativeWorkerScript;
  70 class QDeclarativeWorkerScriptEnginePrivate;
  71 class QDeclarativeWorkerScriptEngine : public QThread
  72 {
  73 Q_OBJECT
  74 public:
  75     QDeclarativeWorkerScriptEngine(QDeclarativeEngine *parent = 0);
  76     virtual ~QDeclarativeWorkerScriptEngine();
  77
  78     int registerWorkerScript(QDeclarativeWorkerScript *);
  79     void removeWorkerScript(int);
  80     void executeUrl(int, const QUrl &);
  81     void sendMessage(int, const QVariant &);
  82
  83 protected:
  84     virtual void run();
  85
  86 private:
  87     QDeclarativeWorkerScriptEnginePrivate *d;
  88 };
  89
  90 class Q_AUTOTEST_EXPORT QDeclarativeWorkerScript : public QObject, public QDeclarativeParserStatus
  91 {
  92     Q_OBJECT
  93     Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
  94
  95     Q_INTERFACES(QDeclarativeParserStatus)
  96 public:
  97     QDeclarativeWorkerScript(QObject *parent = 0);
  98     virtual ~QDeclarativeWorkerScript();
  99
 100     QUrl source() const;
 101     void setSource(const QUrl &);
 102
 103 public slots:
 104     void sendMessage(const QScriptValue &);
 105
 106 signals:
 107     void sourceChanged();
 108     void message(const QScriptValue &messageObject);
 109
 110 protected:
 111     virtual void classBegin();
 112     virtual void componentComplete();
 113     virtual bool event(QEvent *);
 114
 115 private:
 116     QDeclarativeWorkerScriptEngine *engine();
 117     QDeclarativeWorkerScriptEngine *m_engine;
 118     int m_scriptId;
 119     QUrl m_source;
 120     bool m_componentComplete;
 121 };
 122
 123 QT_END_NAMESPACE
 124
 125 QML_DECLARE_TYPE(QDeclarativeWorkerScript)
 126
 127 QT_END_HEADER
 128
 129 #endif // QDECLARATIVEWORKERSCRIPT_P_H