Symbian^3 Product Developer Library >

CKeyguardAccessApi Class Reference

class CKeyguardAccessApi : public CBase

RKeyguardAccessApi class. Client used to access/configure keyguard features.

lockapp
Since
5.0

Inherits from

Public Member Functions
~CKeyguardAccessApi()
IMPORT_C TIntDisableKeyguard(TBool)
IMPORT_C TIntEnableKeyguard(TBool)
IMPORT_C TBoolIsKeyguardEnabled()
IMPORT_C TBoolIsKeylockEnabled()
IMPORT_C CKeyguardAccessApi *NewL()
IMPORT_C TIntOfferKeyguard()
IMPORT_C TIntShowKeysLockedNote()
IMPORT_C TIntTestDestruct()
IMPORT_C TIntTestInternal()
IMPORT_C TIntTestPanicClient()
Private Member Functions
CKeyguardAccessApi()
voidConstructL()
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
RLockAccessExtension *iLockAccessExtension

Constructor & Destructor Documentation

CKeyguardAccessApi()

CKeyguardAccessApi()[private]

Constructor for performing 1st stage construction

~CKeyguardAccessApi()

IMPORT_C~CKeyguardAccessApi()

Destructor.

Member Functions Documentation

ConstructL()

voidConstructL()[private]

Default constructor for performing 2nd stage construction

DisableKeyguard(TBool)

IMPORT_C TIntDisableKeyguard(TBoolaWithNote)

Disable keyguard. Only works if devicelock is not enabled.

Parameters

TBool aWithNoteshould informing note be shown

EnableKeyguard(TBool)

IMPORT_C TIntEnableKeyguard(TBoolaWithNote)

Enable keyguard. Only works if devicelock is not enabled.

Parameters

TBool aWithNoteshould informing note be shown

IsKeyguardEnabled()

IMPORT_C TBoolIsKeyguardEnabled()

Has keyguard been activated.

IsKeylockEnabled()

IMPORT_C TBoolIsKeylockEnabled()

Returns true if phone is keys are locked. Both keyguard and devicelock cannot be simultaneously enabled.

NewL()

IMPORT_C CKeyguardAccessApi *NewL()[static]

Two-phased constructor.

OfferKeyguard()

IMPORT_C TIntOfferKeyguard()

Offer to enable keyguard. Shows a query note to user.

ShowKeysLockedNote()

IMPORT_C TIntShowKeysLockedNote()

Shows note informing that keys are locked. Only works if keyguard is already enabled.

TestDestruct()

IMPORT_C TIntTestDestruct()

TestInternal()

IMPORT_C TIntTestInternal()

Test functions, return KErrNotSupported in release builds.

TestPanicClient()

IMPORT_C TIntTestPanicClient()

Member Data Documentation

RLockAccessExtension * iLockAccessExtension

RLockAccessExtension *iLockAccessExtension[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.