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

skElementObjectEnumerator Class Reference

This class enumerates the element children of an skElementObject. More...

#include <skElementObjectEnumerator.h>

Inheritance diagram for skElementObjectEnumerator:

skExecutable skExecutableIterator skiExecutable List of all members.

Public Member Functions

 skElementObjectEnumerator (skElementObject *element, const skString &location)
 This contructs an skElementObject enumerator over all the children.

 skElementObjectEnumerator (skElementObject *element, const skString &location, const skString &tag)
 This contructs an skElementObject enumerator over children with a particular tag name.

virtual ~skElementObjectEnumerator ()
 Destructor.

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

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

Detailed Description

This class enumerates the element children of an skElementObject.

Constructor & Destructor Documentation

skElementObjectEnumerator::skElementObjectEnumerator (  skElementObject *  element,
const skString &  location
) 
 

This contructs an skElementObject enumerator over all the children.

Parameters:
element - the element to enumerate the children of
location - the owning XML element name

skElementObjectEnumerator::skElementObjectEnumerator (  skElementObject *  element,
const skString &  location,
const skString &  tag
) 
 

This contructs an skElementObject enumerator over children with a particular tag name.

Parameters:
element - the element to enumerate the children of
location - the owning XML element name
tag - the tag name to look for

Member Function Documentation

bool skElementObjectEnumerator::method (  const skString &  s,
skRValueArray &  args,
skRValue &  r,
skExecutableContext &  ctxt
)  [virtual]
 

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

Parameters:
s method name
args arguments to the function
r return value
ctxt context object to receive errors
Exceptions:
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 skElementObjectEnumerator::next (  skRValue &   )  [virtual]
 

This method implements the method in skExecutableIterator.

Exceptions:
Symbian - a leaving function

Implements skExecutableIterator.

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