RAknKeyLock Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknkeylock.h>

Inherited by RAknKeylock2.

Detailed Description

A handle class API disabling/enabling keylock state.

Public Member Functions
IMPORT_C void  EnableKeyLock ()
  Locks the keys of the device and shows a keys locked note.
IMPORT_C void  DisableKeyLock ()
  Unlocks the keys of the device and shows a keys unlocked note.
IMPORT_C TBool  IsKeyLockEnabled ()
  Returns whether the phone keys have been locked or not.
IMPORT_C void  EnableSoftNotifications (TBool aEnable)
  Controls whether soft notifications will be shown at all.
IMPORT_C void  OfferKeyLock ()
  Shows a note on the screen asking the user permission to lock the keypad.
IMPORT_C void  CancelAllNotifications ()
  All notifications queued to be shown are cancelled.
IMPORT_C void  EnableAutoLockEmulation ()
  Locks the device keys similar to autolock/device lock state.
IMPORT_C void  DisableWithoutNote ()
  Unlocks the keys of the device without showing the keys unlocked note.
IMPORT_C void  EnableWithoutNote ()
  Locks the keys of the device without showing the keys locked note.

Member Function Documentation

IMPORT_C void RAknKeyLock::CancelAllNotifications (   ) 
 

All notifications queued to be shown are cancelled.

IMPORT_C void RAknKeyLock::DisableKeyLock (   ) 
 

Unlocks the keys of the device and shows a keys unlocked note.

IMPORT_C void RAknKeyLock::DisableWithoutNote (   ) 
 

Unlocks the keys of the device without showing the keys unlocked note.

IMPORT_C void RAknKeyLock::EnableAutoLockEmulation (   ) 
 

Locks the device keys similar to autolock/device lock state.

IMPORT_C void RAknKeyLock::EnableKeyLock (   ) 
 

Locks the keys of the device and shows a keys locked note.

IMPORT_C void RAknKeyLock::EnableSoftNotifications (  TBool  aEnable  ) 
 

Controls whether soft notifications will be shown at all.

Parameters:
ETrue  if soft notifications should be shown.
IMPORT_C void RAknKeyLock::EnableWithoutNote (   ) 
 

Locks the keys of the device without showing the keys locked note.

IMPORT_C TBool RAknKeyLock::IsKeyLockEnabled (   ) 
 

Returns whether the phone keys have been locked or not.

Returns:
ETrue if the keys have been locked normally or the phone is in autolock state.
IMPORT_C void RAknKeyLock::OfferKeyLock (   ) 
 

Shows a note on the screen asking the user permission to lock the keypad.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top