1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 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 QtScript 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 QSCRIPTCLASS_H

    43 #define QSCRIPTCLASS_H

    44 

    45 #include <QtCore/qstring.h>

    46 

    47 #include <QtCore/qvariant.h>

    48 #include <QtCore/qscopedpointer.h>

    49 #include <QtScript/qscriptvalue.h>

    50 

    51 QT_BEGIN_HEADER

    52 

    53 QT_BEGIN_NAMESPACE

    54 

    55 QT_MODULE(Script)

    56 

    57 class QScriptString;

    58 class QScriptClassPropertyIterator;

    59 

    60 class QScriptClassPrivate;

    61 class Q_SCRIPT_EXPORT QScriptClass

    62 {

    63 public:

    64     enum QueryFlag {

    65         HandlesReadAccess = 0x01,

    66         HandlesWriteAccess = 0x02

    67     };

    68     Q_DECLARE_FLAGS(QueryFlags, QueryFlag)

    69 

    70     enum Extension {

    71         Callable,

    72         HasInstance

    73     };

    74 

    75     QScriptClass(QScriptEngine *engine);

    76     virtual ~QScriptClass();

    77 

    78     QScriptEngine *engine() const;

    79 

    80     virtual QueryFlags queryProperty(const QScriptValue &object,

    81                                      const QScriptString &name,

    82                                      QueryFlags flags, uint *id);

    83 

    84     virtual QScriptValue property(const QScriptValue &object,

    85                                   const QScriptString &name, uint id);

    86 

    87     virtual void setProperty(QScriptValue &object, const QScriptString &name,

    88                              uint id, const QScriptValue &value);

    89 

    90     virtual QScriptValue::PropertyFlags propertyFlags(

    91         const QScriptValue &object, const QScriptString &name, uint id);

    92 

    93     virtual QScriptClassPropertyIterator *newIterator(const QScriptValue &object);

    94 

    95     virtual QScriptValue prototype() const;

    96 

    97     virtual QString name() const;

    98 

    99     virtual bool supportsExtension(Extension extension) const;

   100     virtual QVariant extension(Extension extension,

   101                                const QVariant &argument = QVariant());

   102 

   103 protected:

   104     QScriptClass(QScriptEngine *engine, QScriptClassPrivate &dd);

   105     QScopedPointer<QScriptClassPrivate> d_ptr;

   106 

   107 private:

   108     Q_DECLARE_PRIVATE(QScriptClass)

   109     Q_DISABLE_COPY(QScriptClass)

   110 };

   111 

   112 Q_DECLARE_OPERATORS_FOR_FLAGS(QScriptClass::QueryFlags)

   113 

   114 QT_END_NAMESPACE

   115 

   116 QT_END_HEADER

   117 

   118 #endif