CGUIStreamWriterXML Class Reference

Writes XML-style streaming files. More...

#include <GUIStreamWriterXML.h>

Inheritance diagram for CGUIStreamWriterXML:

Public Member Functions
virtual const eC_String &	GetFileSuffix () const
eC_Bool	SetFileAlignment (FileAlignment_t eFileAlignment)
eC_Bool	SetFileEndianess (FileEndianess_t eFileEndianess)
virtual void	WriteBinary (const eC_TArray< eC_UByte > &aData, const eC_Char *const pcTag)
virtual void	WriteBool (const eC_Bool bBool, const eC_Char *const pcTag)
virtual void	WriteByte (const eC_Byte bByte, const eC_Char *const pcTag)
virtual void	WriteColor (const ColorValue_t eColor, const eC_Char *const pcTag)
virtual void	WriteCommentTag (const eC_Char *const pcTag)
virtual void	WriteCommentTag (const eC_String &pcTag)
virtual void	WriteFloat (const eC_Float fFloat, const eC_Char *const pcTag)
virtual void	WriteHex (const eC_UInt uiInt, const eC_Char *const pcTag)
virtual void	WriteInt (const eC_Int iInt, const eC_Char *const pcTag)
virtual void	WriteShort (const eC_Short Short, const eC_Char *const pcTag)
virtual void	WriteStreamingFileHeader (const eC_Int iFileVersion)
virtual void	WriteString (const eC_String &rkString, const eC_Char *const pcTag)
virtual void	WriteUByte (const eC_UByte ubByte, const eC_Char *const pcTag)
virtual void	WriteUInt (const eC_UInt uiInt, const eC_Char *const pcTag)
virtual void	WriteUShort (const eC_UShort usShort, const eC_Char *const pcTag)
Public Member Functions inherited from CGUIStreamWriter
virtual	~CGUIStreamWriter ()
	Destructor.
FileAlignment_t	GetFileAlignment () const
FileEndianess_t	GetFileEndianess () const
virtual const eC_String &	GetFileSuffix () const
FileType_t	GetFileType () const
virtual eC_Bool	SetFileAlignment (FileAlignment_t eFileAlignment)=0
virtual eC_Bool	SetFileEndianess (FileEndianess_t eFileEndianess)=0
void	SetStreamingFile (eC_File *pkStreamingFile)
virtual void	WriteAnimationChainID (AnimationHandle_t eID, const eC_Char *const pcTag)
void	WriteAnimationToFile (CGUIAnimation *pkAnimation) const
void	WriteBehaviourToFile (CGUIBehaviourDecorator *pkBehaviour) const
virtual void	WriteBinary (const eC_TArray< eC_UByte > &aData, const eC_Char *const pcTag)=0
virtual void	WriteBool (const eC_Bool bBool, const eC_Char *const pcTag)=0
virtual void	WriteByte (const eC_Byte bByte, const eC_Char *const pcTag)=0
virtual void	WriteColor (const ColorValue_t eColor, const eC_Char *const pcTag)=0
void	WriteCommandToFile (CGUICommandPtr pkCommand) const
virtual void	WriteCommentTag (const eC_Char *const pcTag)=0
virtual void	WriteCommentTag (const eC_String &kTag)=0
virtual void	WriteDataPoolID (DataPoolResource_t eID, const eC_Char *const pcTag)
virtual void	WriteFloat (const eC_Float fFloat, const eC_Char *const pcTag)=0
virtual void	WriteFontID (FontResource_t eID, const eC_Char *const pcTag)
virtual void	WriteGeneralResourceID (GeneralResource_t eID, const eC_Char *const pcTag)
virtual void	WriteHex (const eC_UInt uiInt, const eC_Char *const pcTag)=0
virtual void	WriteImageID (ImageResource_t eID, const eC_Char *const pcTag)
virtual void	WriteInt (const eC_Int iInt, const eC_Char *const pcTag)=0
void	WriteLayouterToFile (CGUILayouter *pkLayouter) const
virtual void	WriteObjectID (ObjectHandle_t eID, const eC_Char *const pcTag)
virtual void	WritePropertyID (GlobalProperty_t eID, const eC_Char *const pcTag)
virtual void	WriteShort (const eC_Short iShort, const eC_Char *const pcTag)=0
virtual void	WriteSoundID (SoundResource_t eID, const eC_Char *const pcTag)
virtual void	WriteStreamingFileHeader (const eC_Int iFileVersion)=0
virtual void	WriteString (const eC_String &pkString, const eC_Char *const pcTag)=0
virtual void	WriteTextID (TextResource_t eID, const eC_Char *const pcTag)
void	WriteTextToFile (CGUIText *pText) const
virtual void	WriteUByte (const eC_UByte ubByte, const eC_Char *const pcTag)=0
virtual void	WriteUInt (const eC_UInt uiInt, const eC_Char *const pcTag)=0
virtual void	WriteUShort (const eC_UShort usShort, const eC_Char *const pcTag)=0

Additional Inherited Members
Static Public Member Functions inherited from CGUIStreamWriter
static void	CreateInstance ()
static void	DeleteInstance ()
static CGUIStreamWriter &	GetInstance ()
Protected Member Functions inherited from CGUIStreamWriter
	CGUIStreamWriter (FileType_t eFileType, FileEndianess_t eFileEndianess, FileAlignment_t eFileAlignment)
Protected Attributes inherited from CGUIStreamWriter
FileAlignment_t	m_eFileAlignment
	Alignment of the file.
FileEndianess_t	m_eFileEndianess
	Endianess of the file.
FileType_t	m_eFileType
	File Type.
eC_File *	m_pkStreamingFile
	The file that the content is written into.

Detailed Description

Writes XML-style streaming files.

This implementation writes human-readable output. It puts the descriptive tags into angle brackets ('<' and '>'). One tag is written before the value, another one with a preceding slash '/' after the value.

Example: the call

WriteInt(17, "SomeInteger");

will result in the following line written:

<SomeInteger>17</SomeInteger>

The WriteString() implementation escapes special characters to XML predefined entities. See StringOperations::EscapeXML() for details.

Member Function Documentation

GetFileSuffix()

virtual const eC_String & CGUIStreamWriterXML::GetFileSuffix ( ) const

inlinevirtual

Returns the file suffix which is associated with this writer's file format. This can be an empty string, if e.g. the writer works with formats which are unrelated to files.

Returns

String with the associated file suffix (e.g. ".xml")

Reimplemented from CGUIStreamWriter.

SetFileAlignment()

eC_Bool CGUIStreamWriterXML::SetFileAlignment ( FileAlignment_t  eFileAlignment )

virtual

Sets the alignment of the streamed file

Parameters

eFileAlignment

the desired alignment

Return values

true	operation successful
false	operation not supported

Implements CGUIStreamWriter.

SetFileEndianess()

eC_Bool CGUIStreamWriterXML::SetFileEndianess ( FileEndianess_t  eFileEndianess )

virtual

Sets the endianess of the streamed file

Parameters

eFileEndianess

the desired endianess

Return values

true	operation successful
false	operation not supported

Implements CGUIStreamWriter.

WriteBinary()

virtual void CGUIStreamWriterXML::WriteBinary ( const eC_TArray< eC_UByte > &  aData, const eC_Char *const  pcTag  )

virtual

Write binary stream. Array will be written to stream in raw mode.

Parameters

aData	Array containing data to post
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteBool()

virtual void CGUIStreamWriterXML::WriteBool ( const eC_Bool  bBool, const eC_Char *const  pcTag  )

virtual

Writes a bool to the streaming file.

Parameters

bBool	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteByte()

virtual void CGUIStreamWriterXML::WriteByte ( const eC_Byte  bByte, const eC_Char *const  pcTag  )

virtual

Writes a byte to the streaming file.

Parameters

bByte	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteColor()

virtual void CGUIStreamWriterXML::WriteColor ( const ColorValue_t  eColor, const eC_Char *const  pcTag  )

virtual

Writes a color as a hex value to the streaming file. Same interface as WriteUInt but writers that produce human-readable output may use this method for hex output.

Parameters

eColor	color-value.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteCommentTag() [1/2]

virtual void CGUIStreamWriterXML::WriteCommentTag ( const eC_Char *const  pcTag )

virtual

Writes a single tag without a value.

Parameters

pcTag

The tag to be written.

Implements CGUIStreamWriter.

WriteCommentTag() [2/2]

virtual void CGUIStreamWriterXML::WriteCommentTag ( const eC_String &  kTag )

virtual

Writes a single tag without a value.

Parameters

kTag	The tag to be written.

Implements CGUIStreamWriter.

WriteFloat()

virtual void CGUIStreamWriterXML::WriteFloat ( const eC_Float  fFloat, const eC_Char *const  pcTag  )

virtual

Writes a float to the set streaming file.

Parameters

fFloat	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteHex()

virtual void CGUIStreamWriterXML::WriteHex ( const eC_UInt  uiInt, const eC_Char *const  pcTag  )

virtual

Writes a hex value to the streaming file. Same interface as WriteInt but writers that produce human-readable output may use this method for hex output.

Parameters

uiInt	unsigned integer value which should be written as hex.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteInt()

virtual void CGUIStreamWriterXML::WriteInt ( const eC_Int  iInt, const eC_Char *const  pcTag  )

virtual

Writes an integer to the streaming file.

Parameters

iInt	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteShort()

virtual void CGUIStreamWriterXML::WriteShort ( const eC_Short  iShort, const eC_Char *const  pcTag  )

virtual

Writes a Short to the streaming file.

Parameters

iShort	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteStreamingFileHeader()

virtual void CGUIStreamWriterXML::WriteStreamingFileHeader ( const eC_Int  iFileVersion )

virtual

Writes the file header

Parameters

iFileVersion

file version

Implements CGUIStreamWriter.

WriteString()

virtual void CGUIStreamWriterXML::WriteString ( const eC_String &  pkString, const eC_Char *const  pcTag  )

virtual

Writes a string to the set streaming file.

Parameters

pkString	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteUByte()

virtual void CGUIStreamWriterXML::WriteUByte ( const eC_UByte  ubByte, const eC_Char *const  pcTag  )

virtual

Writes an unsigned byte to the streaming file.

Parameters

ubByte	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteUInt()

virtual void CGUIStreamWriterXML::WriteUInt ( const eC_UInt  uiInt, const eC_Char *const  pcTag  )

virtual

Writes an unsigned integer to the streaming file.

Parameters

uiInt	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

WriteUShort()

virtual void CGUIStreamWriterXML::WriteUShort ( const eC_UShort  usShort, const eC_Char *const  pcTag  )

virtual

Writes an unsigned short to the streaming file.

Parameters

usShort	Value which should be written.
pcTag	Optional descriptive tag.

Implements CGUIStreamWriter.

---

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

• GUIStreamWriterXML.h