QtScript.QScriptClassPropertyIterator Class Reference

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

Inheritance diagram for QtScript.QScriptClassPropertyIterator:

Collaboration diagram for QtScript.QScriptClassPropertyIterator:

Public Member Functions
virtual void	CreateProxy ()
virtual QScriptValue.PropertyFlag	Flags ()
abstract bool	HasNext ()
abstract bool	HasPrevious ()
virtual uint	Id ()
abstract QScriptString	Name ()
abstract void	Next ()
new QScriptValue	Object ()
abstract void	Previous ()
abstract void	ToBack ()
abstract void	ToFront ()
new void	Dispose ()

Protected Member Functions
	QScriptClassPropertyIterator (System.Type dummy)
	QScriptClassPropertyIterator (QScriptValue @object)

Protected Attributes
SmokeInvocation	interceptor

Properties
virtual System.IntPtr	SmokeObject [get, set]

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.

Constructor & Destructor Documentation

QtScript.QScriptClassPropertyIterator.QScriptClassPropertyIterator ( System.Type  dummy )

protected

QtScript.QScriptClassPropertyIterator.QScriptClassPropertyIterator ( QScriptValue @  object )

protected

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

Member Function Documentation

virtual void QtScript.QScriptClassPropertyIterator.CreateProxy ( )

virtual

new void QtScript.QScriptClassPropertyIterator.Dispose

(

)

virtual QScriptValue.PropertyFlag QtScript.QScriptClassPropertyIterator.Flags ( )

virtual

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

abstract bool QtScript.QScriptClassPropertyIterator.HasNext ( )

pure virtual

Returns true if there is at least one item ahead of the iterator (i.e. the iterator is not at the back of the property sequence); otherwise returns false.

See also next() and hasPrevious().

abstract bool QtScript.QScriptClassPropertyIterator.HasPrevious ( )

pure virtual

Returns true if there is at least one item behind the iterator (i.e. the iterator is not at the front of the property sequence); otherwise returns false.

See also previous() and hasNext().

virtual uint QtScript.QScriptClassPropertyIterator.Id ( )

virtual

Returns the id of the last property that was jumped over using next() or previous().

The default implementation returns 0.

See also name().

abstract QScriptString QtScript.QScriptClassPropertyIterator.Name ( )

pure virtual

Returns the name of the last property that was jumped over using next() or previous().

See also id().

abstract void QtScript.QScriptClassPropertyIterator.Next ( )

pure virtual

Advances the iterator by one position.

Calling this function on an iterator located at the back of the container leads to undefined results.

See also hasNext(), previous(), and name().

new QScriptValue QtScript.QScriptClassPropertyIterator.Object

(

)

Returns the Qt Script object this iterator is traversing.

abstract void QtScript.QScriptClassPropertyIterator.Previous ( )

pure virtual

Moves the iterator back by one position.

Calling this function on an iterator located at the front of the container leads to undefined results.

See also hasPrevious(), next(), and name().

abstract void QtScript.QScriptClassPropertyIterator.ToBack ( )

pure virtual

Moves the iterator to the back of the QScriptValue (after the last property).

See also toFront() and previous().

abstract void QtScript.QScriptClassPropertyIterator.ToFront ( )

pure virtual

Moves the iterator to the front of the QScriptValue (before the first property).

See also toBack() and next().

Member Data Documentation

SmokeInvocation QtScript.QScriptClassPropertyIterator.interceptor

protected

Property Documentation

virtual System.IntPtr QtScript.QScriptClassPropertyIterator.SmokeObject

getset