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

An example for a custom command that changes the object states of an GUIObject. More...

#include <GUISetObjectStateCmd.h>

Inheritance diagram for CGUISetObjectStateCmd:

Public Member Functions

 CGUISetObjectStateCmd (ObjectHandle_t eTargetObject, eC_Bool bToggle, eC_Bool bFocusable, eC_Bool bInvisible, eC_Bool bGrayedOut, eC_Bool bDisabled)
 
 CGUISetObjectStateCmd ()
 Default constructor to be used by a factory.
 
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
 

Protected Member Functions

void Do ()
 Implements the actual command functionality.
 
- 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
 

Protected Attributes

eC_Bool m_bDisabled
 Changeable state: Disabled.
 
eC_Bool m_bFocussable
 Changeable state: focusable.
 
eC_Bool m_bGrayedOut
 Changeable state: Grayed out.
 
eC_Bool m_bInvisible
 Changeable state: Invisible.
 
eC_Bool m_bToggle
 Specifies whether the states shall be toggled on/off, or if they will be set exactly as given.
 
ObjectHandle_t m_eTargetObject
 Target object ID.
 

Additional Inherited Members

- 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"
 

Detailed Description

An example for a custom command that changes the object states of an GUIObject.

The target object is referenced by an object ID that has to be passed to the constructor. When this command is executed, it tries to find the specified object. If no object is found, this command does nothing. If the object is found, the object states are changed according the given values.

Constructor & Destructor Documentation

◆ CGUISetObjectStateCmd()

CGUISetObjectStateCmd::CGUISetObjectStateCmd ( ObjectHandle_t  eTargetObject,
eC_Bool  bToggle,
eC_Bool  bFocusable,
eC_Bool  bInvisible,
eC_Bool  bGrayedOut,
eC_Bool  bDisabled 
)

Constructor.

Parameters
eTargetObjectThe ID of the object to be modified by this command.
bToggleIf true, all states marked as "True" will be toggled. Otherwise all states will be set to True/False exactly as given.
bFocusableNew value of the focusable object state.
bInvisibleNew value of the invisible object state.
bGrayedOutNew value of the grayed out object state.
bDisabledNew value of the disabled object state.

Member Function Documentation

◆ ReadFromStream()

void CGUISetObjectStateCmd::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()

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

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

Parameters
bWriteClassIDThis 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 files: