RAknKeyLock Class Reference

#include <mw/aknkeylock.h>

Link against: avkon.lib

class RAknKeyLock : public RNotifier

Inherits from

  • RAknKeyLock
    Public Member Functions
    IMPORT_C voidCancelAllNotifications()
    IMPORT_C voidDisableKeyLock()
    IMPORT_C voidDisableWithoutNote()
    IMPORT_C voidEnableAutoLockEmulation()
    IMPORT_C voidEnableKeyLock()
    IMPORT_C voidEnableSoftNotifications(TBool)
    IMPORT_C voidEnableWithoutNote()
    IMPORT_C TBoolIsKeyLockEnabled()
    IMPORT_C voidOfferKeyLock()
    Inherited Attributes
    RHandleBase::iHandle
    Inherited Enumerations
    RHandleBase:TAttributes
    RSessionBase:TAttachMode
    Inherited Functions
    RHandleBase::Attributes()const
    RHandleBase::BTraceId()const
    RHandleBase::DoExtendedClose()
    RHandleBase::Duplicate(const RThread &,TOwnerType)
    RHandleBase::FullName()const
    RHandleBase::FullName(TDes &)const
    RHandleBase::Handle()const
    RHandleBase::HandleInfo(THandleInfo *)
    RHandleBase::Name()const
    RHandleBase::NotifyDestruction(TRequestStatus &)
    RHandleBase::Open(const TFindHandleBase &,TOwnerType)
    RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
    RHandleBase::RHandleBase()
    RHandleBase::RHandleBase(TInt)
    RHandleBase::SetHandle(TInt)
    RHandleBase::SetHandleNC(TInt)
    RNotifier::CancelNotifier(TUid)
    RNotifier::Close()
    RNotifier::Connect()
    RNotifier::InfoPrint(const TDesC &)
    RNotifier::LoadNotifiers(TUid)
    RNotifier::Notify(const TDesC &,const TDesC &,const TDesC &,const TDesC &,TInt &,TRequestStatus &)
    RNotifier::NotifyCancel()
    RNotifier::RNotifier()
    RNotifier::StartNotifier(TUid,TUid,const TDesC8 &,TDes8 &)
    RNotifier::StartNotifier(TUid,const TDesC8 &)
    RNotifier::StartNotifier(TUid,const TDesC8 &,TDes8 &)
    RNotifier::StartNotifierAndGetResponse(TRequestStatus &,TUid,TUid,const TDesC8 &,TDes8 &)
    RNotifier::StartNotifierAndGetResponse(TRequestStatus &,TUid,const TDesC8 &,TDes8 &)
    RNotifier::UnloadNotifiers(TUid)
    RNotifier::UpdateNotifier(TUid,const TDesC8 &,TDes8 &)
    RNotifier::UpdateNotifierAndGetResponse(TRequestStatus &,TUid,const TDesC8 &,TDes8 &)
    RSessionBase::CreateSession(RServer2,const TVersion &)
    RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
    RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
    RSessionBase::CreateSession(const TDesC &,const TVersion &)
    RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
    RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
    RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
    RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
    RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
    RSessionBase::Open(TInt,TOwnerType)
    RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
    RSessionBase::Send(TInt)const
    RSessionBase::Send(TInt,const TIpcArgs &)const
    RSessionBase::SendReceive(TInt)const
    RSessionBase::SendReceive(TInt,TRequestStatus &)const
    RSessionBase::SendReceive(TInt,const TIpcArgs &)const
    RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
    RSessionBase::SetReturnedHandle(TInt)
    RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
    RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
    RSessionBase::ShareAuto()
    RSessionBase::ShareProtected()

    Detailed Description

    A handle class API disabling/enabling keylock state.

    Since
    S60 0.9

    Member Function Documentation

    CancelAllNotifications ( )

    IMPORT_C voidCancelAllNotifications()

    All notifications queued to be shown are cancelled.

    DisableKeyLock ( )

    IMPORT_C voidDisableKeyLock()

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

    DisableWithoutNote ( )

    IMPORT_C voidDisableWithoutNote()

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

    Since
    S60 2.0

    EnableAutoLockEmulation ( )

    IMPORT_C voidEnableAutoLockEmulation()

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

    EnableKeyLock ( )

    IMPORT_C voidEnableKeyLock()

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

    EnableSoftNotifications ( TBool )

    IMPORT_C voidEnableSoftNotifications(TBoolaEnable)

    Controls whether soft notifications will be shown at all.

    EnableWithoutNote ( )

    IMPORT_C voidEnableWithoutNote()

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

    Since
    S60 2.1

    IsKeyLockEnabled ( )

    IMPORT_C TBoolIsKeyLockEnabled()

    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.

    OfferKeyLock ( )

    IMPORT_C voidOfferKeyLock()

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