src/script/qscriptclass.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: Nokia Corporation (qt-info@nokia.com)
   5 **
   6 ** This file is part of the QtScript module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** No Commercial Usage
  10 ** This file contains pre-release code and may not be distributed.
  11 ** You may use this file in accordance with the terms and conditions
  12 ** contained in the either Technology Preview License Agreement or the
  13 ** Beta Release License Agreement.
  14 **
  15 ** GNU Lesser General Public License Usage
  16 ** Alternatively, this file may be used under the terms of the GNU Lesser
  17 ** General Public License version 2.1 as published by the Free Software
  18 ** Foundation and appearing in the file LICENSE.LGPL included in the
  19 ** packaging of this file.  Please review the following information to
  20 ** ensure the GNU Lesser General Public License version 2.1 requirements
  21 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  22 **
  23 ** In addition, as a special exception, Nokia gives you certain
  24 ** additional rights. These rights are described in the Nokia Qt LGPL
  25 ** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
  26 ** package.
  27 **
  28 ** GNU General Public License Usage
  29 ** Alternatively, this file may be used under the terms of the GNU
  30 ** General Public License version 3.0 as published by the Free Software
  31 ** Foundation and appearing in the file LICENSE.GPL included in the
  32 ** packaging of this file.  Please review the following information to
  33 ** ensure the GNU General Public License version 3.0 requirements will be
  34 ** met: http://www.gnu.org/copyleft/gpl.html.
  35 **
  36 ** If you are unsure which license is appropriate for your use, please
  37 ** contact the sales department at http://www.qtsoftware.com/contact.
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSCRIPTCLASS_H
  43 #define QSCRIPTCLASS_H
  44
  45 #include <QtCore/qstring.h>
  46
  47 #ifndef QT_NO_SCRIPT
  48
  49 #include <QtCore/qvariant.h>
  50 #include <QtScript/qscriptvalue.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 QT_MODULE(Script)
  57
  58 class QScriptString;
  59 class QScriptClassPropertyIterator;
  60
  61 class QScriptClassPrivate;
  62 class Q_SCRIPT_EXPORT QScriptClass
  63 {
  64 public:
  65     enum QueryFlag {
  66         HandlesReadAccess = 0x01,
  67         HandlesWriteAccess = 0x02
  68     };
  69     Q_DECLARE_FLAGS(QueryFlags, QueryFlag)
  70
  71     enum Extension {
  72         Callable,
  73         HasInstance
  74     };
  75
  76     QScriptClass(QScriptEngine *engine);
  77     virtual ~QScriptClass();
  78
  79     QScriptEngine *engine() const;
  80
  81     virtual QueryFlags queryProperty(const QScriptValue &object,
  82                                      const QScriptString &name,
  83                                      QueryFlags flags, uint *id);
  84
  85     virtual QScriptValue property(const QScriptValue &object,
  86                                   const QScriptString &name, uint id);
  87
  88     virtual void setProperty(QScriptValue &object, const QScriptString &name,
  89                              uint id, const QScriptValue &value);
  90
  91     virtual QScriptValue::PropertyFlags propertyFlags(
  92         const QScriptValue &object, const QScriptString &name, uint id);
  93
  94     virtual QScriptClassPropertyIterator *newIterator(const QScriptValue &object);
  95
  96     virtual QScriptValue prototype() const;
  97
  98     virtual QString name() const;
  99
 100     virtual bool supportsExtension(Extension extension) const;
 101     virtual QVariant extension(Extension extension,
 102                                const QVariant &argument = QVariant());
 103
 104 protected:
 105     QScriptClass(QScriptEngine *engine, QScriptClassPrivate &dd);
 106     QScriptClassPrivate *d_ptr;
 107
 108 private:
 109     Q_DECLARE_PRIVATE(QScriptClass)
 110     Q_DISABLE_COPY(QScriptClass)
 111 };
 112
 113 Q_DECLARE_OPERATORS_FOR_FLAGS(QScriptClass::QueryFlags)
 114
 115 QT_END_NAMESPACE
 116
 117 QT_END_HEADER
 118
 119 #endif // QT_NO_SCRIPT
 120
 121 #endif