Collapse all Symbian^3 Application Developer Library

CClickMaker Class Reference

class CClickMaker : public CBase

Key or pointer click plug-in provider interface.

This class should be implemented by a plug-in DLL in order to produce a sound when a key is pressed, a key auto repeats or when the screen is tapped with a pointer. When any of these events occur, the window server informs the plug-in DLL, which can then make the sound.

The details of the event are also passed to the plug-in so that the sound can be tailored to the precise event, for example clicking on different keys on the keypad or on different parts of the screen could make different sounds.

The name of the initial plug-in to use can be specified in the wsini.ini configuration file using the KEYCLICKPLUGIN or KEYCLICKPLUGINFIXED keywords. When the operating system boots, wsini.ini is read for the name of this plug-in. If a plug-in name exists, the window server will try to load it. At a later time, any client of the window server can request a new plug-in to be loaded or the current one to be unloaded, using the RSoundPlugIn class.

The plug-in is a polymorphic DLL which implements the CClickMaker interface. Its first UID is KDynamicLibraryUidValue and its second UID is 0x10004F63. Its first exported function should create an object of the CClickMaker sub-class and should have the following signature:

EXPORT_C CClickMaker* CreateClickMakerL()

RSoundPlugIn

Inherits from

CClickMaker
- CBase

Public Member Functions
TInt	CommandReplyL ( TInt , TAny *)
void	KeyEvent ( TEventCode , const TKeyEvent &)
void	OtherEvent ( TInt , TAny *)
void	PointerEvent (const TPointerEvent &)

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

Member Functions Documentation

CommandReplyL(TInt, TAny *)

TInt	CommandReplyL	(	TInt	aOpcode,
			TAny *	aArgs
		)	[pure virtual]

This function may be implemented by the key or pointer click plug-in to enable the plug-in to communicate with the window server client.

If this is not required, the implementation may simply return zero.

It is called by RSoundPlugIn::CommandReply() which returns the value returned by this function.

The return value can be generated either by returning it from the function or by leaving with the value. In either case, the client will get back the value concerned.

Parameters

TInt aOpcode	Opcode understood by both the window server client and the plug-in DLL.
TAny * aArgs	Arguments packaged by the window server client.

KeyEvent(TEventCode, const TKeyEvent &)

void	KeyEvent	(	TEventCode	aType,
			const TKeyEvent &	aEvent
		)	[pure virtual]

This function is called by the window server whenever there is a key event, to generate the sound.

It must be implemented by the key or pointer click plug-in.

If the sound cannot be made, the function should continue without leaving.

Parameters

TEventCode aType	The type of key event: EEventKey, EEventKeyUp, EEventKeyDown or EEventKeyRepeat.
const TKeyEvent & aEvent	The key event details.

OtherEvent(TInt, TAny *)

void	OtherEvent	(	TInt	aType,
			TAny *	aParam = NULL
		)	[pure virtual]

This function is intended for future expansion of the interface, in case it needs to support sounds for other types of event.

Currently it is called by the window server, with several values for aType. For each of these aParam will need to be cast to a different class type to get the data: EEventPointer: cast to TPointerEventData* EEventScreenDeviceChanged: TClickMakerData* EEventGroupWindowOpen: TGroupWindowOpenData* EEventGroupWindowClose: TInt (the identifier of the window group being closed) EEventWindowClose: TWindowCloseData*

Parameters

TInt aType	One of the above listed values, in future may be used with other values.
TAny * aParam = NULL	See above.

PointerEvent(const TPointerEvent &)

void

PointerEvent

(

const TPointerEvent &

aEvent

)

[pure virtual]

This function is called by the window server whenever there is a pointer event, to generate the sound.

It must be implemented by the key or pointer click plug-in.

If the sound cannot be made, the function should continue without leaving.

The iParentPosition data member of aEvent is not the position of the pointer event relative to origin of the parent window. Instead it is the position on the screen. This is because the parent window has no meaning inside the plug-in as it does to the window server client and also knowledge of the screen position may be useful to the plug-in.

On devices where these features are supported, aEvent will contain pointer number, proximity of the pointer to the screen and/or pressure applied by the pointer to the screen. In order to retrieve this information, implementation of this method should use TPointerEvent::AdvancedPointerEvent() .

TPointerEvent::AdvancedPointerEvent()

Parameters

const TPointerEvent & aEvent

The pointer event details.