QScriptClassPropertyIterator Class

The QScriptClassPropertyIterator class provides an iterator interface for custom Qt Script objects. More...

Header: #include <QScriptClassPropertyIterator>
qmake: QT += script
Since: Qt 4.4

Public Functions

virtual ~QScriptClassPropertyIterator()
virtual QScriptValue::PropertyFlags flags() const
virtual bool hasNext() const = 0
virtual bool hasPrevious() const = 0
virtual uint id() const
virtual QScriptString name() const = 0
virtual void next() = 0
QScriptValue object() const
virtual void previous() = 0
virtual void toBack() = 0
virtual void toFront() = 0

Protected Functions

QScriptClassPropertyIterator(const QScriptValue &object)

Protected Variables

QScopedPointer<QScriptClassPropertyIteratorPrivate> d_ptr

Detailed Description

The QScriptClassPropertyIterator class provides an iterator interface for custom Qt Script objects.

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().

See also QScriptClass::newIterator() and QScriptValueIterator.

Member Function Documentation

[protected] QScriptClassPropertyIterator::QScriptClassPropertyIterator(const QScriptValue &object)

Constructs an iterator for traversing object.

Subclasses should ensure that the iterator is set to the front of the sequence of properties (before the first property).

[virtual] QScriptClassPropertyIterator::~QScriptClassPropertyIterator()

Destroys the iterator.

[virtual] QScriptValue::PropertyFlags QScriptClassPropertyIterator::flags() const

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().

[pure virtual] bool QScriptClassPropertyIterator::hasNext() const

[pure virtual] bool QScriptClassPropertyIterator::hasPrevious() const

[virtual] uint QScriptClassPropertyIterator::id() const

[pure virtual] QScriptString QScriptClassPropertyIterator::name() const

[pure virtual] void QScriptClassPropertyIterator::next()

QScriptValue QScriptClassPropertyIterator::object() const

Returns the Qt Script object this iterator is traversing.

[pure virtual] void QScriptClassPropertyIterator::previous()

[pure virtual] void QScriptClassPropertyIterator::toBack()

[pure virtual] void QScriptClassPropertyIterator::toFront()