CGUIMultiCmdBehaviour Class Reference

Associates one command with each event slot. More...

#include <GUIMultiCmdBehaviour.h>

Inheritance diagram for CGUIMultiCmdBehaviour:

Public Member Functions
	CGUIMultiCmdBehaviour ()
virtual	~CGUIMultiCmdBehaviour ()
virtual CGUIBehaviourDecorator *	Clone () const
virtual void	ReadFromStream ()
void	SetCmdForBehaviour (CGUICommandPtr pkCommand, const BehaviourType_t &eBehaviourType)
virtual void	WriteToStream (const eC_Bool bWriteClassID=false)
Public Member Functions inherited from CGUIBehaviourDecorator
virtual	~CGUIBehaviourDecorator ()
virtual CGUIBehaviourDecorator *	Clone () const
virtual eC_Bool	IsCompositeBehaviour () const
Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)
virtual void	OnCreate ()
virtual void	OnDelete ()
virtual void	OnHide ()
virtual void	OnShow ()
virtual eC_Bool	DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
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)

Static Public Attributes
static const eC_Char	XMLTAG_BEHAVIOURTYPE []
	XML tag to be used when writing a behaviour type into a stream.
Static Public Attributes inherited from CGUIBehaviour
static const eC_Char	XMLTAG_BEHAVIOURCLASSID []
	XML tag to be used when writing a behaviour class ID into a stream.
Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Protected Member Functions
virtual void	ExecuteCommand (const BehaviourType_t &eFromBehaviour)
Protected Member Functions inherited from CGUICmdBehaviour
	CGUICmdBehaviour ()
virtual	~CGUICmdBehaviour ()
virtual eC_Bool	Decrease ()
virtual eC_Bool	DoButtonDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoButtonUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyID, const eC_UInt &uiModifiers)
virtual eC_Bool	DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
virtual eC_Bool	DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
virtual eC_Bool	DoDrag (const eC_Value &vDeltaX, const eC_Value &vDeltaY, const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoKeyDown (const GUIKeyIdentifier_t &eKeyID, const eC_UInt &uiModifiers)
virtual eC_Bool	DoKeyUp (const GUIKeyIdentifier_t &eKeyID, const eC_UInt &uiModifiers)
virtual eC_Bool	DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
virtual eC_Bool	DoMouseEnter (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoMouseLeave (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollDown (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollLeft (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollRight (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual eC_Bool	DoScrollUp (const eC_Value &vAbsX, const eC_Value &vAbsY)
virtual void	ExecuteCommand (const BehaviourType_t &eFromBehaviour)=0
	Executes the command for the given behaviour, if it is equal to the stored one. More...
virtual eC_Bool	FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
virtual eC_Bool	FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
virtual void	GetFocus ()
virtual eC_Bool	Increase ()
virtual void	LoseFocus ()
virtual void	OnCreate ()
virtual void	OnDelete ()
virtual void	OnHide ()
virtual void	OnShow ()
Protected Member Functions inherited from CGUIBehaviourDecorator
	CGUIBehaviourDecorator (CGUIObject *const pkObject=NULL)
	CGUIBehaviourDecorator (const CGUIBehaviourDecorator &kSource)
virtual void	AssociatedObjectChanges (CGUIObject *const pkNewAssociatedObject)
CGUIObject *	GetAssociatedObject () const
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

Associates one command with each event slot.

This class gives the possibility to execute a separate command for each event (e.g. click event, drag event, etc.).

Constructor & Destructor Documentation

CGUIMultiCmdBehaviour()

CGUIMultiCmdBehaviour::CGUIMultiCmdBehaviour

(

)

Constructor.

~CGUIMultiCmdBehaviour()

virtual CGUIMultiCmdBehaviour::~CGUIMultiCmdBehaviour ( )

inlinevirtual

Destructor.

Member Function Documentation

Clone()

virtual CGUIBehaviourDecorator * CGUIMultiCmdBehaviour::Clone ( ) const

virtual

Creates an exact copy of this behaviour. Should be re-implemented by each derived class to return the correct type of behaviour.

Returns

the created copy.

Reimplemented from CGUIBehaviourDecorator.

ExecuteCommand()

virtual void CGUIMultiCmdBehaviour::ExecuteCommand ( const BehaviourType_t &  eFromBehaviour )

protectedvirtual

Executes the command for the given behaviour, if there is one set.

Parameters

eFromBehaviour

Behaviour slot from which this method was called.

Implements CGUICmdBehaviour.

ReadFromStream()

virtual void CGUIMultiCmdBehaviour::ReadFromStream ( )

virtual

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

See also

CGUIObject::ReadFromStream()

Reimplemented from CGUIStreamableObject.

SetCmdForBehaviour()

void CGUIMultiCmdBehaviour::SetCmdForBehaviour	(	CGUICommandPtr	pkCommand,
		const BehaviourType_t &	eBehaviourType
	)

Sets the command for a specific behaviour. If there is already a command set it will be deleted.

Parameters

pkCommand	The command to execute.
eBehaviourType	The behaviour type.

WriteToStream()

virtual void CGUIMultiCmdBehaviour::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 CGUIStreamableObject.

---

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

• GUIMultiCmdBehaviour.h