CGUILoadDialogCmd Class Reference

Loads a GUI definition from a file. More...

#include <GUILoadDialogCmd.h>

Inheritance diagram for CGUILoadDialogCmd:

Public Member Functions
	CGUILoadDialogCmd ()
	Constructor for factory. Do not use this constructor in user code.
	CGUILoadDialogCmd (const eC_String &rkFileName, ObjectHandle_t eParent=NO_HANDLE, ObjectHandle_t eDelete=NO_HANDLE)
	Constructs a LoadDialogCmd. More...
virtual void	ReadFromStream ()
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUICommand
void	AddAdditionalCmd (CGUICommandPtr pkCmd, eC_Bool bOneTime=false)
CGUICommandPtr	GetAdditionalCmd (const eC_UInt &uiIndex) const
eC_UInt	GetNumberOfAdditionalCmds () const
eC_UInt	GetPriority () const
eC_UInt	GetTimeUntilNextExecution () const
eC_Bool	IsFinished () const
virtual void	ReadFromStream ()
void	RemoveAdditionalCmd (CGUICommandPtr pkCmd)
void	RemoveAllAdditionalCmds ()
	Removes all additional commands from this command's list.
void	SetPriority (eC_UInt uiPriority)
void	SetTimeUntilNextExecution (eC_UInt uiTime)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const
virtual void	ReadFromStream ()
void	SetXMLTag (const eC_String &kXMLTag)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from NSmartPtr::RefCounted
	RefCounted ()
	Create RefCounted object. The reference count is initialized to 0.
virtual	~RefCounted ()
	Destroy reference counted object.
void	AddRef ()
	Increase reference count.
eC_Int	RefCount () const
void	Release ()
bool	Unique () const

Static Public Attributes
static const eC_Char	XMLTAG_DESTDIALOGFILENAME []
Static Public Attributes inherited from CGUICommand
static const eC_Char	XMLTAG_ADDITIONALCMDCOUNT []
	XML tag to be used when writing the additional command count into a stream.
static const eC_Char	XMLTAG_COMMANDCLASSID []
	XML tag to be used when writing the command class ID into a stream.
static const eC_Char	XMLTAG_REMOVE_AFTER_EXECUTION []
	XML tag to be used when writing the remove after execution flag.
Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Protected Member Functions
virtual void	Do ()
Protected Member Functions inherited from CGUICommand
	CGUICommand (const eC_UInt uiPriority=0, const eC_UInt uiTimeUntilFirstExecution=0, const eC_Bool bFinished=true)
virtual	~CGUICommand ()
	Destructor.
virtual void	Do ()=0
void	SetToBeFinished (eC_Bool bIsFinished)
Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const
void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const
void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Protected Attributes
ObjectHandle_t	m_eDelete
	ID of object to be deleted.
ObjectHandle_t	m_eParent
	ID of the designated parent object of the new dialog.
eC_String	m_kFileName
	File name of the dialog to be loaded.
CGUIObject *	m_pkLoadedDialog
	temporary pointer which is set when the dialog is loaded. Use carefully.

Additional Inherited Members
Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t	GenerateUUID ()

Detailed Description

Loads a GUI definition from a file.

This command loads a GUI definition which results in a new CGUIObject. This object is then attached to a specific parent object or the GUI root object.

This command may also delete an object with a specific ID.

If the given file name is an empty string, this command does not try to load a GUI definition but deletes the specified object anyway.

If something goes wrong while streaming (loading the GUI definition), this command does not delete any GUI objects.

Constructor & Destructor Documentation

CGUILoadDialogCmd()

CGUILoadDialogCmd::CGUILoadDialogCmd	(	const eC_String &	rkFileName,
		ObjectHandle_t	eParent = NO_HANDLE,
		ObjectHandle_t	eDelete = NO_HANDLE
	)

Constructs a LoadDialogCmd.

Parameters

rkFileName	File name of the dialog to be loaded.
eParent	Object ID of the designated parent of the loaded dialog. If NO_HANDLE is passed here or no object with this ID is found when this command is executed, the GUI root object is used as the parent. If the object is found but is no composite object, its parent is used as the new dialog's parent instead.
eDelete	ID of an object to be deleted when this command is executed. If NO_HANDLE is passed or no object with this ID is found, nothing gets deleted.

Member Function Documentation

Do()

virtual void CGUILoadDialogCmd::Do ( )

protectedvirtual

Action of the command object. Must be implemented in the derived class.

Implements CGUICommand.

ReadFromStream()

virtual void CGUILoadDialogCmd::ReadFromStream ( )

virtual

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also

CGUIObject::ReadFromStream()

Reimplemented from CGUICommand.

WriteToStream()

virtual void CGUILoadDialogCmd::WriteToStream ( const eC_Bool  bWriteClassID = false )

virtual

Writes attributes to the streaming file. A CGUIStreamWriter has to be initialized.

Parameters

bWriteClassID

This flag is used to switch writing of the class ID, leading and trailing tags. When implementing a new streamable object, check this flag. If it is true, first write the class ID, then continue with this object's attributes, and finally call the base class implementation with this flag set to false (this is the default).

Reimplemented from CGUICommand.

Member Data Documentation

XMLTAG_DESTDIALOGFILENAME

const eC_Char CGUILoadDialogCmd::XMLTAG_DESTDIALOGFILENAME[]

static

XML tag used to indicate a target dialog filename to load.

---

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

• GUILoadDialogCmd.h