windowing/windowserver/nga/CLIENT/rtfxeffect.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 31 Aug 2010 16:31:06 +0300
branchRCL_3
changeset 163 bbf46f59e123
permissions -rw-r--r--
Revision: 201029 Kit: 201035

// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description: Wserv client side local header file.
//


#if !defined(__RTFXEFFECTS_H__)
#define __RTFXEFFECTS_H__

#include <w32std.h>
#include "../SERVER/w32cmd.h"

/** 
Class is used for passing data sent to TFX APIs RegisterEffect and OverrideEffect
from client to server of wserv. Another purpose of this class is to avoid code 
duplication, when these APIs are called from RWsSession and RWindowBase.
*/
class RTFXEffect : public MWsClientClass
	{
public:
	/**
	TFXEffect Enum is used to distinguish when OverrideEffect API is called from 
	Session class or Window class. 
	*/
	enum TFXEffect
		{
		ENone,
		/**
		Used in OverrideTFXEffect() when called from RWsSession
		*/
		ETFXSession,
		/**
		Used in OverrideTFXEffect() when called from RWindowBase
		*/
		ETFXWindow
		};
	RTFXEffect(TInt aHandle, RWsBuffer* aBuffer);
	void CheckFileNameAndSetSizes(const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming);
	void RegisterTFXEffect(TInt aAction, TInt aPurpose, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TUint aAppUid=0, TBitFlags aFlags=0);
	void OverrideTFXEffect(TFXEffect aCalledFrom, TInt aAction, TInt aPurpose, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TBitFlags aFlags=0);
	void AppendFileNameData(const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming);
	void WriteDataUsingIPC(TWsClCmdRegisterEffect* aForRegister, TWsClCmdOverrideEffect* aForOverride, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TFXEffect aCalledFrom);
	TBool CheckCombinedSizeWithCurrentBuffer(TInt aSize) const;
	
private:
	TInt iDirPathSizePaded;
	TInt iFileName1SizePaded;
	TInt iFileName2SizePaded;
	TInt iCombSizePaded;
	};

#endif