Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skTreeNodeObjectEnumerator Class Reference

This class enumerates the elements in an TreeNodeObject. More...

#include <skTreeNodeObjectEnumerator.h>

Inheritance diagram for skTreeNodeObjectEnumerator:

skExecutable skExecutableIterator skiExecutable List of all members.

Public Member Functions

 skTreeNodeObjectEnumerator (skTreeNodeObject *obj, const skString &location)
 This constructor is for an enumerator that gives *all* the child elements of this element.

 skTreeNodeObjectEnumerator (skTreeNodeObject *obj, const skString &location, const skString &tag)
 This constructor is for an enumerator that gives the child elements of this element whose tag name matches that given.

virtual ~skTreeNodeObjectEnumerator ()
 Destructor.

virtual bool method (const skString &s, skRValueArray &args, skRValue &r, skExecutableContext &ctxt)
 This method exposes the following methods to Simkin scripts: "next" - returns the next object in the enumeration - or null if there are no more "reset" - resets the enumeration to the start.

virtual bool next (skRValue &)
 This method implements the method in skExecutableIterator.


Detailed Description

This class enumerates the elements in an TreeNodeObject.


Member Function Documentation

bool skTreeNodeObjectEnumerator::method const skString s,
skRValueArray args,
skRValue r,
skExecutableContext ctxt
[virtual]
 

This method exposes the following methods to Simkin scripts: "next" - returns the next object in the enumeration - or null if there are no more "reset" - resets the enumeration to the start.

Parameters:
s method name
args arguments to the function
r return value
ctxt context object to receive errors
Exceptions:
a Symbian - a leaving function
skParseException - if a syntax error is encountered while the script is running
skRuntimeException - if an error occurs while the script is running

Reimplemented from skExecutable.

bool skTreeNodeObjectEnumerator::next skRValue  )  [virtual]
 

This method implements the method in skExecutableIterator.

Exceptions:
a Symbian - a leaving function

Implements skExecutableIterator.


The documentation for this class was generated from the following files:
Generated on Fri Dec 17 20:27:36 2004 for Simkin by doxygen1.3