Collapse all Symbian^3 Application Developer Library

MSysapCallback Class Reference

class MSysapCallback

An interface for controlling System Application and querying information from it.

This interface is intended for plug-ins that run in the System Application process. Plug-ins can execute commands to be performed by the System Application and also query information from the System Application.

None

Since: S60 3.1

Public Member Functions
void	ExecCommandL ( TSysapCommand )
void	ExecCommandL ( TSysapCommand , const TDesC8 &)
void	ExecQueryL ( TSysapQuery , TDes8 &)
void	ExecQueryL ( TSysapQuery , TDes8 &, const TDesC8 &)

Public Member Enumerations
enum	TSysapCommand { EResetKeyguardState , ECancelPowermenu , EUpdateLights }
enum	TSysapQuery { EGetHwrmLight , EGetKeylock }

Member Functions Documentation

ExecCommandL(TSysapCommand)

void

ExecCommandL

(

TSysapCommand

aCommand

)

[pure virtual]

Executes a command in SysAp.

Since: S60 3.1

leave: a system wide error code

MSysapCallback::TSysapCommand

Parameters

TSysapCommand aCommand

command identifier

ExecCommandL(TSysapCommand, const TDesC8 &)

void	ExecCommandL	(	TSysapCommand	aCommand,
			const TDesC8 &	aParam
		)	[pure virtual]

Executes a command in SysAp.

Since: S60 3.1

leave: a system wide error code

MSysapCallback::TSysapCommand

Parameters

TSysapCommand aCommand	command identifier
const TDesC8 & aParam	command specific parameter data

ExecQueryL(TSysapQuery, TDes8 &)

void	ExecQueryL	(	TSysapQuery	aQuery,
			TDes8 &	aReturn
		)	[pure virtual]

Queries information from SysAp.

Since: S60 3.1

leave: a system wide error code

MSysapCallback::TSysapQuery

Parameters

TSysapQuery aQuery	query identifier
TDes8 & aReturn	query specific return data

ExecQueryL(TSysapQuery, TDes8 &, const TDesC8 &)

void	ExecQueryL	(	TSysapQuery	aQuery,
			TDes8 &	aReturn,
			const TDesC8 &	aParam
		)	[pure virtual]

Queries information from SysAp.

Since: S60 3.1

leave: a system wide error code

MSysapCallback::TSysapQuery

Parameters

TSysapQuery aQuery	query identifier
TDes8 & aReturn	query specific return data
const TDesC8 & aParam	query specific parameter data

Member Enumerations Documentation

Enum TSysapCommand

Sysap command identifiers.

MSysapCallback::ExecCommandL

Enumerators

EResetKeyguardState

ECancelPowermenu

EUpdateLights

Updates the light state if necessary.

The key event code due to which update takes place is passed as a parameter, so that SysAp can perform key event specific light handling. Note that calling this method does not necessarily trigger any light related actions, if there is no key specific light handling implemented in SysAp.

Enum TSysapQuery

Sysap query identifiers.

MSysapCallback::ExecQueryL

Enumerators

EGetHwrmLight
EGetKeylock