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

skMSXMLElementObjectEnumerator Class Reference

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

#include <skMSXMLElementObjectEnumerator.h>

Inheritance diagram for skMSXMLElementObjectEnumerator:

skExecutable skExecutableIterator skiExecutable List of all members.

Public Member Functions

 skMSXMLElementObjectEnumerator (XMLElement &element, bool add_if_not_present, const skString &location)
 Construct an enumerator for the given XML element.

 skMSXMLElementObjectEnumerator (XMLElement &element, bool add_if_not_present, const skString &location, const skString &tag)
 This contructs an skMSXMLElementObject enumerator over children with a particular tag name.

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 enumeration to the start.

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

Detailed Description

This class enumerates the element children of an skMSXMLElementObject.

Constructor & Destructor Documentation

skMSXMLElementObjectEnumerator::skMSXMLElementObjectEnumerator (  XMLElement &  element,
bool  add_if_not_present,
const skString &  location
) 
 

Construct an enumerator for the given XML element.

Parameters:
element - the element to enumerate the children of
add_if_not_present - value of the flag to be passed when skMSXMLElementObject's are created
location - the owning XML element name

skMSXMLElementObjectEnumerator::skMSXMLElementObjectEnumerator (  XMLElement &  element,
bool  add_if_not_present,
const skString &  location,
const skString &  tag
) 
 

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

Parameters:
element - the element to enumerate the children of
add_if_not_present - value of the flag to be passed when skMSXMLElementObject's are created
location - the owning XML element name
tag - the tag name to look for

Member Function Documentation

bool skMSXMLElementObjectEnumerator::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 enumeration to the start.

Parameters:
s method name
args arguments to the function
r return value
ctxt context object to receive errors
Exceptions:
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.

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