summaryrefslogtreecommitdiffstats
path: root/src/script/api/qscriptclasspropertyiterator.cpp
diff options
context:
space:
mode:
authorQt by Nokia <qt-info@nokia.com>2011-04-27 12:05:43 +0200
committeraxis <qt-info@nokia.com>2011-04-27 12:05:43 +0200
commitc4af45c2914381172e1bd7ee528481edaa2fff1a (patch)
tree01265e109316fda93845e1c96c5e566d870f51d0 /src/script/api/qscriptclasspropertyiterator.cpp
Initial import from the monolithic Qt.
This is the beginning of revision history for this module. If you want to look at revision history older than this, please refer to the Qt Git wiki for how to use Git history grafting. At the time of writing, this wiki is located here: http://qt.gitorious.org/qt/pages/GitIntroductionWithQt If you have already performed the grafting and you don't see any history beyond this commit, try running "git log" with the "--follow" argument. Branched from the monolithic repo, Qt master branch, at commit 896db169ea224deb96c59ce8af800d019de63f12
Diffstat (limited to 'src/script/api/qscriptclasspropertyiterator.cpp')
-rw-r--r--src/script/api/qscriptclasspropertyiterator.cpp204
1 files changed, 204 insertions, 0 deletions
diff --git a/src/script/api/qscriptclasspropertyiterator.cpp b/src/script/api/qscriptclasspropertyiterator.cpp
new file mode 100644
index 0000000..ba70fff
--- /dev/null
+++ b/src/script/api/qscriptclasspropertyiterator.cpp
@@ -0,0 +1,204 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtScript module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL-ONLY$
+** GNU Lesser General Public License Usage
+** 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qscriptclasspropertyiterator.h"
+
+#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()
+{
+}
+
+/*!
+ 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