![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
class RSoundPlugIn : public MWsClientClass;
Client interface to the key or pointer click plug-in DLL.
The plug-in DLL implements the CClickMaker
class.
MWsClientClass
- Base class for all classes whose objects are clients of the window server.
RSoundPlugIn
- Client interface to the key or pointer click plug-in DLL.
Defined in RSoundPlugIn
:
Close()
Sets the handle to zero and frees the resource owned by the server. CommandReply(TInt,const TPtrC8 &)
Sends a command to the plug-in DLL and may receive a response.Construct(TUid)
Second phase constructor.Destroy()
Closes (by calling RSoundPlugIn::Close()) and deletes the object. ESoundWrongPlugIn
The value returned by RSoundPlugIn::CommandReply(TInt,const TPtrC8 &) if no ...IsLoaded(TBool &)
Tests whether a key or pointer click plug-in DLL is currently loaded.KeyClickEnabled()
Tests whether key clicks are enabled, as set by RSoundPlugIn::SetKeyClick(TBool)...Load(const TDesC &)
Loads a new plug-in, replacing the existing one, if any.PenClickEnabled()
Tests whether pointer clicks are enabled, as set by RSoundPlugIn::SetPenClick(TB...RSoundPlugIn()
Default constructor. RSoundPlugIn(RWsSession &)
C++ constructor.Unload()
Unloads the plug-in if one is currently loaded and if it can be unloaded.anonymous
A possible return value for RSoundPlugIn::CommandReply(TInt,const TPtrC8 &)....Inherited from MWsClientClass
:
WsHandle()const
Gets the server side handle for the object.CClickMaker
Key or pointer click plug-in provider interface.IMPORT_C RSoundPlugIn(RWsSession &aWs);
C++ constructor.
After calling this function, RSoundPlugIn::Construct(TUid)
must be called to complete construction.
|
IMPORT_C TInt Construct(TUid aUid=TUid::Null());
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.
|
|
IMPORT_C void Close();
Sets the handle to zero and frees the resource owned by the server.
IMPORT_C void Destroy();
Closes (by calling RSoundPlugIn::Close()
) and deletes the object.
IMPORT_C TBool IsLoaded(TBool &aIsChangeable);
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.
|
|
Capability: | WriteDeviceData |
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.
|
Capability: | WriteDeviceData |
IMPORT_C TInt Load(const TDesC &aFileName);
Loads a new plug-in, replacing the existing one, if any.
This function always causes a flush of the window server buffer.
|
|
IMPORT_C TBool KeyClickEnabled();
Tests whether key clicks are enabled, as set by RSoundPlugIn::SetKeyClick(TBool)
.
This function always causes a flush of the window server buffer.
|
IMPORT_C TBool PenClickEnabled();
Tests whether pointer clicks are enabled, as set by RSoundPlugIn::SetPenClick(TBool)
.
This function always causes a flush of the window server buffer.
|
IMPORT_C TInt CommandReply(TInt aOpcode, const TPtrC8 &aArgs);
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.
|
|
n/a
A possible return value for RSoundPlugIn::CommandReply(TInt,const TPtrC8 &)
.
|