Collapse all Symbian^3 Application Developer Library

CKeyguardAccessApi Class Reference

class CKeyguardAccessApi : public CBase

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

lockapp

Since: 5.0

Inherits from

CKeyguardAccessApi
- CBase

Public Member Functions
	~CKeyguardAccessApi ()
IMPORT_C TInt	DisableKeyguard ( TBool )
IMPORT_C TInt	EnableKeyguard ( TBool )
IMPORT_C TBool	IsKeyguardEnabled ()
IMPORT_C TBool	IsKeylockEnabled ()
IMPORT_C CKeyguardAccessApi *	NewL ()
IMPORT_C TInt	OfferKeyguard ()
IMPORT_C TInt	ShowKeysLockedNote ()
IMPORT_C TInt	TestDestruct ()
IMPORT_C TInt	TestInternal ()
IMPORT_C TInt	TestPanicClient ()

Private Member Functions
	CKeyguardAccessApi ()
void	ConstructL ()

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()

void

ConstructL

(

)

[private]

Default constructor for performing 2nd stage construction

DisableKeyguard(TBool)

IMPORT_C TInt

DisableKeyguard

(

TBool

aWithNote

)

Disable keyguard. Only works if devicelock is not enabled.

Parameters

TBool aWithNote

should informing note be shown

EnableKeyguard(TBool)

IMPORT_C TInt

EnableKeyguard

(

TBool

aWithNote

)

Enable keyguard. Only works if devicelock is not enabled.

Parameters

TBool aWithNote

should informing note be shown

IsKeyguardEnabled()

IMPORT_C TBool

IsKeyguardEnabled

(

)

Has keyguard been activated.

IsKeylockEnabled()

IMPORT_C TBool

IsKeylockEnabled

(

)

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 TInt

OfferKeyguard

(

)

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

ShowKeysLockedNote()

IMPORT_C TInt

ShowKeysLockedNote

(

)

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

TestDestruct()

IMPORT_C TInt

TestDestruct

(

)

TestInternal()

IMPORT_C TInt

TestInternal

(

)

Test functions, return KErrNotSupported in release builds.

TestPanicClient()

IMPORT_C TInt

TestPanicClient

(

)

Member Data Documentation

RLockAccessExtension * iLockAccessExtension

RLockAccessExtension *

iLockAccessExtension

[private]