Collapse all Symbian^3 Product Developer Library

CSysapKeyHandlerPlugin Class Reference

class CSysapKeyHandlerPlugin : public CBase

CSysapKeyHandlerPlugin class. This class serves as an interface between SysAp and the plugins.

Since: S60 3.1

Inherits from

CSysapKeyHandlerPlugin
- CBase

Public Member Functions
	~CSysapKeyHandlerPlugin()
TKeyResponse	HandleKeyEventL(const TKeyEvent &, TEventCode)
CSysapKeyHandlerPlugin *	NewL(TUid, MSysapCallback *)
void	ProvideKeyEventsL(RArray< TKeyEvent > &)

Protected Member Functions
void	PostConstructL()
MSysapCallback *	SysapCallback()

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
MSysapCallback *	iCallback
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CSysapKeyHandlerPlugin()

~CSysapKeyHandlerPlugin

(

)

[inline, virtual]

Destructor

Member Functions Documentation

HandleKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse	HandleKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)	[pure virtual]

Handles key events

Since: S60 3.1

Parameters

const TKeyEvent & aKeyEvent	contains information about the key event
TEventCode aType	contains information about the type of the key event

NewL(TUid, MSysapCallback *)

CSysapKeyHandlerPlugin *	NewL	(	TUid	aUid,
			MSysapCallback *	aCallback
		)	[static, inline]

Description: Wraps ECom object instantitation. Will return the default interface implementation, which matches to given aUid.

Note: This is not a "normal" NewL method, since normally NewL methods are only defined for concrete classes. Note that also implementations of this interface provide NewL methods. They are the familiar NewL's, which create instance of classes.

Since: S60 3.1

Parameters

TUid aUid	Uid of the plugin to be instantiated
MSysapCallback * aCallback	pointer to object that will implement a callback interface. Cannot be NULL.

PostConstructL()

void

PostConstructL

(

)

[protected, inline, virtual]

An additional phase for derived class construction.

This method is called immediately after the plug-in has been loaded. Derived classes may overload this method, if they need to perform initializations that require usage of the callback pointer (obtained via SysapCallback()-function).

Since: S60 3.1

leave: system wide error code

CSysapKeyHandlerPlugin::SysapCallback

ProvideKeyEventsL(RArray< TKeyEvent > &)

void

ProvideKeyEventsL

(

RArray< TKeyEvent > &

aKeyEventArray

)

[inline, virtual]

Provides the key events that the plugin wants to listen to. Plugins should overload this method if they are of version 2 or higher. iCode, iScanCode and iModifiers MUST be defined in each TKeyEvent.

Since: S60 5.1

Parameters

RArray< TKeyEvent > & aKeyEventArray

SysapCallback()

MSysapCallback *

SysapCallback

(

)

[protected, inline]

Returns pointer to callback object.

Since: S60 3.1

Pre-condition: plug-in hase been loaded successfully

panic: KErrGeneral raised if method is called during construction. Place the initialization code that needs this function into PostConstructL().

CSysapKeyHandlerPlugin::PostConstructL

Member Data Documentation

MSysapCallback * iCallback

MSysapCallback *

iCallback

[private]

Pointer to callback object. Not own.

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

Instance identifier key. When instance of an implementation is created by ECOM framework, the framework will assign UID for it. The UID is used in destructor to notify framework that this instance is being destroyed and resources can be released.