GestureHelper::CGestureControl Class Reference

class GestureHelper::CGestureControl : public CAlfControl

Gesture control provides pointer event forwarding to gesture helper.

Gesture control can be created as
  • Stand-alone: This functionality is usable by clients that want to capture pointer events from anywhere in the screen. For example, a view that wants to know if user tapped anywhere on the screen could use this.

  • Derived: client can use the forward-pointer-events-to-gesture-helper functionality by deriving from CGestureControl . Client has to create at least one visual that captures pointer events. This base class will receive the events and forward them to CGestureHelper.

The client can keep other widgets on top of this control, to allow them priority of capturing the pointer events.

Inherits from

Public Member Functions
~CGestureControl ()
IMPORT_C TBool IsDoubleTapEnabled ()
IMPORT_C TBool IsHoldingEnabled ()
IMPORT_C CGestureControl * NewLC ( MGestureObserver &, CAlfEnv &, CAlfDisplay &, TInt )
IMPORT_C TBool OfferEventL (const TAlfEvent &)
IMPORT_C void SetDoubleTapEnabled ( TBool )
IMPORT_C void SetHoldingEnabled ( TBool )
Protected Member Functions
CGestureControl ()
IMPORT_C void ConstructL ( MGestureObserver &, CAlfEnv &, CAlfDisplay &, TInt )
Inherited Functions
CAlfControl::AcceptInput()const
CAlfControl::AcquireFocus()
CAlfControl::AddConnectionL(CAlfControl *,TInt)
CAlfControl::Append(CAlfVisual *,CAlfLayout *)
CAlfControl::AppendLayoutL(TAlfLayoutType,CAlfLayout *,TInt)
CAlfControl::AppendVisualL(TAlfVisualType,CAlfLayout *,TInt)
CAlfControl::BindDisplay(CAlfDisplay &)
CAlfControl::Bounds()const
CAlfControl::CAlfControl()
CAlfControl::CancelAllCommands()
CAlfControl::ClearChanged()
CAlfControl::Connection(TInt)const
CAlfControl::ConnectionAddedL(CAlfControl *,TInt)
CAlfControl::ConnectionByOrdinal(TInt)const
CAlfControl::ConnectionCount()const
CAlfControl::ConnectionOrdinal(TInt)const
CAlfControl::ConnectionRemoved(CAlfControl *,TInt)
CAlfControl::ConnectionRole(TInt)const
CAlfControl::ConstructL(CAlfEnv &)
CAlfControl::ContainerLayout(const CAlfControl *)const
CAlfControl::ControlGroup()const
CAlfControl::Display()const
CAlfControl::DisplayArea()const
CAlfControl::DisplayCenter()const
CAlfControl::DisplayToHost(const TPoint &)const
CAlfControl::Env()const
CAlfControl::FindConnection(const CAlfControl *)const
CAlfControl::FindTag(const TDesC8 &)const
CAlfControl::Focus()const
CAlfControl::FocusChainChanged(TBool)
CAlfControl::FocusChanged(CAlfDisplay &,TBool)
CAlfControl::FocusedConnection()const
CAlfControl::Hide(CAlfDisplay &)
CAlfControl::HitTest(const TPoint &)const
CAlfControl::Host()const
CAlfControl::HostChangingL(CAlfControl *)
CAlfControl::HostId()const
CAlfControl::HostToDisplay(const TPoint &)const
CAlfControl::Id()const
CAlfControl::Identifier()const
CAlfControl::IsFocusing()const
CAlfControl::NotifyControlVisibility(TBool,CAlfDisplay &)
CAlfControl::PropertyOwnerExtension(const TUid &,TAny **)
CAlfControl::RelinquishFocus()
CAlfControl::Remove(CAlfVisual *)
CAlfControl::RemoveConnection(CAlfControl *)
CAlfControl::RemoveVisualsFromHostControl(CAlfControl &)
CAlfControl::Role()const
CAlfControl::SetControlGroup(CAlfControlGroup &)
CAlfControl::SetFocus(CAlfDisplay &,TBool)
CAlfControl::SetFocusing(TBool)
CAlfControl::SetHost(CAlfControl *)
CAlfControl::SetHostId(TInt)
CAlfControl::SetId(TInt)
CAlfControl::SetRole(TInt)
CAlfControl::ShowL(CAlfDisplay &)
CAlfControl::Visual(TInt)const
CAlfControl::VisualAddedL(CAlfVisual *)
CAlfControl::VisualCount()const
CAlfControl::VisualDestroyed(CAlfVisual &)
CAlfControl::VisualLayoutUpdated(CAlfVisual &)
CAlfControl::VisualPrepareDrawFailed(CAlfVisual &,TInt)
CAlfControl::VisualRemoved(CAlfVisual *)
CAlfControl::~CAlfControl()
CAlfPropertyOwner::CAlfPropertyOwner()
CAlfPropertyOwner::CopyProperty(const CAlfPropertyOwner &,const TDesC8 &)
CAlfPropertyOwner::PropertyClear()
CAlfPropertyOwner::PropertyFindInteger(const TDesC8 &,TInt *)const
CAlfPropertyOwner::PropertyFindString(const TDesC8 &,TDesC **)const
CAlfPropertyOwner::PropertyRemove(const TDesC8 &)
CAlfPropertyOwner::PropertySetIntegerL(const TDesC8 &,TInt,TInt,TInt)
CAlfPropertyOwner::PropertySetStringL(const TDesC8 &,const TDesC &)
CAlfPropertyOwner::~CAlfPropertyOwner()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CGestureHelper * iHelper

Constructor & Destructor Documentation

CGestureControl()

IMPORT_C CGestureControl ( ) [protected]

Constructor

~CGestureControl()

IMPORT_C ~CGestureControl ( )

Destructor

Member Functions Documentation

ConstructL(MGestureObserver &, CAlfEnv &, CAlfDisplay &, TInt)

IMPORT_C void ConstructL ( MGestureObserver & aObserver,
CAlfEnv & aEnv,
CAlfDisplay & aDisplay,
TInt aFreeControlGroupId
) [protected]

Deriving class is expected to create a visual to receive pointer events. This base class does not create a visual (unless creates via NewLC, i.e., in that case this class is not derived from)

Parameters

MGestureObserver & aObserver
CAlfEnv & aEnv
CAlfDisplay & aDisplay
TInt aFreeControlGroupId control group id that client does not use

IsDoubleTapEnabled()

IMPORT_C TBool IsDoubleTapEnabled ( ) const

CGestureHelper::IsDoubleTapEnabled

IsHoldingEnabled()

IMPORT_C TBool IsHoldingEnabled ( ) const

CGestureHelper::IsHoldingEnabled

NewLC(MGestureObserver &, CAlfEnv &, CAlfDisplay &, TInt)

IMPORT_C CGestureControl * NewLC ( MGestureObserver & aObserver,
CAlfEnv & aEnv,
CAlfDisplay & aDisplay,
TInt aFreeControlGroupId
) [static]

Creates a stand-alone gesture control. Creates a full screen visual that captures pointer events. Converts pointer events to gestures and calls back on aObserver.

Parameters

MGestureObserver & aObserver
CAlfEnv & aEnv
CAlfDisplay & aDisplay
TInt aFreeControlGroupId control group id that client does not use

OfferEventL(const TAlfEvent &)

IMPORT_C TBool OfferEventL ( const TAlfEvent & aEvent ) [virtual]

Called when an input event is being offered to the control.

Parameters

const TAlfEvent & aEvent Event to be handled.

SetDoubleTapEnabled(TBool)

IMPORT_C void SetDoubleTapEnabled ( TBool aEnabled )

CGestureHelper::SetDoubleTapEnabled

Parameters

TBool aEnabled

SetHoldingEnabled(TBool)

IMPORT_C void SetHoldingEnabled ( TBool aEnabled )

CGestureHelper::SetHoldingEnabled

Parameters

TBool aEnabled

Member Data Documentation

CGestureHelper * iHelper

CGestureHelper * iHelper [private]