source: trunk/src/script/qscriptvalueiterator.cpp@ 447

Last change on this file since 447 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 8.5 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtScript module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
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 [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "qscriptvalueiterator.h"
43
44#ifndef QT_NO_SCRIPT
45
46#include "qscriptvalueiterator_p.h"
47#include "qscriptvalueiteratorimpl_p.h"
48#include "qscriptengine_p.h"
49#include "qscriptcontext_p.h"
50#include "qscriptvalueimpl_p.h"
51#include "qscriptmember_p.h"
52#include "qscriptobject_p.h"
53
54QT_BEGIN_NAMESPACE
55
56/*!
57 \since 4.3
58 \class QScriptValueIterator
59
60 \brief The QScriptValueIterator class provides a Java-style iterator for QScriptValue.
61
62 \ingroup script
63 \mainclass
64
65 The QScriptValueIterator constructor takes a QScriptValue as
66 argument. After construction, the iterator is located at the very
67 beginning of the sequence of properties. Here's how to iterate over
68 all the properties of a QScriptValue:
69
70 \snippet doc/src/snippets/code/src_script_qscriptvalueiterator.cpp 0
71
72 The next() advances the iterator. The name(), value() and flags()
73 functions return the name, value and flags of the last item that was
74 jumped over.
75
76 If you want to remove properties as you iterate over the
77 QScriptValue, use remove(). If you want to modify the value of a
78 property, use setValue().
79
80 Note that QScriptValueIterator only iterates over the QScriptValue's
81 own properties; i.e. it does not follow the prototype chain. You can
82 use a loop like this to follow the prototype chain:
83
84 \snippet doc/src/snippets/code/src_script_qscriptvalueiterator.cpp 1
85
86 Note that QScriptValueIterator will not automatically skip over