Guiliani  Version 2.6 revision 7293 (documentation build 12)
CGUIMultitouchBehaviour Class Reference

Behaviour for processing object state changes. More...

#include <GUIMultitouchBehaviour.h>

Inheritance diagram for CGUIMultitouchBehaviour:

Public Types

enum  MultitouchType_t { MT_SCALE , MT_SCROLL }
 enum for gesture type More...
 

Public Member Functions

 CGUIMultitouchBehaviour (const MultitouchType_t &eType, const eC_Bool &bKeepCenter, const eC_Value &vFactor)
 
eC_Value GetFactor () const
 
eC_Bool GetKeepCenter () const
 
MultitouchType_t GetType () const
 
virtual void ReadFromStream ()
 
void SetFactor (const eC_Value &vFactor)
 
void SetKeepCenter (const eC_Bool &bKeepCenter)
 
void SetType (const MultitouchType_t &eType)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIBehaviourDecorator
virtual ~CGUIBehaviourDecorator ()
 
virtual CGUIBehaviourDecoratorClone () 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 DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoLongClick (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 DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))
 
virtual eC_Bool FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
virtual eC_Bool FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)
 
virtual void GetFocus ()
 
virtual void LoseFocus ()
 
virtual eC_Bool Decrease ()
 
virtual eC_Bool Increase ()
 
virtual eC_Bool DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
virtual eC_Bool DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
 
- 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 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)
 
- Protected Member Functions inherited from CGUIBehaviourDecorator
 CGUIBehaviourDecorator (CGUIObject *const pkObject=NULL)
 
 CGUIBehaviourDecorator (const CGUIBehaviourDecorator &kSource)
 
virtual void AssociatedObjectChanges (CGUIObject *const pkNewAssociatedObject)
 
CGUIObjectGetAssociatedObject () 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 processing object state changes.

Member Enumeration Documentation

◆ MultitouchType_t

enum for gesture type

Enumerator
MT_SCALE 

scaling

MT_SCROLL 

scrolling

Constructor & Destructor Documentation

◆ CGUIMultitouchBehaviour()

CGUIMultitouchBehaviour::CGUIMultitouchBehaviour ( const MultitouchType_t eType,
const eC_Bool &  bKeepCenter,
const eC_Value &  vFactor 
)

Constructor

Parameters
eTypetype of gesture
bKeepCenterif true the center of the object will be retained
vFactorfactor for gesture

Member Function Documentation

◆ DoScale()

virtual eC_Bool CGUIMultitouchBehaviour::DoScale ( const eC_Value &  vDelta)
protectedvirtual

Slot for handling scaling-events will be called if a gesture has been detected which results in scaling

Parameters
vDeltadelta for span (radius of circle around touches)
Returns
True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ DoScroll()

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

Called when the mouse wheel was scrolled

Parameters
vAbsXX-position of the mouse in screen coordinates
vAbsYY-position of the mouse in screen coordinates
vDeltanumber of pixels for scroll
bModifierActiveif true the scroll modifier is active (e.g. left/right instead of up/down)
Returns
True If the event has been handled.
false Else.

Reimplemented from CGUIBehaviour.

◆ GetFactor()

eC_Value CGUIMultitouchBehaviour::GetFactor ( ) const

Get the factor used for scaling and scrolling

Returns
factor

◆ GetKeepCenter()

eC_Bool CGUIMultitouchBehaviour::GetKeepCenter ( ) const

Get if the object should keep its center

Returns
true if center will be kept

◆ GetType()

MultitouchType_t CGUIMultitouchBehaviour::GetType ( ) const

Get the current set type of processing

Returns
the type

◆ ReadFromStream()

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

◆ SetFactor()

void CGUIMultitouchBehaviour::SetFactor ( const eC_Value &  vFactor)

Set the factor for scaling and scrolling

Parameters
vFactorthe factor used for scaling and scrolling for scaling this factor will be multiplied with the delta movement for scrolling this factor is the number of pixels the object is moved

◆ SetKeepCenter()

void CGUIMultitouchBehaviour::SetKeepCenter ( const eC_Bool &  bKeepCenter)

Set the keep center position when resizing the object

Parameters
bKeepCenterif true the object will keep its center position

◆ SetType()

void CGUIMultitouchBehaviour::SetType ( const MultitouchType_t eType)

Set the type of processing, either scaling or scrolling

Parameters
eTypescaling or scrolling

◆ WriteToStream()

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


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