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

CP_XMLWriter_ProcessingInstruction Class Reference

XML entry class that represents a processing instruction in an XML file. More...

Inheritance diagram for CP_XMLWriter_ProcessingInstruction:

CP_XMLWriter_Entry CP_M_XMLEntry_Attributes CP_NoCopy CP_NoCopy List of all members.

Public Member Functions

Attributes
void AddAttribute (const CP_XMLWriter_ElementAttribute &inAttribute)
UInt32 GetNumberAttributes ()
CP_XMLWriter_ElementAttribute GetNthAttribute (UInt32 inIndex)
XMLWriter
CP_XMLWriterGetXMLWriter ()
Data and Tags
virtual void SetData (const CP_String &inData)
virtual const CP_String GetData () const
void SetTag (const CP_String &inTag)
Child Elements
void AddChildElement (CP_XMLWriter_Entry *inChildElement)
UInt32 GetElementsDepth ()
UInt32 GetNumberChildElements ()
CP_XMLWriter_EntryGetNthChildElement (UInt32 inIndex)
Testers
bool IsWritten ()
XMLWriter
CP_XMLWriterGetXMLWriter ()
Data and Tags
virtual const CP_String GetData () const
void SetTag (const CP_String &inTag)
Child Elements
void AddChildElement (CP_XMLWriter_Entry *inChildElement)
UInt32 GetElementsDepth ()
UInt32 GetNumberChildElements ()
CP_XMLWriter_EntryGetNthChildElement (UInt32 inIndex)
Testers
bool IsWritten ()
Writing
void Write (CP_XMLWriter *inXMLWriter=NULL)
Attributes
void AddAttribute (const CP_XMLWriter_ElementAttribute &inAttribute)
UInt32 GetNumberAttributes ()
CP_XMLWriter_ElementAttribute GetNthAttribute (UInt32 inIndex)
XMLWriter
CP_XMLWriterGetXMLWriter ()
Data and Tags
virtual void SetData (const CP_String &inData)
virtual const CP_String GetData () const
void SetTag (const CP_String &inTag)
Child Elements
void AddChildElement (CP_XMLWriter_Entry *inChildElement)
UInt32 GetElementsDepth ()
UInt32 GetNumberChildElements ()
CP_XMLWriter_EntryGetNthChildElement (UInt32 inIndex)
Testers
bool IsWritten ()
Constructor / Destructor
 CP_XMLWriter_ProcessingInstruction (CP_XMLWriter *inXMLWriter, CP_XMLWriter_Element *inParentElement, const CP_String &inTag, const CP_String &inData)
 Constructor.
virtual ~CP_XMLWriter_ProcessingInstruction ()
 Destructor.
Writers
virtual void WriteHeader (CP_XMLWriter *inXMLWriter=NULL)
virtual void WriteTrailer (CP_XMLWriter *)
virtual void WriteData (CP_XMLWriter *)
XMLWriter
CP_XMLWriterGetXMLWriter ()
Data and Tags
virtual void SetData (const CP_String &inData)
virtual const CP_String GetData () const
void SetTag (const CP_String &inTag)
Child Elements
void AddChildElement (CP_XMLWriter_Entry *inChildElement)
UInt32 GetElementsDepth ()
UInt32 GetNumberChildElements ()
CP_XMLWriter_EntryGetNthChildElement (UInt32 inIndex)
Testers
bool IsWritten ()
Writing
void Write (CP_XMLWriter *inXMLWriter=NULL)
Attributes
void AddAttribute (const CP_XMLWriter_ElementAttribute &inAttribute)
UInt32 GetNumberAttributes ()
CP_XMLWriter_ElementAttribute GetNthAttribute (UInt32 inIndex)

Protected Member Functions

Attributes
void AddAttributesToHeader (CP_String &inHeader)
Attributes
void AddAttributesToHeader (CP_String &inHeader)
Attributes
void AddAttributesToHeader (CP_String &inHeader)

Protected Attributes

CP_XMLWriterfXMLWriter
CP_XMLWriter_EntryfParentElement
CP_String fTag
CP_String fData
CP_XMLElements_ArrayfElements
bool fIsWritten
CP_XMLAttributes_ArrayfAttributes

Detailed Description


Constructor & Destructor Documentation

CP_XMLWriter_ProcessingInstruction::CP_XMLWriter_ProcessingInstruction CP_XMLWriter inXMLWriter,
CP_XMLWriter_Element inParentElement,
const CP_String inTag,
const CP_String inData
 

Constructor.

Parameters:
inXMLWriter - the CP_XMLWriter object that this element is a part of.
inParentElement - the parent element of this comment.
inTag - the data that the data is referred by.
inData - the data for this element.

CP_XMLWriter_ProcessingInstruction::~CP_XMLWriter_ProcessingInstruction  )  [virtual]
 

Destructor.


Member Function Documentation

void CP_XMLWriter_ProcessingInstruction::WriteHeader CP_XMLWriter inXMLWriter = NULL  )  [virtual]
 

Write the XML header for this processing instruction.

Reimplemented from CP_XMLWriter_Entry.

virtual void CP_XMLWriter_ProcessingInstruction::WriteTrailer CP_XMLWriter  )  [virtual]
 

Reimplemented from CP_XMLWriter_Entry.

virtual void CP_XMLWriter_ProcessingInstruction::WriteData CP_XMLWriter  )  [virtual]
 

Reimplemented from CP_XMLWriter_Entry.

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.

void CP_M_XMLEntry_Attributes::AddAttribute const CP_XMLWriter_ElementAttribute inAttribute  )  [inherited]
 

Add a new attribute to our list of attributes.

Parameters:
inAttribute - the attribute we are adding.

UInt32 CP_M_XMLEntry_Attributes::GetNumberAttributes  )  [inherited]
 

Return the number of attributes for ourselves.

CP_XMLWriter_ElementAttribute CP_M_XMLEntry_Attributes::GetNthAttribute UInt32  inIndex  )  [inherited]
 

Return the attribute at inIndex.

Parameters:
inIndex - the index of the attribute to retrieve.

void CP_M_XMLEntry_Attributes::AddAttributesToHeader CP_String inHeader  )  [protected, inherited]
 

Adds the data for all of our attributes to the passed in string, correctly formatted for output.


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.

CP_XMLAttributes_Array* CP_M_XMLEntry_Attributes::fAttributes [protected, inherited]
 


The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:02:36 2005 for CPLAT by  doxygen 1.4.0