CP_XMLWriter_ElementAttribute Class Reference

This class sets the attributes for a specific CP_XMLWriter_Element to be written out as XML data. More...

List of all members.

Public Member Functions
Constructor / Destructor
	CP_XMLWriter_ElementAttribute ()
	Constructor.
	CP_XMLWriter_ElementAttribute (const CP_String &inAttributeTag)
	CP_XMLWriter_ElementAttribute (const CP_XMLWriter_ElementAttribute &inAttribute)
virtual	~CP_XMLWriter_ElementAttribute ()
	Destructor.
Attributes
CP_String	GetAttributeTag ()
CP_String	GetAttributeData ()
Operators
CP_XMLWriter_ElementAttribute &	operator= (const CP_XMLWriter_ElementAttribute &inAttribute)
Setters
void	SetValue (bool inValue)
void	SetValue (SInt16 inValue)
void	SetValue (UInt16 inValue)
void	SetValue (SInt32 inValue)
void	SetValue (UInt32 inValue)
void	SetValue (const CP_String &inValue)
void	SetValue (char inValue)
void	SetValue (float inValue)
void	SetValue (const CP_RGBColor &inValue)
void	SetValue (const CP_Point &inValue)
void	SetValue (const CP_Size &inValue)
void	SetValue (const CP_Rect &inValue)
void	SetValue (const CP_FileSystemSpec &inValue)
void	SetAttributeTag (const CP_String &inTag)
void	SetAttributeData (const CP_String &inData)
Protected Member Functions
Formatting
virtual CP_String	FormatStringForXML (const CP_String &inOutString)
Protected Attributes
CP_String	fAttributeTag
CP_String	fAttributeData

---

Detailed Description

---

Constructor & Destructor Documentation

CP_XMLWriter_ElementAttribute::CP_XMLWriter_ElementAttribute (   )

Constructor.

CP_XMLWriter_ElementAttribute::CP_XMLWriter_ElementAttribute (  const CP_String &  inAttributeTag  )

Constructor. Parameters: inAttributeTag  - the tag for this attribute. This is how the data for this attribute is referred to.

CP_XMLWriter_ElementAttribute::CP_XMLWriter_ElementAttribute (  const CP_XMLWriter_ElementAttribute &  inAttribute  )

Copy constructor. Parameters: inAttribute  - the attribute we are copying the data for.

CP_XMLWriter_ElementAttribute::~CP_XMLWriter_ElementAttribute (   )  [virtual]

Destructor.

---

Member Function Documentation

CP_String CP_XMLWriter_ElementAttribute::GetAttributeTag (   )

CP_String CP_XMLWriter_ElementAttribute::GetAttributeData (   )

CP_XMLWriter_ElementAttribute & CP_XMLWriter_ElementAttribute::operator= (  const CP_XMLWriter_ElementAttribute &  inAttribute  )

Assignment operator. Parameters: inAttribute  - the attribute that contains the data we are copying.

void CP_XMLWriter_ElementAttribute::SetValue (  bool  inValue  )

Sets the value of this attribute to be a bool. Parameters: inValue  - the bool value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  SInt16  inValue  )

Sets the value of this attribute to be a SInt16. Parameters: inValue  - the SInt16 value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  UInt16  inValue  )

Sets the value of this attribute to be a UInt16. Parameters: inValue  - the UInt16 value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  SInt32  inValue  )

Sets the value of this attribute to be a SInt32. Parameters: inValue  - the SInt32 value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  UInt32  inValue  )

Sets the value of this attribute to be a UInt32. Parameters: inValue  - the UInt32 value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_String &  inValue  )

Sets the value of this attribute to be a CP_String. Parameters: inValue  - the CP_String value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  char  inValue  )

Sets the value of this attribute to be a char. Parameters: inValue  - the char value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  float  inValue  )

Sets the value of this attribute to be a float. Parameters: inValue  - the float value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_RGBColor &  inValue  )

Sets the value of this attribute to be a CP_RGBColor. Parameters: inValue  - the CP_RGBColor value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_Point &  inValue  )

Sets the value of this attribute to be a CP_Point. Parameters: inValue  - the CP_Point value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_Size &  inValue  )

Sets the value of this attribute to be a CP_Size. Parameters: inValue  - the CP_Size value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_Rect &  inValue  )

Sets the value of this attribute to be a CP_Rect. Parameters: inValue  - the CP_Rect value for the attribute.

void CP_XMLWriter_ElementAttribute::SetValue (  const CP_FileSystemSpec &  inValue  )

Sets the value of this attribute to be a CP_FileSystemSpec. Parameters: inValue  - the CP_FileSystemSpec value for the attribute.

void CP_XMLWriter_ElementAttribute::SetAttributeTag (  const CP_String &  inTag  )

void CP_XMLWriter_ElementAttribute::SetAttributeData (  const CP_String &  inData  )

CP_String CP_XMLWriter_ElementAttribute::FormatStringForXML (  const CP_String &  inString  )  [protected, virtual]

Format the passed in string to be a valid string for XML. This will convert all characters above 128 to their hex equivalent, and take care of &, and other characters. Parameters: inString  - the CP_String containing the data to format. returnString = convertedString;

---

Member Data Documentation

CP_String CP_XMLWriter_ElementAttribute::fAttributeTag [protected]

CP_String CP_XMLWriter_ElementAttribute::fAttributeData [protected]

The XML tag for the data. This is the tag that you use to retrieve the data with.

---

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

• CP_XMLWriter_Element.h
• CP_XMLWriter_Element.cpp

---