Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
CP_SDEFParsing::CP_SDEFParser

CP_SDEFParsing::CP_SDEFParser Class Reference

List of all members.

Public Member Functions

Constructor / Destructor
 CP_SDEFParser ()
 Constructor.
virtual ~CP_SDEFParser () throw ()
 Destructor.
Parsing
void ParseSDEF (SInt16 inSDEFXMLResID)
void ParseSDEF (CP_CFURL &inSdefUrl)
Classes
void AddClassDefinition (CP_ClassDefinition *inClassDefinition)
UInt32 GetNumberClassDefinitions ()
CP_ClassDefinition * GetNthClassDefinition (UInt32 inIndex)
CP_ClassDefinition_Array GetClassDefinitions ()
bool IsClassPropertyDefined (DescType inClassID, DescType inPropertyID)
Commands
void AddCommandDefinition (CP_CommandDefinition *inCommandDefinition)
UInt32 GetNumberCommandDefinitions ()
CP_CommandDefinition * GetNthCommandDefinition (UInt32 inIndex)
CP_CommandDefinition_Array GetCommandDefinitions ()
CP_CommandDefinition * FindCommandByName (const CP_String &inCommandName)

Private Member Functions

Parsing
void ParseNodes (CP_XMLDocNode *inNode)
void ParseClasses (CP_XMLDocNode *inNode)
void ParseClass (CP_XMLDocNode *inNode)
void ParseClassDefinition (CP_XMLDocNode *inNode)
void ParseClassElements (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseClassElement (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseElementAccessor (CP_XMLDocNode *inNode, CP_ElementDefinition *inElementDefinition)
void ParseClassProperties (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseClassProperty (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseClassEvents (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseClassEvent (CP_XMLDocNode *inNode, CP_ClassDefinition *inClassDefinition)
void ParseCommands (CP_XMLDocNode *inNode)
void ParseCommand (CP_XMLDocNode *inNode)

Private Attributes

CP_ClassDefinition_Array fClassDefinitions
CP_CommandDefinition_Array fCommandDefinitions

Constructor & Destructor Documentation

CP_SDEFParsing::CP_SDEFParser::CP_SDEFParser (   ) 
 

Constructor.

Exceptions:
none 

CP_SDEFParsing::CP_SDEFParser::~CP_SDEFParser (   )  throw () [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

void CP_SDEFParsing::CP_SDEFParser::ParseSDEF (  SInt16  inSDEFXMLResID  ) 
 

Parse the SDEF with the passed in XML# resource id.

Parameters:
inSDEFXMLResID Resource id of the sdef XML resource.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseSDEF (  CP_CFURL &  inSdefUrl  ) 
 

Parse the SDEF located in the file from the passed in CP_CFURL.

Parameters:
inCFURL The CP_CFURL to return.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::AddClassDefinition (  CP_ClassDefinition *  inClassDefinition  ) 
 

Adds a class definition to the list of definitions for this object.

Parameters:
inClassDefinition The class definition to add.
Exceptions:
none 
Returns:
void

UInt32 CP_SDEFParsing::CP_SDEFParser::GetNumberClassDefinitions (   ) 
 

Returns the number of class definitions in this object.

Exceptions:
none 
Returns:
UInt32 The number of definitions.

CP_ClassDefinition * CP_SDEFParsing::CP_SDEFParser::GetNthClassDefinition (  UInt32  inIndex  ) 
 

Returns the nth class definitions in this object.

Parameters:
inIndex Index of the definition to return.
Exceptions:
none 
Returns:
CP_ClassDefinition * The class definition being returned.

CP_ClassDefinition_Array CP_SDEFParsing::CP_SDEFParser::GetClassDefinitions (   ) 
 

bool CP_SDEFParsing::CP_SDEFParser::IsClassPropertyDefined (  DescType  inClassID,
DescType  inPropertyID
) 
 

Returns true if the class property is defined.

Parameters:
inClassID ClassID of the property.
inPropertyID PropertyID of the property to return.
Exceptions:
none 
Returns:
bool True if the class property is definied.

void CP_SDEFParsing::CP_SDEFParser::AddCommandDefinition (  CP_CommandDefinition *  inCommandDefinition  ) 
 

Adds a command definition to the list of definitions for this object.

Parameters:
inCommandDefinition The command definition to add.
Exceptions:
none 
Returns:
void

UInt32 CP_SDEFParsing::CP_SDEFParser::GetNumberCommandDefinitions (   ) 
 

Returns the number of command definitions in this object.

Exceptions:
none 
Returns:
UInt32 The number of definitions.

CP_CommandDefinition * CP_SDEFParsing::CP_SDEFParser::GetNthCommandDefinition (  UInt32  inIndex  ) 
 

Returns the nth command definition in this object.

Parameters:
inIndex Index of the definition to return.
Exceptions:
none 
Returns:
CP_CommandDefinition * The command definition being returned.

CP_CommandDefinition_Array CP_SDEFParsing::CP_SDEFParser::GetCommandDefinitions (   ) 
 

CP_CommandDefinition * CP_SDEFParsing::CP_SDEFParser::FindCommandByName (  const CP_String &  inCommandName  ) 
 

Returns a command definition from the passed in command name.

Parameters:
inCommandName The name of the command to return.
Exceptions:
none 
Returns:
CP_CommandDefinition The CP_CommandDefinition being returned.

void CP_SDEFParsing::CP_SDEFParser::ParseNodes (  CP_XMLDocNode *  inNode  )  [private]
 

Parse the nodes in the XML file for SDEF definitions.

Parameters:
inNode The node being parsed.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClasses (  CP_XMLDocNode *  inNode  )  [private]
 

Parse the classes in the XML file for SDEF definitions.

Parameters:
inNode The node being parsed.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClass (  CP_XMLDocNode *  inNode  )  [private]
 

void CP_SDEFParsing::CP_SDEFParser::ParseClassDefinition (  CP_XMLDocNode *  inNode  )  [private]
 

Parse the nodes in the XML file for SDEF class definitions.

Parameters:
inNode The node being parsed.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassElements (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the nodes in the XML file for SDEF class elements.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class elements to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassElement (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the class element node passed in inNode for class definitions.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseElementAccessor (  CP_XMLDocNode *  inNode,
CP_ElementDefinition *  inElementDefinition
)  [private]
 

Parse the class element node passed in inNode for class element accessors.

Parameters:
inNode The node being parsed.
inElementDefinition The element definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassProperties (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the class properties node passed in inNode for class properties.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassProperty (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the class property node passed in inNode for class definitions.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassEvents (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the class definitions node passed in inNode for class events.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseClassEvent (  CP_XMLDocNode *  inNode,
CP_ClassDefinition *  inClassDefinition
)  [private]
 

Parse the class definition node passed in inNode for class events.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class events to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseCommands (  CP_XMLDocNode *  inNode  )  [private]
 

Parse the commands node passed in inNode for commands.

Parameters:
inNode The node being parsed.
inClassDefinition The class definition to add the class definition to.
Exceptions:
none 
Returns:
void

void CP_SDEFParsing::CP_SDEFParser::ParseCommand (  CP_XMLDocNode *  inNode  )  [private]
 

Member Data Documentation

CP_ClassDefinition_Array CP_SDEFParsing::CP_SDEFParser::fClassDefinitions [private]
 

CP_CommandDefinition_Array CP_SDEFParsing::CP_SDEFParser::fCommandDefinitions [private]
 

The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:22:27 2005 for CPLAT_MacOS by  doxygen 1.4.0