CP_XMLWriter_Comment Class Reference

This class is used with the CP_XMLWriter class to write comments out to the XML file. You supply the comment as a CP_String, and this class will take care of formatting it correctly for output. More...

Inheritance diagram for CP_XMLWriter_Comment:

List of all members.

Writing
void	Write (CP_XMLWriter *inXMLWriter=NULL)
virtual void	WriteTrailer (CP_XMLWriter *)
virtual void	WriteData (CP_XMLWriter *)
Public Member Functions
Constructor / Destructor
	CP_XMLWriter_Comment (CP_XMLWriter *inXMLWriter, CP_XMLWriter_Entry *inParentElement, const CP_String &inComment)
	Constructor.
virtual	~CP_XMLWriter_Comment ()
	Destructor.
Writing
void	WriteHeader (CP_XMLWriter *inXMLWriter=NULL)
Protected Attributes
CP_XMLWriter *	fXMLWriter
CP_XMLWriter_Entry *	fParentElement
CP_String	fTag
CP_String	fData
CP_XMLElements_Array *	fElements
bool	fIsWritten
Private Member Functions
Constructor / Destructor
	CP_XMLWriter_Comment (const CP_XMLWriter_Comment &inWriter)
	Constructor.
operators
CP_XMLWriter_Comment &	operator= (const CP_XMLWriter_Comment &inXMLWriter)

---

Detailed Description

---

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_XMLWriter_Comment::CP_XMLWriter_Comment (  CP_XMLWriter *  inXMLWriter, CP_XMLWriter_Entry *  inParentElement, const CP_String &  inComment )

Constructor. Parameters: inXMLWriter  The CP_XMLWriter object that this element is a part of. inParentElement  The parent element of this comment. inComment  The contents of the comment. Exceptions: none

CP_XMLWriter_Comment::~CP_XMLWriter_Comment (   )  [virtual]

Destructor. Exceptions: none

CP_XMLWriter_Comment::CP_XMLWriter_Comment (  const CP_XMLWriter_Comment &  inWriter  )  [private]

---

Member Function Documentation

void CP_XMLWriter_Comment::WriteHeader (  CP_XMLWriter *  inXMLWriter = NULL  )  [virtual]

Write the header for this element. This will take care of writing the comments data out in proper format for the XML document. Parameters: inXMLWriter  The CP_XMLWriter object that this element is a part of. Exceptions: none  Returns: void Reimplemented from CP_XMLWriter_Entry.

CP_XMLWriter_Comment& CP_XMLWriter_Comment::operator= (  const CP_XMLWriter_Comment &  inXMLWriter  )  [private]

CP_XMLWriter* CP_XMLWriter_Entry::GetXMLWriter (   )  [inherited]

virtual void CP_XMLWriter_Entry::SetData (  const CP_String &  inData  )  [virtual, inherited]

Reimplemented in CP_XMLWriter_Element.

virtual const CP_String CP_XMLWriter_Entry::GetData (   )  const [virtual, inherited]

void CP_XMLWriter_Entry::SetTag (  const CP_String &  inTag  )  [inherited]

void CP_XMLWriter_Entry::AddChildElement (  CP_XMLWriter_Entry *  inChildElement  )  [inherited]

Add a new child element to ourselves. Parameters: inChildElement  - the element to add.

UInt32 CP_XMLWriter_Entry::GetElementsDepth (   )  [inherited]

Return the depth (from the root item) of our element. This information is used to figure out how much to indent our element in listings.

UInt32 CP_XMLWriter_Entry::GetNumberChildElements (   )  [inherited]

Return the number of child elements for ourselves.

CP_XMLWriter_Entry * CP_XMLWriter_Entry::GetNthChildElement (  UInt32  inIndex  )  [inherited]

Return the child element at inIndex. Parameters: inIndex  - the index of the item to return.

bool CP_XMLWriter_Entry::IsWritten (   )  [inherited]

void CP_XMLWriter_Entry::Write (  CP_XMLWriter *  inXMLWriter = NULL  )  [inherited]

Write the data for this element out.

virtual void CP_XMLWriter_Entry::WriteTrailer (  CP_XMLWriter *   )  [virtual, inherited]

Reimplemented in CP_XMLWriter_Element, and CP_XMLWriter_ProcessingInstruction.

virtual void CP_XMLWriter_Entry::WriteData (  CP_XMLWriter *   )  [virtual, inherited]

Reimplemented in CP_XMLWriter_Element, and CP_XMLWriter_ProcessingInstruction.

---

Member Data Documentation

CP_XMLWriter* CP_XMLWriter_Entry::fXMLWriter [protected, inherited]

CP_XMLWriter_Entry* CP_XMLWriter_Entry::fParentElement [protected, inherited]

The XMLWriter that we are going to write the data to.

CP_String CP_XMLWriter_Entry::fTag [protected, inherited]

The parent element that this entry goes with.

CP_String CP_XMLWriter_Entry::fData [protected, inherited]

The tag for this entry.

CP_XMLElements_Array* CP_XMLWriter_Entry::fElements [protected, inherited]

The actual data for the entry.

bool CP_XMLWriter_Entry::fIsWritten [protected, inherited]

A list of child elements for this entry.

---

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

• CP_XMLWriter_Comment.h
• CP_XMLWriter_Comment.cpp

---