CAknLongTapDetector Class Reference

Link against: avkon.lib

#include <aknlongtapdetector.h>

Detailed Description

Avkon Long Tap Detector.

Receives pointer events from owner application or owner control and returns location if a long tap event occurs. After short period of time (default 0,15s) animation is displayed next to stylus on the screen to inform the user of long tap functionality. Animation can be turned OFF by application if wanted.

Dll avkon.lib
Since:
S60 5.0

Public Member Functions

virtual ~CAknLongTapDetector ()
 Destructor.
IMPORT_C void PointerEventL (const TPointerEvent &aEvent)
 Receives and handles pointer events from owner's HandlePointerEventL() -method.
IMPORT_C void SetTimeDelayBeforeAnimation (const TInt aMicroSeconds)
 Sets new time delay before long tap detector animation starts.
IMPORT_C void SetLongTapDelay (const TInt aMicroSeconds)
 Sets new time delay before long tap detector event is returned.
IMPORT_C void EnableLongTapAnimation (const TBool aAnimation)
 Sets long tap animation ON/OFF.
IMPORT_C TBool IsAnimationRunning () const
 Checks if the animation is running.
IMPORT_C void CancelAnimationL ()
 Cancels the long tap animation.
void MonitorWsMessage (const TWsEvent &aEvent)
 This function is used to capture key events during the long tap animation.

Static Public Member Functions

static IMPORT_C CAknLongTapDetector * NewL (MAknLongTapDetectorCallBack *aOwner)
 Two-phased constructor.
static IMPORT_C CAknLongTapDetector * NewLC (MAknLongTapDetectorCallBack *aOwner)
 Two-phased constructor.

Constructor & Destructor Documentation

virtual CAknLongTapDetector::~CAknLongTapDetector (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C void CAknLongTapDetector::CancelAnimationL (   ) 
 

Cancels the long tap animation.

IMPORT_C void CAknLongTapDetector::EnableLongTapAnimation ( const TBool  aAnimation  ) 
 

Sets long tap animation ON/OFF.

Default is ON.

Parameters:
aAnimation ETrue turns animations ON and EFalse turns animations OFF.
IMPORT_C TBool CAknLongTapDetector::IsAnimationRunning (   )  const
 

Checks if the animation is running.

Returns:
ETrue if the animation is running, EFalse if not
void CAknLongTapDetector::MonitorWsMessage ( const TWsEvent &  aEvent  ) 
 

This function is used to capture key events during the long tap animation.

If such events are received, the long tap animation is then cancelled.

static IMPORT_C CAknLongTapDetector* CAknLongTapDetector::NewL ( MAknLongTapDetectorCallBack *  aOwner  )  [static]
 

Two-phased constructor.

Parameters:
aOwner Pointer to owner of this component. Ownership not transferred.
static IMPORT_C CAknLongTapDetector* CAknLongTapDetector::NewLC ( MAknLongTapDetectorCallBack *  aOwner  )  [static]
 

Two-phased constructor.

Parameters:
aOwner Pointer to owner of this component. Ownership not transferred.
IMPORT_C void CAknLongTapDetector::PointerEventL ( const TPointerEvent &  aEvent  ) 
 

Receives and handles pointer events from owner's HandlePointerEventL() -method.

Used to control timers in detecting long tap events.

Parameters:
aEvent Pointer event from owner.
IMPORT_C void CAknLongTapDetector::SetLongTapDelay ( const TInt  aMicroSeconds  ) 
 

Sets new time delay before long tap detector event is returned.

Default delay is 0,8s.

Parameters:
aMicroSeconds New delay in microseconds.
IMPORT_C void CAknLongTapDetector::SetTimeDelayBeforeAnimation ( const TInt  aMicroSeconds  ) 
 

Sets new time delay before long tap detector animation starts.

Default delay is 0,15s.

Parameters:
aMicroSeconds New delay in microseconds.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top