#include <w32std.h>
| class RSoundPlugIn : public MWsClientClass |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { ESoundWrongPlugIn } |
| Public Member Functions | |
|---|---|
| RSoundPlugIn() | |
| RSoundPlugIn(RWsSession &) | |
| IMPORT_C void | Close() |
| IMPORT_C TInt | CommandReply(TInt, const TPtrC8 &) |
| IMPORT_C TInt | Construct(TUid) |
| IMPORT_C void | Destroy() |
| IMPORT_C TBool | IsLoaded(TBool &) |
| IMPORT_C TBool | KeyClickEnabled() |
| IMPORT_C TInt | Load(const TDesC &) |
| IMPORT_C TBool | PenClickEnabled() |
| IMPORT_C void | SetKeyClick(TBool) |
| IMPORT_C void | SetPenClick(TBool) |
| IMPORT_C TInt | Unload() |
| Inherited Attributes | |
|---|---|
| MWsClientClass::iBuffer | |
| MWsClientClass::iWsHandle | |
Client interface to the key or pointer click plug-in DLL.
The plug-in DLL implements the CClickMaker class.
See also: CClickMaker
A possible return value for CommandReply().
| Enumerator | Value | Description |
|---|---|---|
| ESoundWrongPlugIn | KMinTInt |
The value returned by CommandReply() if no plug-in is loaded, or if the plug-in identified by the aUid parameter in Construct() is not loaded. Its value is set to KMinTInt so that it should not clash with any other expected return value from this function. |
| IMPORT_C | RSoundPlugIn | ( | RWsSession & | aWs | ) |
C++ constructor.
After calling this function, Construct() must be called to complete construction.
| Parameter | Description |
|---|---|
| aWs | Connected session with the window server. |
Sends a command to the plug-in DLL and may receive a response.
If the correct plug-in is loaded, its implementation of CommandReplyL() is called and its return code is returned by this function.
Specify an opcode of zero if you just want the identity of the plug-in DLL being used.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aOpcode | Opcode understood by both the window server client and the plug-in DLL. If an opcode of zero is specified, this is intercepted by the window server, and the third UID of the plug-in is returned. This allows the caller to identify the plug-in DLL being used. |
| aArgs | Packaged arguments which are passed to the plug-in via the window server. |
Returns: KErrNone or another of the system error codes, as returned by the plug-in's CommandReplyL() implementation. ESoundWrongPlugIn is returned if no plug-in is loaded, or if the plug-in identified by the aUid parameter in Construct() is not loaded.
Second phase constructor.
Creates the server side resource and initialises the client's handle to it.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aUid | Optional UID. This can be ignored unless you intend to use the CommandReply() function. If you do intend to use CommandReply(), this should be the plug-in DLL's third UID. CommandReply() will return the value ESoundWrongPlugIn if the plug-in DLL identified by this UID is not loaded. |
Returns: KErrNone if the function was successful, otherwise one of the system wide error codes.
Tests whether a key or pointer click plug-in DLL is currently loaded.
If one is currently loaded, aIsChangeAble returns whether or not it can be unloaded.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aIsChangeable | If a plug-in is currently loaded, this returns ETrue if it can be unloaded and EFalse if it cannot. This depends on whether the KEYCLICKPLUGINFIXED keyword is specified in wsini.ini for the plug-in. |
Returns: ETrue if a plug-in is currently loaded, EFalse if not.
| IMPORT_C TBool | KeyClickEnabled | ( | ) | const |
Tests whether key clicks are enabled, as set by SetKeyClick().
This function always causes a flush of the window server buffer.
Returns: ETrue if key clicks are enabled, EFalse if they are disabled.
Loads a new plug-in, replacing the existing one, if any.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aFileName | The filename of the plug-in DLL to load. |
Returns: KErrNone if the function was successful. KErrNotSupported if the currently loaded plug-in could not be unloaded or aFileName does not refer to a loadable plug-in.
| IMPORT_C TBool | PenClickEnabled | ( | ) | const |
Tests whether pointer clicks are enabled, as set by SetPenClick().
This function always causes a flush of the window server buffer.
Returns: ETrue if pointer clicks are enabled, EFalse if they are disabled.
| IMPORT_C void | SetKeyClick | ( | TBool | aEnabled | ) |
Sets whether key clicks should be enabled or disabled.
By default, key clicks are enabled.
| Parameter | Description |
|---|---|
| aEnabled | ETrue to enable key clicks, EFalse to disable them. |
| IMPORT_C void | SetPenClick | ( | TBool | aEnabled | ) |
Sets whether pointer clicks should be enabled or disabled.
By default, pointer clicks are enabled.
| Parameter | Description |
|---|---|
| aEnabled | ETrue to enable pointer clicks, EFalse to disable them. |
| IMPORT_C TInt | Unload | ( | ) |
Unloads the plug-in if one is currently loaded and if it can be unloaded.
This function always causes a flush of the window server buffer.
Returns: KErrNone if the function was successful, KErrNotSupported if it could not be unloaded.