Behaviour for repeating clicks on object Additional phases can be defined where the start-time of the phase is measured from the beginning of the previous phase. More...

#include <GUIToggleBehaviour.h>

Inheritance diagram for CGUIToggleBehaviour:

[legend]

Public Member Functions
	CGUIToggleBehaviour ()
	Default constructor.

CGUICommandPtr	GetFalseCommand () const

eC_Bool	GetInitialState () const

CGUICommandPtr	GetTrueCommand () const

virtual void	ReadFromStream ()

void	SetFalseCommand (CGUICommandPtr pkCmd)

void	SetInitialState (const eC_Bool &bInitialState)

void	SetTrueCommand (CGUICommandPtr pkCmd)

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	DoScale (const eC_Value &vDelta)

virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)

virtual void	OnCreate ()

virtual void	OnDataPool (const DataPoolResource_t &eID)

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)

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	DoScale (const eC_Value &vDelta)

virtual eC_Bool	DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)

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	OnDataPool (const DataPoolResource_t &eID)

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

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

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 const eC_Char	XMLTAG_BEHAVIOURCOUNT []
	XML tag for count.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Detailed Description

Behaviour for repeating clicks on object Additional phases can be defined where the start-time of the phase is measured from the beginning of the previous phase.

Member Function Documentation

◆ ExecuteCommand()

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

protectedvirtual

Executes the command for the given behaviour, if it is equal to the stored one.

Parameters

eFromBehaviour Behaviour slot from which this method was called.

Implements CGUICmdBehaviour.

◆ GetFalseCommand()

CGUICommandPtr CGUIToggleBehaviour::GetFalseCommand ( ) const

get the command which is executed on false

Returns: command

◆ GetInitialState()

eC_Bool CGUIToggleBehaviour::GetInitialState ( ) const

get initial state

Returns: initial state

◆ GetTrueCommand()

CGUICommandPtr CGUIToggleBehaviour::GetTrueCommand ( ) const

get the command which is executed on true

Returns: command

◆ ReadFromStream()

virtual void CGUIToggleBehaviour::ReadFromStream ( )

virtual

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

See also: CGUIObject::ReadFromStream()

Reimplemented from CGUIStreamableObject.

◆ SetFalseCommand()

void CGUIToggleBehaviour::SetFalseCommand ( CGUICommandPtr pkCmd )

set the command which is executed on false

Parameters

pkCmd

◆ SetInitialState()

void CGUIToggleBehaviour::SetInitialState ( const eC_Bool & bInitialState )

set initial state will also set the internal state

Parameters

bInitialState

◆ SetTrueCommand()

void CGUIToggleBehaviour::SetTrueCommand ( CGUICommandPtr pkCmd )

set the command which is executed on true

Parameters

pkCmd

◆ WriteToStream()

virtual void CGUIToggleBehaviour::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:

GUIToggleBehaviour.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ExecuteCommand()

◆ GetFalseCommand()

◆ GetInitialState()

◆ GetTrueCommand()

◆ ReadFromStream()

◆ SetFalseCommand()

◆ SetInitialState()

◆ SetTrueCommand()

◆ WriteToStream()