sl@0: // Copyright (c) 2005-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: // Utility class for indexing instances of CWsGraphicDrawer
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __WSGRAPHICDRAWERARRAY_H__
sl@0: #define __WSGRAPHICDRAWERARRAY_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <graphics/wsgraphicdrawer.h>
sl@0: 
sl@0: class CWsGraphicDrawerArray: public CBase
sl@0: /** An index of CWsGraphicDrawer instances
sl@0: A CWsGraphicDrawer can be in many such indexes, as an index does not imply ownership
sl@0: @publishedPartner
sl@0: @released
sl@0: */	{
sl@0: public:
sl@0: 	//Placeholder for transacion record
sl@0: 	struct XRollBackBase;
sl@0: 	
sl@0: 	//transactional manipulation methods that are deprecated because they leak 
sl@0: 	IMPORT_C void AddLC(CWsGraphicDrawer* aDrawer);
sl@0: 	IMPORT_C TInt SwapLC(CWsGraphicDrawer* aDrawer);
sl@0: 	
sl@0: 	//non-transactional manipulation
sl@0: 	IMPORT_C TInt Remove(const TGraphicDrawerId& aId);
sl@0: 	IMPORT_C TInt Add(CWsGraphicDrawer* aDrawer);
sl@0: 	IMPORT_C TInt Swap(CWsGraphicDrawer* aDrawer);
sl@0: 	
sl@0: 	//safe transactional methods
sl@0: 	//The array should not be Compressed() during the transaction period to ensure that the Remove RollBack operation will always succeed.
sl@0: 	IMPORT_C XRollBackBase* AddTLC(CWsGraphicDrawer* aDrawer);
sl@0: 	IMPORT_C XRollBackBase* SwapTLC(CWsGraphicDrawer* aDrawer);
sl@0: 	IMPORT_C XRollBackBase* RemoveTLC(const TGraphicDrawerId& aId);
sl@0: 	IMPORT_C void CommitP(XRollBackBase*);
sl@0: 
sl@0: 	//Query
sl@0: 	IMPORT_C const CWsGraphicDrawer* ResolveGraphic(const TGraphicDrawerId& aId) const;
sl@0: 	IMPORT_C TBool IsEmpty() const;
sl@0: 
sl@0: 	//Other non-transactional methods
sl@0: 	IMPORT_C TInt RemoveAndDestroy(const TGraphicDrawerId& aId);
sl@0: 	IMPORT_C TInt RemoveAll(const MWsClient& aOwner);
sl@0: 	IMPORT_C TInt RemoveAndDestroyAll(const MWsClient& aOwner);
sl@0: 	IMPORT_C void Close();
sl@0: 	IMPORT_C void ResetAndDestroy();
sl@0: private:
sl@0: 	NONSHARABLE_STRUCT(TGraphic)
sl@0: 		{
sl@0: 		TGraphicDrawerId iId;
sl@0: 		CWsGraphicDrawer* iDrawer;
sl@0: 		};
sl@0: 	RArray<TGraphic> iArray;
sl@0: 	CWsGraphicDrawer* SwapIn(CWsGraphicDrawer* aDrawer);
sl@0: 	TInt IndexOf(const TGraphicDrawerId& aId) const;
sl@0: 	static TInt GraphicDrawerCompare(const TGraphic& aFirst,const TGraphic& aSecond);
sl@0: private:
sl@0: 	//Transactional unwinding support classes
sl@0: 	class XAddRollBack;
sl@0: 	friend class XAddRollBack;
sl@0: 	class XSwapRollBack;
sl@0: 	friend class XSwapRollBack;
sl@0: 	class XRemoveRollBack;
sl@0: 	friend class XRemoveRollBack;
sl@0: 	class testArrayValidator;
sl@0: 	friend class testArrayValidator;
sl@0: 	};
sl@0: 
sl@0: #endif //#ifndef __WSGRAPHICDRAWERARRAY_H__