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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/****************************************************************************
**
** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the $MODULE$ of the Qt Toolkit.
**
** $TROLLTECH_DUAL_LICENSE$
**
****************************************************************************/
#include "qscriptclasspropertyiterator.h"
#ifndef QT_NO_SCRIPT
#include "qscriptstring.h"
QT_BEGIN_NAMESPACE
/*!
\since 4.4
\class QScriptClassPropertyIterator
\brief The QScriptClassPropertyIterator class provides an iterator interface for custom Qt Script objects.
\ingroup script
This class is only relevant if you have subclassed QScriptClass and
want to provide enumeration of your custom properties (e.g. when
objects of your class are used with QScriptValueIterator, or with
the for-in statement in scripts).
The object() function returns the Qt Script object the iterator is
traversing.
toFront(), hasNext() and next() provide forward iteration.
toBack(), hasPrevious() and previous() provide backward iteration.
name(), id() and flags() return information about the last property
that was jumped over using next() or previous().
\sa QScriptClass::newIterator(), QScriptValueIterator
*/
class QScriptClassPropertyIteratorPrivate
{
Q_DECLARE_PUBLIC(QScriptClassPropertyIterator)
public:
QScriptClassPropertyIteratorPrivate() {}
virtual ~QScriptClassPropertyIteratorPrivate() {}
QScriptValue object;
QScriptClassPropertyIterator *q_ptr;
};
/*!
Constructs an iterator for traversing \a object.
Subclasses should ensure that the iterator is set to the front of the
sequence of properties (before the first property).
*/
QScriptClassPropertyIterator::QScriptClassPropertyIterator(const QScriptValue &object)
: d_ptr(new QScriptClassPropertyIteratorPrivate)
{
d_ptr->q_ptr = this;
d_ptr->object = object;
}
/*!
\internal
*/
QScriptClassPropertyIterator::QScriptClassPropertyIterator(const QScriptValue &object,
QScriptClassPropertyIteratorPrivate &dd)
: d_ptr(&dd)
{
d_ptr->q_ptr = this;
d_ptr->object = object;
}
/*!
Destroys the iterator.
*/
QScriptClassPropertyIterator::~QScriptClassPropertyIterator()
{
delete d_ptr;
d_ptr = 0;
}
/*!
Returns the Qt Script object this iterator is traversing.
*/
QScriptValue QScriptClassPropertyIterator::object() const
{
Q_D(const QScriptClassPropertyIterator);
return d->object;
}
/*!
\fn bool QScriptClassPropertyIterator::hasNext() const
Returns true if there is at least one item ahead of the iterator
(i.e. the iterator is \e not at the back of the property sequence);
otherwise returns false.
\sa next(), hasPrevious()
*/
/*!
\fn void QScriptClassPropertyIterator::next()
Advances the iterator by one position.
Calling this function on an iterator located at the back of the
container leads to undefined results.
\sa hasNext(), previous(), name()
*/
/*!
\fn bool QScriptClassPropertyIterator::hasPrevious() const
Returns true if there is at least one item behind the iterator
(i.e. the iterator is \e not at the front of the property sequence);
otherwise returns false.
\sa previous(), hasNext()
*/
/*!
\fn void QScriptClassPropertyIterator::previous()
Moves the iterator back by one position.
Calling this function on an iterator located at the front of the
container leads to undefined results.
\sa hasPrevious(), next(), name()
*/
/*!
\fn void QScriptClassPropertyIterator::toFront()
Moves the iterator to the front of the QScriptValue (before the
first property).
\sa toBack(), next()
*/
/*!
\fn void QScriptClassPropertyIterator::toBack()
Moves the iterator to the back of the QScriptValue (after the
last property).
\sa toFront(), previous()
*/
/*!
\fn QScriptString QScriptClassPropertyIterator::name() const
Returns the name of the last property that was jumped over using
next() or previous().
\sa id()
*/
/*!
\fn uint QScriptClassPropertyIterator::id() const
Returns the id of the last property that was jumped over using
next() or previous().
The default implementation returns 0.
\sa name()
*/
uint QScriptClassPropertyIterator::id() const
{
return 0;
}
/*!
Returns the flags of the last property that was jumped over using
next() or previous().
The default implementation calls the propertyFlags() function of
object() with argument name().
*/
QScriptValue::PropertyFlags QScriptClassPropertyIterator::flags() const
{
return object().propertyFlags(name());
}
QT_END_NAMESPACE
#endif // QT_NO_SCRIPT
|
