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 <GUIConditionalBehaviour.h>

Inheritance diagram for CGUIConditionalBehaviour:

[legend]

Public Types
enum	Operation_t { OP_LESS , OP_LESS_EQUAL , OP_EQUAL , OP_NOT_EQUAL , OP_GREATER_EQUAL , OP_GREATER }
	Operations for behaviour. More...

Public Member Functions
	CGUIConditionalBehaviour ()
	Default constructor.

CGUICommandPtr	GetCommand () const

DataPoolResource_t	GetDataPoolID () const

void	GetIndex (eC_UInt &uiX, eC_UInt &uiY) const

Operation_t	GetOperation () const

CGUIValue	GetValue () const

virtual void	ReadFromStream ()

void	SetCommand (CGUICommandPtr pkCmd)

void	SetDataPoolID (const DataPoolResource_t &eID)

void	SetIndex (const eC_UInt &uiX, const eC_UInt &uiY)

void	SetOperation (const Operation_t &eOperation)

void	SetValue (const CGUIValue &kValue)

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 Enumeration Documentation

◆ Operation_t

enum CGUIConditionalBehaviour::Operation_t

Operations for behaviour.

Enumerator
OP_LESS	less (<)
OP_LESS_EQUAL	less or equal (<=)
OP_EQUAL	equal (==)
OP_NOT_EQUAL	not equal (!=)
OP_GREATER_EQUAL	greater or equal (>=)
OP_GREATER	greater (>)

Member Function Documentation

◆ ExecuteCommand()

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

◆ GetCommand()

CGUICommandPtr CGUIConditionalBehaviour::GetCommand ( ) const

get the command which is executed on true

Returns: command

◆ GetDataPoolID()

DataPoolResource_t CGUIConditionalBehaviour::GetDataPoolID ( ) const

get connected datapool

Returns: id

◆ GetIndex()

void CGUIConditionalBehaviour::GetIndex	(	eC_UInt &	uiX,
		eC_UInt &	uiY
	)		const

get index for datapool

Parameters

uiX
uiY

◆ GetOperation()

Operation_t CGUIConditionalBehaviour::GetOperation ( ) const

get the compare operation

Returns: operation

◆ GetValue()

CGUIValue CGUIConditionalBehaviour::GetValue ( ) const

get compare-value

Returns: value

◆ ReadFromStream()

virtual void CGUIConditionalBehaviour::ReadFromStream ( )

virtual

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

See also: CGUIObject::ReadFromStream()

Reimplemented from CGUIStreamableObject.

◆ SetCommand()

void CGUIConditionalBehaviour::SetCommand ( CGUICommandPtr pkCmd )

set the command which is executed on true

Parameters

pkCmd

◆ SetDataPoolID()

void CGUIConditionalBehaviour::SetDataPoolID ( const DataPoolResource_t & eID )

set the connected datapool

Parameters

eID

◆ SetIndex()

void CGUIConditionalBehaviour::SetIndex	(	const eC_UInt &	uiX,
		const eC_UInt &	uiY
	)

set index for datapool

Parameters

uiX
uiY

◆ SetOperation()

void CGUIConditionalBehaviour::SetOperation ( const Operation_t & eOperation )

set the compare operation

Parameters

eOperation

◆ SetValue()

void CGUIConditionalBehaviour::SetValue ( const CGUIValue & kValue )

set compare-value the value will be converted to match the datapool-value

Parameters

kValue

◆ WriteToStream()

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

GUIConditionalBehaviour.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Operation_t

Member Function Documentation

◆ ExecuteCommand()

◆ GetCommand()

◆ GetDataPoolID()

◆ GetIndex()

◆ GetOperation()

◆ GetValue()

◆ ReadFromStream()

◆ SetCommand()

◆ SetDataPoolID()

◆ SetIndex()

◆ SetOperation()

◆ SetValue()

◆ WriteToStream()