Collapse all Symbian^3 Application Developer Library

CRemoteLockSettings Class Reference

class CRemoteLockSettings : public CBase

Interface for handling remote lock settings

rlocksettings.lib

Since: S60 3.2

Inherits from

CRemoteLockSettings
- CBase

Public Member Functions
	~CRemoteLockSettings ()
IMPORT_C TBool	CompareLockCodesL (const TDesC &, const TDesC &)
IMPORT_C TBool	GetEnabled ( TBool &)
IMPORT_C TBool	GetLockCode ( TDes &)
IMPORT_C TBool	GetLockCode ( TDes &, TDes &)
IMPORT_C CRemoteLockSettings *	NewL ( MRemoteLockSettingsHandler *)
IMPORT_C CRemoteLockSettings *	NewLC ( MRemoteLockSettingsHandler *)
IMPORT_C TBool	RemoteLockNotifyL (const TBool )
IMPORT_C TBool	SetDisabled ()
IMPORT_C TBool	SetEnabledL (const TDesC &)

Private Member Functions
	CRemoteLockSettings ( MRemoteLockSettingsHandler *)
void	ConstructL ()
void	HandleNotifyGeneric ( TUint32 )

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
MRemoteLockSettingsHandler *	iHandler
CCenRepNotifyHandler *	iNotifyHandler
CRepository *	iSession

Constructor & Destructor Documentation

CRemoteLockSettings(MRemoteLockSettingsHandler *)

CRemoteLockSettings

(

MRemoteLockSettingsHandler *

aHandler

)

[private]

Constructor.

Since: S60 3.2

Parameters

MRemoteLockSettingsHandler * aHandler

Client implemented notification handler that will be called when remote lock settings are changed.

~CRemoteLockSettings()

IMPORT_C

~CRemoteLockSettings

(

)

[virtual]

Member Functions Documentation

CompareLockCodesL(const TDesC &, const TDesC &)

IMPORT_C TBool	CompareLockCodesL	(	const TDesC &	aLockCode,
			const TDesC &	aCorrectLockCode
		)	const

Compares two remote lock codes.

Since: S60 3.2

Parameters

const TDesC & aLockCode	The lock code to compare. This should be in plain format.
const TDesC & aCorrectLockCode	The correct lock code to compare against. This should be the one retrieved using GetLockCode(), and thus is not in plain format.

ConstructL()

void

ConstructL

(

)

[private]

2nd phase constructor.

GetEnabled(TBool &)

IMPORT_C TBool

GetEnabled

(

TBool &

aEnabled

)

const

Gets the current remote lock status.

Since: S60 3.2

Parameters

TBool & aEnabled

For retrieving the current remote lock status.

GetLockCode(TDes &)

IMPORT_C TBool

GetLockCode

(

TDes &

aLockCode

)

const

Gets the remote lock code. Note that the retrieved remote lock code is not in plain format.

Since: S60 3.2

Parameters

TDes & aLockCode

For retrieving the remote lock code. The length must be at least KRLStoredLockCodeLength.

GetLockCode(TDes &, TDes &)

IMPORT_C TBool	GetLockCode	(	TDes &	aLockCode,
			TDes &	aLockCodeTrimmed
		)	const

Gets the remote lock code. Note that the retrieved remote lock code is not in plain format.

Since: S60 3.2

Parameters

TDes & aLockCode	For retrieving the remote lock code. The length must be at least KRLStoredLockCodeLength.
TDes & aLockCodeTrimmed	For retrieving the remote lock code. The length must be at least KRLStoredLockCodeLength. Same as aLockCode, but formatted differently before storing: leading and trailing space characters removed, multiple spaces replaced with single space.

HandleNotifyGeneric(TUint32)

void

HandleNotifyGeneric

(

TUint32

aId

)

[private]

From MCenRepNotifyHandler Notify handler.

Parameters

TUint32 aId

NewL(MRemoteLockSettingsHandler *)

IMPORT_C CRemoteLockSettings *

NewL

(

MRemoteLockSettingsHandler *

aHandler = NULL

)

[static]

Two-Phased constructor

Since: S60 3.2

Parameters

MRemoteLockSettingsHandler * aHandler = NULL

Client implemented notification handler that will be called when remote lock settings are changed. If the client doesn't need notification, then no parameter needed.

NewLC(MRemoteLockSettingsHandler *)

IMPORT_C CRemoteLockSettings *

NewLC

(

MRemoteLockSettingsHandler *

aHandler = NULL

)

[static]

Two-Phased constructor

Since: S60 3.2

Parameters

MRemoteLockSettingsHandler * aHandler = NULL

Client implemented notification handler that will be called when remote lock settings are changed. If the client doesn't need notification, then no parameter needed.

RemoteLockNotifyL(const TBool)

IMPORT_C TBool

RemoteLockNotifyL

(

const TBool

aNotifyEnable

)

Enables or disables remote lock settings notification. If the settings are changed, the notification handler given in NewL() or NewLC() will be called.

Since: S60 3.2

Parameters

const TBool aNotifyEnable

For enabling or disabling the remote lock settings notification.

SetDisabled()

IMPORT_C TBool

SetDisabled

(

)

Disables remote lock.

Since: S60 3.2

SetEnabledL(const TDesC &)

IMPORT_C TBool

SetEnabledL

(

const TDesC &

aLockCode

)

Enables remote lock and stores the correct remote lock code.

Since: S60 3.2

Parameters

const TDesC & aLockCode

New remote lock code.

Member Data Documentation

MRemoteLockSettingsHandler * iHandler

MRemoteLockSettingsHandler *

iHandler

[private]

CCenRepNotifyHandler * iNotifyHandler

CCenRepNotifyHandler *

iNotifyHandler

[private]

CRepository * iSession

CRepository *

iSession

[private]