Symbian^3 Product Developer Library >

CKeyLockPolicyApiImpl Class Reference

class CKeyLockPolicyApiImpl : public CBase

Keylock policy component supports three policy types:

EPolicyActivateKeyguard keys used for keyguard locking EPolicyDeactivateKeyguard keys used for keyguard unlocking EPolicyDevicelockQuery keys used for showing devicelock query CKeyLockPolicyApi. Trough CKeyLockPolicyApi users can

keylockpolicy.lib
Since
3.2

Inherits from

  • CKeyLockPolicyApiImpl
Public Member Functions
~CKeyLockPolicyApiImpl()
TInt AddKeyCombination(TUint32, TUint32)
TInt ClearKeycombinations()
TInt DisableKeyguardFeature()
TInt EnableKeyguardFeature()
TInt GetKeyCombination(TInt, TUint32 &, TUint32 &)
TUint GetLastPrimaryKey()
TBool HandleKeyEventL(const TKeyEvent &, const TEventCode)
TBool HasConfiguration()
TBool KeyguardAllowed()
CKeyLockPolicyApiImpl *NewL(TLockPolicyType)
TBool PrimaryKeyPressed()
TInt RemoveKeyCombination(TUint32, TUint32)
Private Member Functions
CKeyLockPolicyApiImpl(TLockPolicyType)
voidConstructL()
TInt FindKeyCombinationIndex(TUint32, TUint32, TInt &)
TInt GetNewKeyCombinationIndex(TInt &)
TInt HandleKeyLockTimerTimeout(TAny *)
voidHandleNotifyInt(TUint32, TInt)
TInt SetKeyCombination(TUint32, TUint32, TInt)
Inherited Functions
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
CCenRepNotifyHandler *iAllowNotif
TUint iAllowed
TBool iInitialised
CPeriodic *iKeyLockTimer
TUint iLastPrimaryKeyIndex
TUint iMask
TUint iMode
CCenRepNotifyHandler *iModeNotif
TBool iPrimaryKeyDown
RArray< TUint >iPrimaryKeys
CRepository *iRep
RArray< TUint >iSecondaryKeys
TUint iTimeout
TUint iType
RArray< TUint >iWaitingKeys

Constructor & Destructor Documentation

CKeyLockPolicyApiImpl(TLockPolicyType)

CKeyLockPolicyApiImpl(TLockPolicyTypeaType)[private]

C++ default constructor (private so cannot be derived).

Parameters

TLockPolicyType aType

~CKeyLockPolicyApiImpl()

~CKeyLockPolicyApiImpl()

Destructor.

Member Functions Documentation

AddKeyCombination(TUint32, TUint32)

TInt AddKeyCombination(TUint32aPrimaryKey,
TUint32aSecondaryKey
)

Adds a key combination for the policy type defined in the construction.

Parameters

TUint32 aPrimaryKey
TUint32 aSecondaryKey

ClearKeycombinations()

TInt ClearKeycombinations()

Clears all the defined key combinations from the policy.

ConstructL()

voidConstructL()[private]

Second constructor initializes the policy

DisableKeyguardFeature()

TInt DisableKeyguardFeature()

Disables support for keyguard feature so the phone keys cannot be locked with keyguard. Does not affect the devicelock.

EnableKeyguardFeature()

TInt EnableKeyguardFeature()

Activates support for keyguard feature so the phone keys cannot be locked with keyguard. Does not affect the devicelock.

FindKeyCombinationIndex(TUint32, TUint32, TInt &)

TInt FindKeyCombinationIndex(TUint32aPrimaryKey,
TUint32aSecondaryKey,
TInt &aIndex
)[private]

Parameters

TUint32 aPrimaryKey
TUint32 aSecondaryKey
TInt & aIndex

GetKeyCombination(TInt, TUint32 &, TUint32 &)

TInt GetKeyCombination(TIntaIndex,
TUint32 &aPrimaryKey,
TUint32 &aSecondaryKey
)

Retrieve a key combination on the given index.

Parameters

TInt aIndex
TUint32 & aPrimaryKey
TUint32 & aSecondaryKey

GetLastPrimaryKey()

TUint GetLastPrimaryKey()

Returns Primary key scan code that has been pressed last.

GetNewKeyCombinationIndex(TInt &)

TInt GetNewKeyCombinationIndex(TInt &aIndex)[private]

Parameters

TInt & aIndex

HandleKeyEventL(const TKeyEvent &, const TEventCode)

TBool HandleKeyEventL(const TKeyEvent &aKeyEvent,
const TEventCodeaType
)

Handles Key events, returns ETrue the key events match any of the defined key combinations. Only uses scancodes with type EEventKeyDown.

Parameters

const TKeyEvent & aKeyEvent
const TEventCode aType

HandleKeyLockTimerTimeout(TAny *)

TInt HandleKeyLockTimerTimeout(TAny *aSelf)[private, static]

A call back to the keylock timer param TAny aSelf a pointer to the parent class

Parameters

TAny * aSelf

HandleNotifyInt(TUint32, TInt)

voidHandleNotifyInt(TUint32aId,
TIntaNewValue
)[private]

From MCenRepNotifyHandlerCallback. Changes in the observed central repository keys are communicated trough this method.

Parameters

TUint32 aId
TInt aNewValue

HasConfiguration()

TBool HasConfiguration()

If no policy has been defined for the type it cannot be used.

KeyguardAllowed()

TBool KeyguardAllowed()[static]

Whether keyguard feature is currently enabled or disabled.

NewL(TLockPolicyType)

CKeyLockPolicyApiImpl *NewL(TLockPolicyTypeaType)[static]

Use this to create keylock policy

Parameters

TLockPolicyType aType

PrimaryKeyPressed()

TBool PrimaryKeyPressed()

Returns true if primary button is pressed and note should be shown.

RemoveKeyCombination(TUint32, TUint32)

TInt RemoveKeyCombination(TUint32aPrimaryKey,
TUint32aSecondaryKey
)

Removes a key combination for the policy type defined in the construction.

Parameters

TUint32 aPrimaryKey
TUint32 aSecondaryKey

SetKeyCombination(TUint32, TUint32, TInt)

TInt SetKeyCombination(TUint32aPrimaryKey,
TUint32aSecondaryKey,
TIntaIndex
)[private]

Parameters

TUint32 aPrimaryKey
TUint32 aSecondaryKey
TInt aIndex

Member Data Documentation

CCenRepNotifyHandler * iAllowNotif

CCenRepNotifyHandler *iAllowNotif[private]

TUint iAllowed

TUint iAllowed[private]

TBool iInitialised

TBool iInitialised[private]

CPeriodic * iKeyLockTimer

CPeriodic *iKeyLockTimer[private]

TUint iLastPrimaryKeyIndex

TUint iLastPrimaryKeyIndex[private]

TUint iMask

TUint iMask[private]

TUint iMode

TUint iMode[private]

CCenRepNotifyHandler * iModeNotif

CCenRepNotifyHandler *iModeNotif[private]

TBool iPrimaryKeyDown

TBool iPrimaryKeyDown[private]

RArray< TUint > iPrimaryKeys

RArray< TUint >iPrimaryKeys[private]

CRepository * iRep

CRepository *iRep[private]

RArray< TUint > iSecondaryKeys

RArray< TUint >iSecondaryKeys[private]

TUint iTimeout

TUint iTimeout[private]

TUint iType

TUint iType[private]

RArray< TUint > iWaitingKeys

RArray< TUint >iWaitingKeys[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.