Guiliani  Version 2.4 revision 5970 (build 3)
CGUISwitchResourceSetsCmd Class Reference

This command can be used to switch to other resource-sets during runtime. More...

#include <GUISwitchResourceSetsCmd.h>

Inheritance diagram for CGUISwitchResourceSetsCmd:

Public Member Functions

 CGUISwitchResourceSetsCmd (const ResourceType_t eResourceType, const eC_String kResourceSetName)
 
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
 
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)
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
void SetXMLTag (const eC_String &kXMLTag)
 
- 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_RESOURCESETNAME [] = "ResourceSetName"
 resource-setname
 
static const eC_Char XMLTAG_RESOURCETYPE [] = "ResourceType"
 resource-type
 
- Static Public Attributes inherited from CGUICommand
static const eC_Char XMLTAG_ADDITIONALCMDCOUNT [] = "AdditionalCmdCount"
 XML tag to be used when writing the additional command count into a stream.
 
static const eC_Char XMLTAG_COMMANDCLASSID [] = "CommandClassID"
 XML tag to be used when writing the command class ID into a stream.
 
static const eC_Char XMLTAG_REMOVE_AFTER_EXECUTION [] = "RemoveAfterExecution"
 XML tag to be used when writing the remove after execution flag.
 
- Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char XMLTAG_CLASSVERSION [] = "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.
 
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
 

Detailed Description

This command can be used to switch to other resource-sets during runtime.

Constructor & Destructor Documentation

◆ CGUISwitchResourceSetsCmd()

CGUISwitchResourceSetsCmd::CGUISwitchResourceSetsCmd ( const ResourceType_t  eResourceType,
const eC_String  kResourceSetName 
)

Constructor

Parameters
eResourceType
kResourceSetName

Member Function Documentation

◆ Do()

void CGUISwitchResourceSetsCmd::Do ( )
protectedvirtual

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

Implements CGUICommand.

◆ ReadFromStream()

void CGUISwitchResourceSetsCmd::ReadFromStream ( )
virtual

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

See also
CGUIObject::ReadFromStream()

Reimplemented from CGUICommand.

◆ WriteToStream()

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

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

Parameters
bWriteClassIDThis 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.


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