summaryrefslogtreecommitdiffstats
path: root/src/script/api/qscriptclasspropertyiterator.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/script/api/qscriptclasspropertyiterator.cpp')
-rw-r--r--src/script/api/qscriptclasspropertyiterator.cpp198
1 files changed, 198 insertions, 0 deletions
diff --git a/src/script/api/qscriptclasspropertyiterator.cpp b/src/script/api/qscriptclasspropertyiterator.cpp
new file mode 100644
index 0000000..a0ce34d
--- /dev/null
+++ b/src/script/api/qscriptclasspropertyiterator.cpp
@@ -0,0 +1,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