CP_DocNodeDecoders.h File Reference

Defines
#define	CP_RegisterXMLDecoder(inClassName, inDecoderFunction)   CP_DocNodeDecordersManager::Instance()->RegisterDecoder( inClassName, inDecoderFunction )
Typedefs
typedef std::map< CP_String, DecodeCallback, std::less< CP_String > >	CP_Decoders_Map
typedef std::map< CP_String, DecodeCallback, std::less< CP_String > >::iterator	CP_Decoders_Iterator
typedef std::pair< const CP_String, DecodeCallback >	CP_Decoders_Entry
Functions
CP_DataValueHolder	XMLDecoder_CPRect (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_CPPoint (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_CPRGBColor (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_CPSize (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_CPString (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_Bool (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_SInt16 (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_UInt16 (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_SInt32 (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_UInt32 (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_OSType (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_Float (CP_XMLDocNode *inXMLDocNode)
CP_DataValueHolder	XMLDecoder_TabItems (CP_XMLDocNode *inXMLDocNode)
CP_TabInfo	XMLDecoder_TabInfo (CP_XMLDocNode *inTabInfoNode)
CP_DataValueHolder	XMLDecoder_CPMenu (CP_XMLDocNode *inXMLDocNode)
void	XMLDecoder_CPMenuItems_private (CP_XMLDocNode *inXMLDocNode, CP_Menu *inMenu)
Variables
CPLAT_Begin_Namespace_CPLAT typedef CP_DataValueHolder(*	DecodeCallback )(CP_XMLDocNode *inXMLDocNode)

---

Define Documentation

#define CP_RegisterXMLDecoder (  inClassName, inDecoderFunction   )     CP_DocNodeDecordersManager::Instance()->RegisterDecoder( inClassName, inDecoderFunction )

---

Typedef Documentation

typedef std::map<CP_String, DecodeCallback, std::less<CP_String> > CP_Decoders_Map

typedef std::map<CP_String, DecodeCallback, std::less<CP_String> >::iterator CP_Decoders_Iterator

typedef std::pair<const CP_String, DecodeCallback> CP_Decoders_Entry

---

Function Documentation

CP_DataValueHolder XMLDecoder_CPRect (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_Rect object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_Size.

CP_DataValueHolder XMLDecoder_CPPoint (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_Point object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_Point.

CP_DataValueHolder XMLDecoder_CPRGBColor (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_Rect object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_RGBColor.

CP_DataValueHolder XMLDecoder_CPSize (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_Size object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_Size.

CP_DataValueHolder XMLDecoder_CPString (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_String object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_String.

CP_DataValueHolder XMLDecoder_Bool (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a bool object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded bool.

CP_DataValueHolder XMLDecoder_SInt16 (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a SInt16 object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded SInt16.

CP_DataValueHolder XMLDecoder_UInt16 (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a UInt16 object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded UInt16.

CP_DataValueHolder XMLDecoder_SInt32 (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a SInt32 object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded SInt32.

CP_DataValueHolder XMLDecoder_UInt32 (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a UInt32 object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded UInt32.

CP_DataValueHolder XMLDecoder_OSType (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a UInt32 object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded UInt32.

CP_DataValueHolder XMLDecoder_Float (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a Float object. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded Float.

CP_DataValueHolder XMLDecoder_TabItems (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a group of tab items, each of which contains a single tab info structure to describe a single tab. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: OSError  exceptions. Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded UInt32.

CP_TabInfo XMLDecoder_TabInfo (  CP_XMLDocNode *  inTabInfoNode  )

Decoder for a single tab info object which describes the appearance of a single tab. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: none  Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded UInt32.

CP_DataValueHolder XMLDecoder_CPMenu (  CP_XMLDocNode *  inXMLDocNode  )

Decoder for a CP_Menu object. This will read in and create a CP_Menu object, and the items for the menu. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: NULL  exceptions. Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_Size.

void XMLDecoder_CPMenuItems_private (  CP_XMLDocNode *  inXMLDocNode, CP_Menu *  inMenu )

Private helper method used to decode a single menu item and is called from the XMLDecoder_CPMenu method above to decode a single menu item entry in the menu. Parameters: inXMLDocNode  The XML document node that contains the data to be decoded. Exceptions: NULL  exceptions. Returns: CP_DataValueHolder A CP_DataValueHolder that contains the decoded CP_Size.

---

Variable Documentation

CPLAT_Begin_Namespace_CPLAT typedef CP_DataValueHolder(* DecodeCallback)(CP_XMLDocNode *inXMLDocNode)

Callback typedef to Decode a CP_M_Persist object..

---