Class CClickMaker

class CClickMaker : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CClickMaker - Key or pointer click plug-in provider interface.

Members

Defined in CClickMaker:

• CommandReplyL(TInt,TAny *)This function may be implemented by the key or pointer click plug-in to enable t...
• KeyEvent(TEventCode,const TKeyEvent &)This function is called by the window server whenever there is a key event, to g...
• OtherEvent(TInt,TAny *)This function is intended for future expansion of the interface, in case it need...
• PointerEvent(const TPointerEvent &)This function is called by the window server whenever there is a pointer event, ...

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• RSoundPlugInClient interface to the key or pointer click plug-in DLL.

virtual void KeyEvent(TEventCode aType, const TKeyEvent &aEvent)=0;

Description

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.

virtual void PointerEvent(const TPointerEvent &aEvent)=0;

Description

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.

Parameters

const TPointerEvent &aEvent The pointer event details.

virtual void OtherEvent(TInt aType, TAny *aParam=0)=0;

Description

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 See above.

virtual TInt CommandReplyL(TInt aOpcode, TAny *aArgs)=0;

Description

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(TInt,const TPtrC8 &) 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.

Return value

TInt A value passed back to the client. This may be KErrNone or another of the system-wide error codes.