Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtScript.QScriptClassPropertyIterator Class Referenceabstract

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 ()
 
abstract void Next ()
  More...
 
abstract void Previous ()
  More...
 
abstract void ToBack ()
  More...
 
abstract void ToFront ()
  More...
 
new void Dispose ()
 

Protected Member Functions

 QScriptClassPropertyIterator (System.Type dummy)
 
 QScriptClassPropertyIterator (QScriptValue @object)
  More...
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

virtual QScriptValue.PropertyFlag Flags [get]
  More...
 
virtual bool HasNext [get]
  More...
 
virtual bool HasPrevious [get]
  More...
 
virtual uint Id [get]
  More...
 
virtual QScriptString Name [get]
  More...
 
QScriptValue Object [get]
  More...
 
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).

Here is the call graph for this function:

Member Function Documentation

virtual void QtScript.QScriptClassPropertyIterator.CreateProxy ( )
virtual

Here is the caller graph for this function:

new void QtScript.QScriptClassPropertyIterator.Dispose ( )
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().

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 QScriptValue.PropertyFlag QtScript.QScriptClassPropertyIterator.Flags
get

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

virtual bool QtScript.QScriptClassPropertyIterator.HasNext
get

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

virtual bool QtScript.QScriptClassPropertyIterator.HasPrevious
get

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
get

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

The default implementation returns 0.

See also name().

virtual QScriptString QtScript.QScriptClassPropertyIterator.Name
get

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

See also id().

QScriptValue QtScript.QScriptClassPropertyIterator.Object
get

Returns the Qt Script object this iterator is traversing.

virtual System.IntPtr QtScript.QScriptClassPropertyIterator.SmokeObject
getset