1/****************************************************************************
2**
3** Copyright (C) 2015 The Qt Company Ltd.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtScript module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSCRIPTCLASS_H
41#define QSCRIPTCLASS_H
42
43#include <QtCore/qstring.h>
44
45#include <QtCore/qvariant.h>
46#include <QtCore/qscopedpointer.h>
47#include <QtScript/qscriptvalue.h>
48
49QT_BEGIN_NAMESPACE
50
51
52class QScriptString;
53class QScriptClassPropertyIterator;
54
55class QScriptClassPrivate;
56class Q_SCRIPT_EXPORT QScriptClass
57{
58public:
59 enum QueryFlag {
60 HandlesReadAccess = 0x01,
61 HandlesWriteAccess = 0x02
62 };
63 Q_DECLARE_FLAGS(QueryFlags, QueryFlag)
64
65 enum Extension {
66 Callable,
67 HasInstance
68 };
69
70 QScriptClass(QScriptEngine *engine);
71 virtual ~QScriptClass();
72
73 QScriptEngine *engine() const;
74
75 virtual QueryFlags queryProperty(const QScriptValue &object,
76 const QScriptString &name,
77 QueryFlags flags, uint *id);
78
79 virtual QScriptValue property(const QScriptValue &object,
80 const QScriptString &name, uint id);
81
82 virtual void setProperty(QScriptValue &object, const QScriptString &name,
83 uint id, const QScriptValue &value);
84
85 virtual QScriptValue::PropertyFlags propertyFlags(
86 const QScriptValue &object, const QScriptString &name, uint id);
87
88 virtual QScriptClassPropertyIterator *newIterator(const QScriptValue &object);
89
90 virtual QScriptValue prototype() const;
91
92 virtual QString name() const;
93
94 virtual bool supportsExtension(Extension extension) const;
95 virtual QVariant extension(Extension extension,
96 const QVariant &argument = QVariant());
97
98protected:
99 QScriptClass(QScriptEngine *engine, QScriptClassPrivate &dd);
100 QScopedPointer<QScriptClassPrivate> d_ptr;
101
102private:
103 Q_DECLARE_PRIVATE(QScriptClass)
104 Q_DISABLE_COPY(QScriptClass)
105};
106
107Q_DECLARE_OPERATORS_FOR_FLAGS(QScriptClass::QueryFlags)
108
109QT_END_NAMESPACE
110
111#endif
112

source code of qtscript/src/script/api/qscriptclass.h