---

skiExecutable Class Reference

This class gives an interface for the Interpreter to call into. More...

#include <skiExecutable.h>

Inheritance diagram for skiExecutable:

List of all members.

Public Member Functions
virtual	~skiExecutable ()
	Destructor.
virtual int	executableType () const=0
	this method returns the type of the object.
virtual int	intValue () const=0
	returns an integer equivalent of this object
virtual bool	boolValue () const=0
	returns a boolean equivalent of this object
virtual Char	charValue () const=0
	returns a character equivalent of this object
virtual skString	strValue () const=0
	returns a String equivalent of this object
virtual float	floatValue () const=0
	returns a float equivalent of this object
virtual bool	setValue (const skString &field_name, const skString &attribute, const skRValue &value)=0
	requests the object to set a field to the given value
virtual bool	setValueAt (const skRValue &array_index, const skString &attribute, const skRValue &value)=0
	requests the object to set an item in its collection to a certain value
virtual bool	getValue (const skString &field_name, const skString &attribute, skRValue &value)=0
	requests the object to return a field's value
virtual bool	getValueAt (const skRValue &array_index, const skString &attribute, skRValue &value)=0
	requests the object to return an object from its collection
virtual bool	method (const skString &method_name, skRValueArray &arguments, skRValue &return_value, skExecutableContext &context)=0
	Requests that the object execute the given method.
virtual bool	equals (const skiExecutable *other_object) const=0
	This method compares this object with another object.
virtual skExecutableIterator *	createIterator (const skString &qualifier)=0
	This method returns an executable iterator used in foreach statements.
virtual skExecutableIterator *	createIterator ()=0
	This method returns an executable iterator used in foreach statements.
virtual skString	getSource (const skString &location)=0
	This method returns the source for a scripted method described by the location.
virtual void	getInstanceVariables (skRValueTable &table)=0
	This method returns the instance variables for this object.
virtual void	getAttributes (skRValueTable &table)=0
	This method returns the attributes for this object.

---

Detailed Description

This class gives an interface for the Interpreter to call into.

All its methods are pure virtuals so that it can be used in as many different class hierarchies as possible.

---

Member Function Documentation

virtual skExecutableIterator* skiExecutable::createIterator (   )  [pure virtual]

This method returns an executable iterator used in foreach statements. Returns: an skExecutableIterator object that can be used to iterate over the components of this container Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual skExecutableIterator* skiExecutable::createIterator (  const skString &  qualifier  )  [pure virtual]

This method returns an executable iterator used in foreach statements. Parameters: qualifier  a value to qualify the iteration by Returns: an skExecutableIterator object that can be used to iterate over the result of the qualifier Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual int skiExecutable::executableType (   )  const [pure virtual]

this method returns the type of the object. Define your own value if you want to check the type of your object at run-time Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual void skiExecutable::getAttributes (  skRValueTable &  table  )  [pure virtual]

This method returns the attributes for this object. Parameters: table  a table to filled with the values of the attributes Implemented in skElementObject, skExecutable, skMSXMLElementObject, and skXMLElementObject.

virtual void skiExecutable::getInstanceVariables (  skRValueTable &  table  )  [pure virtual]

This method returns the instance variables for this object. Parameters: table  a table to filled with references to the instance variables Implemented in skElementObject, skExecutable, skInterpreter, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual skString skiExecutable::getSource (  const skString &  location  )  [pure virtual]

This method returns the source for a scripted method described by the location. Parameters: location  the location of the method - in the format passed to the execute functions in the Interpreter Returns: the source for the method Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual bool skiExecutable::getValue (  const skString &  field_name, const skString &  attribute, skRValue &  value )  [pure virtual]

requests the object to return a field's value Parameters: field_name  - the name of the field name to get attribute  - the attribute name to get (may be blank) value  - the value to receive the value of the field Returns: true if the field was changed, false if the field could not be get or found Implemented in skElementObject, skExecutable, skInterpreter, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual bool skiExecutable::getValueAt (  const skRValue &  array_index, const skString &  attribute, skRValue &  value )  [pure virtual]

requests the object to return an object from its collection Parameters: array_index  - the identifier of the item - this might be a string, integer or any other legal value attribute  - the attribute name to get (may be blank) value  - the value to receive the value of the field Returns: true if the field was changed, false if the field could not be get or found Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual bool skiExecutable::method (  const skString &  method_name, skRValueArray &  arguments, skRValue &  return_value, skExecutableContext &  context )  [pure virtual]

Requests that the object execute the given method. Parameters: method_name  - the name of the method to execute arguments  - an array of RValue objects, which are the arguments to the method return_value  - an object to receive the return value of the method context  context object to receive errors Returns: true if the method could be executed, or false if the method is not supported Exceptions: skParseException  - if a syntax error is encountered while the script is running skRuntimeException  - if an error occurs while the script is running skParseException  - if a syntax error is encountered while the script is running skRuntimeException  - if an error occurs while the script is running Implemented in skElementObject, skElementObjectEnumerator, skExecutable, skInterpreter, skMSXMLElementObject, skMSXMLElementObjectEnumerator, skTreeNodeObject, skTreeNodeObjectEnumerator, skXMLElementObject, and skXMLElementObjectEnumerator.

virtual bool skiExecutable::setValue (  const skString &  field_name, const skString &  attribute, const skRValue &  value )  [pure virtual]

requests the object to set a field to the given value Parameters: field_name  - the name of the field name to set attribute  - the attribute name to set (may be blank) value  - the value to be set Returns: true if the field was changed, false if the field could not be set or found Implemented in skElementObject, skExecutable, skInterpreter, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

virtual bool skiExecutable::setValueAt (  const skRValue &  array_index, const skString &  attribute, const skRValue &  value )  [pure virtual]

requests the object to set an item in its collection to a certain value Parameters: array_index  - the identifier of the item - this might be a string, integer or any other legal value attribute  - the attribute name to set (may be blank) value  - the value to be set Returns: true if the field was changed, false if the field could not be set or found Implemented in skElementObject, skExecutable, skMSXMLElementObject, skTreeNodeObject, and skXMLElementObject.

---

The documentation for this class was generated from the following file:

• skiExecutable.h

---