sl@0: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Client side interface to the plugin
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include "../SERVER/w32cmd.h"
sl@0: #include "CLIENT.H"
sl@0: 
sl@0: EXPORT_C RSoundPlugIn::RSoundPlugIn()
sl@0: /** Default constructor. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RSoundPlugIn::RSoundPlugIn(RWsSession& aWs) : MWsClientClass(aWs.iBuffer)
sl@0: /** C++ constructor. 
sl@0: 
sl@0: After calling this function, Construct() must be called to complete construction.
sl@0: 
sl@0: @param aWs Connected session with the window server. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt RSoundPlugIn::Construct(TUid aUid)
sl@0: /** Second phase constructor. 
sl@0: 
sl@0: Creates the server side resource and initialises the client's handle to it. 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aUid Optional UID. This can be ignored unless you intend to use the CommandReply() 
sl@0: function. If you do intend to use CommandReply(), this should be the plug-in DLL's third 
sl@0: UID. CommandReply() will return the value ESoundWrongPlugIn if the plug-in DLL identified 
sl@0: by this UID is not loaded.
sl@0: @return KErrNone if the function was successful, otherwise one of the system wide error 
sl@0: codes. 
sl@0: @panic TW32Panic 17 in debug builds if called on an already constructed object.*/
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iWsHandle == KNullHandle, Panic(EW32PanicGraphicDoubleConstruction));
sl@0: 	TInt ret;
sl@0: 	if ((ret=iBuffer->WriteReplyWs(&aUid,sizeof(aUid),EWsClOpCreateClick))>=0)
sl@0: 		{
sl@0: 		iWsHandle=ret;
sl@0: 		ret=KErrNone;
sl@0: 		}
sl@0: 	return(ret);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RSoundPlugIn::Close()
sl@0: /** Sets the handle to zero and frees the resource owned by the server. */
sl@0: 	{
sl@0: 	if (iBuffer && iWsHandle)
sl@0: 		Write(EWsClickOpFree);
sl@0: 	iWsHandle=NULL;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RSoundPlugIn::Destroy()
sl@0: /** Closes (by calling Close()) and deletes the object. */
sl@0: 	{
sl@0: 	Close();
sl@0: 	delete this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RSoundPlugIn::IsLoaded(TBool& aIsChangeAble) const
sl@0: /** Tests whether a key or pointer click plug-in DLL is currently loaded. 
sl@0: 
sl@0: If one is currently loaded, aIsChangeAble returns whether or not 
sl@0: it can be unloaded. 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aIsChangeAble If a plug-in is currently loaded, this returns ETrue if it 
sl@0: can be unloaded and EFalse if it cannot. This depends on whether the 
sl@0: KEYCLICKPLUGINFIXED keyword is specified in wsini.ini for the plug-in.
sl@0: @return ETrue if a plug-in is currently loaded, EFalse if not. */
sl@0: 	{
sl@0: 	TUint reply=WriteReply(EWsClickOpIsLoaded);
sl@0: 	aIsChangeAble=reply&EClickLoadable;
sl@0: 	return reply&EClickLoaded;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RSoundPlugIn::Unload()
sl@0: /** Unloads the plug-in if one is currently loaded and if it can be unloaded. 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @return KErrNone if the function was successful, KErrNotSupported if it could 
sl@0: not be unloaded.
sl@0: @capability WriteDeviceData */
sl@0: 	{
sl@0: 	return WriteReply(EWsClickOpUnLoad);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RSoundPlugIn::Load(const TDesC& aFileName)
sl@0: /** Loads a new plug-in, replacing the existing one, if any. 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aFileName The filename of the plug-in DLL to load.
sl@0: @return KErrNone if the function was successful. KErrNotSupported if the currently 
sl@0: loaded plug-in could not be unloaded.
sl@0: @capability WriteDeviceData */
sl@0: 	{
sl@0: 	TInt length=aFileName.Length();
sl@0: 	return WriteReply(&length,sizeof(length),aFileName.Ptr(),aFileName.Size(),EWsClickOpLoad);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RSoundPlugIn::SetPenClick(TBool aEnabled)
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Sets whether pointer clicks should be enabled or disabled.
sl@0: 
sl@0: By default, pointer clicks are enabled. 
sl@0: 
sl@0: @param aEnabled ETrue to enable pointer clicks, EFalse to disable them.
sl@0: @capability WriteDeviceData */
sl@0: 	{
sl@0: 	WriteInt(aEnabled,EWsClickOpSetPenClick);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RSoundPlugIn::SetKeyClick(TBool aEnabled)
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Sets whether key clicks should be enabled or disabled.
sl@0: 
sl@0: By default, key clicks are enabled. 
sl@0: 
sl@0: @param aEnabled ETrue to enable key clicks, EFalse to disable them. 
sl@0: @capability WriteDeviceData */
sl@0: 	{
sl@0: 	WriteInt(aEnabled,EWsClickOpSetKeyClick);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RSoundPlugIn::PenClickEnabled() const
sl@0: /** Tests whether pointer clicks are enabled, as set by SetPenClick(). 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @return ETrue if pointer clicks are enabled, EFalse if they are disabled. */
sl@0: 	{
sl@0: 	return WriteReply(EWsClickOpPenClickEnabled);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RSoundPlugIn::KeyClickEnabled() const
sl@0: /** Tests whether key clicks are enabled, as set by SetKeyClick(). 
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @return ETrue if key clicks are enabled, EFalse if they are disabled. */
sl@0: 	{
sl@0: 	return WriteReply(EWsClickOpKeyClickEnabled);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RSoundPlugIn::CommandReply(TInt aOpcode, const TPtrC8& aArgs)
sl@0: /** Sends a command to the plug-in DLL and may receive a response.
sl@0: 
sl@0: If the correct plug-in is loaded, its implementation of  CommandReplyL() 
sl@0: is called and its return code is returned by this function.
sl@0: 
sl@0: Specify an opcode of zero if you just want the identity of the plug-in DLL 
sl@0: being used.
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aOpcode Opcode understood by both the window server client and the 
sl@0: plug-in DLL. If an opcode of zero is specified, this is intercepted by the 
sl@0: window server, and the third UID of the plug-in is returned. This allows 
sl@0: the caller to identify the plug-in DLL being used.
sl@0: @param aArgs Packaged arguments which are passed to the plug-in via the window 
sl@0: server. 
sl@0: @return KErrNone or another of the system error codes, as returned by the 
sl@0: plug-in's CommandReplyL() implementation. ESoundWrongPlugIn is returned if no 
sl@0: plug-in is loaded, or if the plug-in identified by the aUid parameter in Construct() 
sl@0: is not loaded. */
sl@0: 	{
sl@0: 	return WriteReply(&aOpcode,sizeof(aOpcode),aArgs.Ptr(),aArgs.Length(),EWsClickOpCommandReply);
sl@0: 	}
sl@0: