CGUICallAPICmd Class Reference

This command can be used to execute specific code inside the application. More...

#include <GUICallAPICmd.h>

Inheritance diagram for CGUICallAPICmd:

Public Member Functions
	CGUICallAPICmd ()
	Default constructor used by streaming factory.
	CGUICallAPICmd (const eC_String &kAPI, const eC_String &kParam)
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

Protected Member Functions
void	Do ()
	Implements the actual command functionality. More...
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
eC_String	m_kAPI
	API which is called.
eC_String	m_kParam
	Parameter which is used.

Additional Inherited Members
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 []

Detailed Description

This command can be used to execute specific code inside the application.

Constructor & Destructor Documentation

CGUICallAPICmd()

CGUICallAPICmd::CGUICallAPICmd	(	const eC_String &	kAPI,
		const eC_String &	kParam
	)

Constructor.

Parameters

kAPI	String which will be forwarded to CMyGUI::CallApplicationAPI to identify which application API to call
kParam	Optional parameter which will be handed over to CMyGUI::CallApplicationAPI as well

Member Function Documentation

Do()

void CGUICallAPICmd::Do ( )

protectedvirtual

Implements the actual command functionality.

Implements CGUICommand.

ReadFromStream()

virtual void CGUICallAPICmd::ReadFromStream ( )

virtual

Reads all attributes from streaming file. This method is called by CGUIFactoryManager after one of the registered factories has created an instance of this class.

Reimplemented from CGUICommand.

WriteToStream()

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

virtual

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

Parameters

bWriteClassID

This flag is used to select if writing of command class ID, leading and trailing tags is performed.

Reimplemented from CGUICommand.

---

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

• GUICallAPICmd.h