1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\example script/defaultprototypes
\title Default Prototypes Example
This Qt Script example shows how to use default prototypes
to make a non-QObject-based type scriptable.
\image defaultprototypes-example.png
With QScriptEngine::setDefaultPrototype() you can specify
a QtScript object that defines a scripting interface for
a C++ type; Qt Script operations on values of such types
will then be delegated to your prototype object. In this
example, a simple scripting interface for QListWidgetItem is
defined, so that the text of items can easily be accessed from
script code.
To define a scripting API for QListWidgetItem in terms of
Qt properties and slots, we subclass QObject and QScriptable.
\snippet examples/script/defaultprototypes/prototypes.h 0
A single property, \c{text}, is defined, along with a slot,
\c{toString}.
\snippet examples/script/defaultprototypes/prototypes.cpp 0
The implementation of the property accessors use
the qscriptvalue_cast() function to cast the script object
to a QListWidgetItem pointer. The normal C++ QListWidgetItem
API is then used to implement the desired functionality.
Although not shown here, it is possible to throw a script
exception from a prototype function; for example, you could throw
a TypeError exception if the qscriptvalue_cast() fails.
QListWidgetItems are usually added to a QListWidget. While
QListWidget is a QObject-based class, not all the functionality
needed for this example are present. We can solve this by creating
a default prototype for the QListWidget class as well. The
prototype will augment the functionality already provided by the
Qt Script QObject integration; i.e. if a property or slot is not
found in the QListWidget object itself, the prototype will be used
as a fallback.
\snippet examples/script/defaultprototypes/prototypes.h 1
The additional slots will make it possible to add items to
a QListWidget from script code, and to set the background
color of the widget from a string.
\snippet examples/script/defaultprototypes/prototypes.cpp 1
Again, we use qscriptvalue_cast() to cast the script object
to the relevant C++ type, in this case a QListWidget pointer.
The addItem() and addItems() functions simply forward their
arguments to the corresponding functions in the QListWidget
class. setBackgroundColor() gets the widget's palette, creates
a QColor from the given string argument and changes the palette
accordingly.
\snippet examples/script/defaultprototypes/main.cpp 0
The relevant C++ types must be made known to Qt's meta type
system.
\snippet examples/script/defaultprototypes/main.cpp 1
For each type that we want to associate a prototype object with,
we create an instance of the prototype class, pass it to
QScriptEngine::newQObject(), and then create the link between
the C++ type and the resulting script object by calling
QScriptEngine::setDefaultPrototype().
\snippet examples/script/defaultprototypes/main.cpp 2
In this example, a single QListWidget object is added as
a global script variable, called \c{listWidget}. Script code
can add items to this widget by calling addItem() or addItems().
\snippet examples/script/defaultprototypes/code.js 0
Script code can connect to signals of the QListWidget object;
signal handlers can use the interface defined in
the QListWidgetItem prototype to manipulate item arguments.
\snippet examples/script/defaultprototypes/code.js 1
Not shown in this example is how to make QListWidgetItem
constructible from Qt Script code, i.e. to be able to
write "new QListWidgetItem()" in a script. In order to do
this, you have to define your own script constructor for
the type. The constructor would just be a factory function
that constructs a new C++ QListWidgetItem and returns it
back to the script. See QScriptEngine::newFunction() for more
information.
*/
|
