Client interface to the key or pointer click plug-in DLL. More...

#include <w32std.h>

Inheritance diagram for RSoundPlugIn:

Public Types
enum	{ ESoundWrongPlugIn =KMinTInt }
	A possible return value for CommandReply(). More...

Public Member Functions
IMPORT_C	RSoundPlugIn ()
	Default constructor.

IMPORT_C	RSoundPlugIn (RWsSession &aWs)
	C++ constructor.

IMPORT_C TInt	Construct (TUid aUid=KNullUid)
	Second phase constructor.

IMPORT_C void	Close ()
	Sets the handle to zero and frees the resource owned by the server.

IMPORT_C void	Destroy ()
	Closes (by calling Close()) and deletes the object.

IMPORT_C TBool	IsLoaded (TBool &aIsChangeable) const
	Tests whether a key or pointer click plug-in DLL is currently loaded.

IMPORT_C TInt	Unload ()
	Unloads the plug-in if one is currently loaded and if it can be unloaded.

IMPORT_C TInt	Load (const TDesC &aFileName)
	Loads a new plug-in, replacing the existing one, if any.

IMPORT_C void	SetKeyClick (TBool aEnabled)
	Sets whether key clicks should be enabled or disabled.

IMPORT_C void	SetPenClick (TBool aEnabled)
	Sets whether pointer clicks should be enabled or disabled.

IMPORT_C TBool	KeyClickEnabled () const
	Tests whether key clicks are enabled, as set by SetKeyClick().

IMPORT_C TBool	PenClickEnabled () const
	Tests whether pointer clicks are enabled, as set by SetPenClick().

IMPORT_C TInt	CommandReply (TInt aOpcode, const TPtrC8 &aArgs)
	Sends a command to the plug-in DLL and may receive a response.

Public Member Functions inherited from MWsClientClass
	MWsClientClass ()

	MWsClientClass (RWsBuffer *aBuffer)

TInt	WsHandle () const
	Gets the server side handle for the object.

Additional Inherited Members
Protected Member Functions inherited from MWsClientClass
void	Write (const TAny *aData1, TInt aLength1, TInt aLength2, TUint aOpcode) const

void	Write (const TAny aData, TInt aLength, const TAny aData2, TInt aLength2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

void	Write (const TAny aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs aIpcArgs=NULL) const

void	Write (TUint aOpcode) const

void	WriteInt (TInt aInt, TUint aOpcode) const

void	WriteRect (const TRect &aRect, TUint aOpcode) const

void	WritePoint (const TPoint &aPoint, TUint aOpcode) const

void	WriteSize (const TSize &aSize, TUint aOpcode) const

TInt	WriteReply (TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReplyInt (TInt aInt, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReply (const TAny aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs aIpcArgs=NULL) const

TInt	WriteReply (const TAny aBuf, TInt aBufLen, const TAny aBuf2, TInt aBuflen2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReplyP (const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyIntP (TInt aInt, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyP (const TAny *aBuf, TInt aBufLen, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyP (const TAny aBuf, TInt aBufLen, const TAny aBuf2, TInt aBuflen2, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyByProvidingRemoteReadAccess (const TAny *aBuf, TInt aBufLen, const TReadDescriptorType &aRemoteReadBuffer, TUint aOpcode) const

void	AddToBitmapArray (const TInt aBitmapHandle) const

void	AsyncRequest (TRequestStatus &aStatus, TUint aOpcode) const

TBool	WindowSizeCacheEnabled () const

void	MarkWindowSizeCacheDirty ()

void	RefreshWindowSizeCache (const TSize &aNewSize) const

TInt	CachedWindowSize (TSize &aSize) const

void	DestroyWindowSizeCacheEntry ()

Protected Attributes inherited from MWsClientClass
TInt32	iWsHandle
	WARNING: Member variable for internal use ONLY.

RWsBuffer *	iBuffer
	WARNING: Member variable for internal use ONLY.

Detailed Description

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

The plug-in DLL implements the CClickMaker class.

See also: CClickMaker

API status: Published to all clients. Released API.

Definition at line 2784 of file w32std.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

A possible return value for CommandReply().

Enumerator

ESoundWrongPlugIn

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.

Definition at line 2798 of file w32std.h.

Constructor & Destructor Documentation

◆ RSoundPlugIn() [1/2]

IMPORT_C RSoundPlugIn::RSoundPlugIn ( )

Default constructor.

(generated from Symbian Developer Library)

◆ RSoundPlugIn() [2/2]

IMPORT_C RSoundPlugIn::RSoundPlugIn ( RWsSession & aWs )

C++ constructor.

After calling this function, Construct() must be called to complete construction.

Parameters

aWs	Connected session with the window server.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Close()

IMPORT_C void RSoundPlugIn::Close ( )

Sets the handle to zero and frees the resource owned by the server.

(generated from Symbian Developer Library)

◆ CommandReply()

IMPORT_C TInt RSoundPlugIn::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.

Parameters

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.

(generated from Symbian Developer Library)

◆ Construct()

IMPORT_C TInt RSoundPlugIn::Construct ( TUid aUid = KNullUid )

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.

Parameters

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.

Panic condition: TW32Panic 17 in debug builds if called on an already constructed object.

(generated from Symbian Developer Library)

◆ Destroy()

IMPORT_C void RSoundPlugIn::Destroy ( )

Closes (by calling Close()) and deletes the object.

(generated from Symbian Developer Library)

◆ IsLoaded()

IMPORT_C TBool RSoundPlugIn::IsLoaded ( TBool & aIsChangeable ) const

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.

Parameters

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.

(generated from Symbian Developer Library)

◆ KeyClickEnabled()

IMPORT_C TBool RSoundPlugIn::KeyClickEnabled ( ) const

Tests whether key clicks are enabled, as set by SetKeyClick().

This function always causes a flush of the window server buffer.

(generated from Symbian Developer Library)

◆ Load()

IMPORT_C TInt RSoundPlugIn::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.

Parameters

aFileName The filename of the plug-in DLL to load.

capability: WriteDeviceData

(generated from Symbian Developer Library)

◆ PenClickEnabled()

IMPORT_C TBool RSoundPlugIn::PenClickEnabled ( ) const

Tests whether pointer clicks are enabled, as set by SetPenClick().

This function always causes a flush of the window server buffer.

(generated from Symbian Developer Library)

◆ SetKeyClick()

IMPORT_C void RSoundPlugIn::SetKeyClick ( TBool aEnabled )

Sets whether key clicks should be enabled or disabled.

By default, key clicks are enabled.

Parameters

aEnabled ETrue to enable key clicks, EFalse to disable them.

capability: WriteDeviceData

(generated from Symbian Developer Library)

◆ SetPenClick()

IMPORT_C void RSoundPlugIn::SetPenClick ( TBool aEnabled )

Sets whether pointer clicks should be enabled or disabled.

By default, pointer clicks are enabled.

Parameters

aEnabled ETrue to enable pointer clicks, EFalse to disable them.

capability: WriteDeviceData

(generated from Symbian Developer Library)

◆ Unload()

IMPORT_C TInt RSoundPlugIn::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

(generated from Symbian Developer Library)

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ RSoundPlugIn() [1/2]

◆ RSoundPlugIn() [2/2]

Member Function Documentation

◆ Close()

◆ CommandReply()

◆ Construct()

◆ Destroy()

◆ IsLoaded()

◆ KeyClickEnabled()

◆ Load()

◆ PenClickEnabled()

◆ SetKeyClick()

◆ SetPenClick()

◆ Unload()