sl@0: // Copyright (c) 2006-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: //
sl@0: 
sl@0: #if !defined(__WINDOWELEMENTSET_H__)
sl@0: #define __WINDOWELEMENTSET_H__
sl@0: 
sl@0: /**
sl@0: @file
sl@0: @internalComponent
sl@0: */
sl@0: 
sl@0: #include <graphics/wselement.h>
sl@0: 
sl@0: class CBase;
sl@0: class CWsClientWindow;
sl@0: class TSurfaceConfiguration;
sl@0: class MWsScene;
sl@0: 
sl@0: class TAttributes
sl@0: {
sl@0: public:
sl@0: 	TAttributes(){iFlags = 0;}
sl@0: 	enum
sl@0: 	{
sl@0: 	EConcealed			= 0x00000001,
sl@0: 	EDrawnOver			= 0x00000002,
sl@0: 	EDrawnOverLast		= 0x01000000,
sl@0: 	};
sl@0: 	//flag accessors
sl@0: 	inline TBool Concealed() const {return iFlags&EConcealed;}
sl@0: 	inline void SetConcealed(TBool aSetting = ETrue) {aSetting?iFlags|=EConcealed:iFlags&=~EConcealed;}
sl@0: 	inline TBool DrawnOver() const {return iFlags&EDrawnOver;}
sl@0: 	inline void SetDrawnOver(TBool aSetting = ETrue) {aSetting?iFlags|=EDrawnOver:iFlags&=~EDrawnOver;}
sl@0: 	inline TBool DrawnOverLast() const {return iFlags&EDrawnOverLast;}
sl@0: 	inline void SetDrawnOverLast(TBool aSetting = ETrue) 
sl@0: 		{	iFlags= aSetting? iFlags|EDrawnOverLast:iFlags&~EDrawnOverLast;	}
sl@0: 	inline TInt Flags()const
sl@0: 		{	return iFlags;	}
sl@0: 	TBool Destroy(MWsScene& aScene, TBool aUnregister);
sl@0: public:
sl@0: 	TInt DebugFlags()const	{	return iFlags;	}
sl@0: protected:
sl@0: 	TUint iFlags;
sl@0: public:
sl@0: 	MWsElement* iElement;
sl@0: };
sl@0: 
sl@0: class TBackgroundAttributes : public TAttributes
sl@0: {
sl@0: public:
sl@0: 	enum
sl@0: 	{
sl@0: 	EExplicitExtent		= 0x00010000,
sl@0: 	//EAbsoluteExtent		= 0x00020000,	//This would be used to represent wallpaper or DSA per window
sl@0: 	EExplicitViewPort      = 0x00040000,
sl@0: 	};
sl@0: 	//flag accessors
sl@0: 	inline TBool ExplicitExtent() const {return iFlags&EExplicitExtent;}
sl@0: 	inline void SetExplicitExtent(TBool aSetting = ETrue) 
sl@0: 		{	iFlags= aSetting? iFlags|EExplicitExtent:iFlags&~EExplicitExtent;}
sl@0: //Absolute extent functionality is currently not required or used
sl@0: //	inline TBool AbsoluteExtent() const {return iFlags&EAbsoluteExtent;}
sl@0: //	inline void SetAbsoluteExtent(TBool aSetting = ETrue) 
sl@0: //		{	iFlags= aSetting? iFlags|EAbsoluteExtent:iFlags&~EAbsoluteExtent;}
sl@0: 	inline TBool ExplicitViewPort() const {return iFlags&EExplicitViewPort;}
sl@0:     inline void SetExplicitViewPort(TBool aSetting = ETrue) 
sl@0:         {   iFlags = aSetting ? iFlags|EExplicitViewPort : iFlags&~EExplicitExtent;}
sl@0: };
sl@0: 
sl@0: class TPlacedAttributes : public TAttributes
sl@0: {
sl@0: public:
sl@0: 	enum
sl@0: 	{
sl@0: 	EUnassigned			= 0x00010000,
sl@0: 	ELockedConfig		= 0x00020000,
sl@0: 	EChangedClip	= 0x00040000,
sl@0: 	EOverlapping		= 0x00080000,
sl@0: 	};
sl@0: 	//flag accessors
sl@0: 	inline TBool Unassigned() const {return iFlags&EUnassigned	;}
sl@0: 	inline void SetUnassigned(TBool aSetting = ETrue) 
sl@0: 		{	iFlags= aSetting? iFlags|EUnassigned	:iFlags&~EUnassigned;	}
sl@0: 	inline TBool LockedConfig() const {return iFlags&ELockedConfig	;}
sl@0: 	inline void SetLockedConfig(TBool aSetting = ETrue) 
sl@0: 		{aSetting?iFlags|=ELockedConfig:iFlags&=~ELockedConfig;}
sl@0: 	inline TBool ChangedClip() const {return iFlags&EChangedClip;}
sl@0: 	inline void SetChangedClip(TBool aSetting = ETrue) 
sl@0: 		{aSetting?iFlags|=EChangedClip:iFlags&=~EChangedClip;}
sl@0: 	inline TBool Overlapping() const {return iFlags&EOverlapping;}
sl@0: 	inline void SetOverlapping(TBool aSetting = ETrue) 
sl@0: 		{	iFlags= aSetting? iFlags|EOverlapping:iFlags&~EOverlapping;	}
sl@0: 	inline void ClearRedrawFlags()
sl@0: 		{	iFlags &= (~(EUnassigned|ELockedConfig|EChangedClip|EOverlapping));	}
sl@0: };
sl@0: 
sl@0: class CWindowElement : public CBase
sl@0: {
sl@0: friend class CWindowElementSet;
sl@0: public:
sl@0: 	enum
sl@0: 	{
sl@0: 	EFastPath			= 0x00000001,
sl@0: 	EPauseComposition	= 0x00000002,	//assign flags this if pause is needed immediately
sl@0: 	EResort				= 0x00000004,
sl@0: 	EFailed				= 0x00010000,	//cleanup failure needs to be reported separately
sl@0: 	};
sl@0: 	
sl@0: 	CWindowElement(const CWsClientWindow& aWindow);
sl@0:   
sl@0: 	TInt UnassignPlacedElements(const TRegion& aRegion,TInt aGcDrawingCount);
sl@0: 	void FlagAssignedElementsDrawnOver(TInt aGcDrawingCount);
sl@0: 	static TBool IsElementAMatch(MWsElement&,const TSurfaceConfiguration&,TInt);
sl@0: 	static TInt SetElement(MWsElement&,const TSurfaceConfiguration&,TBool);
sl@0: 	TBool InsertCache(TInt aIndexToInsert);
sl@0: 	static void NotifyReleasingSurface(TSurfaceId aSurfaceId);
sl@0: 	TInt AssignPlacedElement(TPlacedAttributes*& aPlacedAttributes, 
sl@0: 			const TSurfaceConfiguration& aSurfaceConfiguration,
sl@0: 			const TRegion& aUserDefinedRegion, MWsScene& aScene,TInt aGcDrawingCount);
sl@0: 	
sl@0: 	TInt CleanUpPlacedElements(MWsScene& aScene,TInt aGcDrawingCount);
sl@0: 	void MoveToAboveGivenElement(MWsScene& aScene, MWsElement* aAboveElement);
sl@0: 	void UpdateElementExtent(const TPoint* aOffset);
sl@0: 	TBool SetVisibleRegion(const TRegion& aRegion, MWsScene& aScene);
sl@0: 	TInt ReleaseAllElements();
sl@0: 	TBool SearchDuplicateSurfaceId(const TSurfaceId& aSurfaceId);
sl@0: 	void SetElementOpacity(TInt aOpacity, MWsScene& aScene);
sl@0: 	void ResubmitAllElementExtents();
sl@0: 	MWsElement* Element() const;
sl@0: 
sl@0: protected:
sl@0: 	TInt AssignRecycleElement(const TInt aIndex,
sl@0: 			const TSurfaceConfiguration& aSurfaceConfiguration,
sl@0: 			const TRegion& aUserDefinedRegion,
sl@0: 			MWsScene& aScene);
sl@0: 	TInt AssignCreateElement(const TSurfaceConfiguration& aSurfaceConfiguration,
sl@0: 			const TRegion& aUserDefinedRegion,
sl@0: 			MWsScene& aScene);
sl@0: 	TInt AssignExtendElement(const TInt aIndex,
sl@0: 			const TSurfaceConfiguration& aSurfaceConfiguration,
sl@0: 			const TRegion& aUserDefinedRegion,
sl@0: 			MWsScene& aScene);
sl@0: 	
sl@0: public:
sl@0: 	const CWsClientWindow& iWindow;
sl@0: private:
sl@0: 	TBackgroundAttributes iBackgroundElement;
sl@0: 	RArray<TPlacedAttributes> iPlacedElements;
sl@0: private:	//The following are all exclusively used during window rendering
sl@0: 	RArray<RRegion> iCache;
sl@0: 	//memory of surfaces that need to be removed
sl@0: 	RArray<TSurfaceId> iRemovedSurfaces;
sl@0: 	TBool iRemovedSurfacesValid;
sl@0: 
sl@0: 	RRegion iNonRedrawVisibleRegion;
sl@0: 	TInt iHighestReusedIndex;
sl@0: 	TInt iStartGcDrawingCount;
sl@0: 	TUint iFlags;
sl@0: };
sl@0: 
sl@0: /**
sl@0: Owns the set of elements and their associated identification information. Only
sl@0: references are provided for clients.
sl@0: */
sl@0: class CWindowElementSet : public CBase
sl@0: {
sl@0: public:
sl@0: 	static CWindowElementSet* NewL(MWsScene& aScene);
sl@0: 	~CWindowElementSet();
sl@0: 	TBackgroundAttributes& AcquireBackgroundElementL(CWsClientWindow& aWindow);
sl@0: 	TInt ReleaseBackgroundElement(const CWsClientWindow&, TBool aWindowClosing = EFalse);
sl@0: 	TInt ReleaseAllElements(const CWsClientWindow&, TBool aWindowClosing = EFalse);
sl@0: 	TInt UnassignPlacedElements(const TRegion& aRedrawRegion, const CWsClientWindow& aWindow,TInt aGcDrawingCount);
sl@0: 	TInt AssignPlacedElement(TPlacedAttributes*&, const TSurfaceConfiguration&, const TRegion& aUserDefinedRegion,
sl@0: 			const CWsClientWindow&,TInt aGcDrawingCount);
sl@0: 	TInt CleanUpPlacedElements(const CWsClientWindow& aWindow,TInt aGcDrawingCount);
sl@0: 	TInt Count() const;
sl@0: 	TBackgroundAttributes* FindBackgroundElement(const CWsClientWindow&);	
sl@0: 	TBool FindElements(const CWsClientWindow&,const TBackgroundAttributes*&,const RArray<TPlacedAttributes>*&);	
sl@0: 	TInt RegisterSurface(const TSurfaceId& aSurface);
sl@0: 	void UnregisterSurface(const TSurfaceId& aSurface);
sl@0: 	TBool SortByZOrder();
sl@0: 	TInt SetVisibleRegion(CWsClientWindow& aWindow);	//cant be a const win as VisibleRegion() isnt const??
sl@0: 	void UpdateElementExtent(const CWsClientWindow&, const TPoint* aOffset);
sl@0: 	static TInt GetConfiguration(TSurfaceConfiguration&,MWsElement&);
sl@0: 	TBool SearchDuplicateSurfaceId(const TSurfaceId& aSurfaceId);
sl@0: 	void SetElementOpacity(CWsClientWindow& aWindow, TInt aOpacity);
sl@0: 	void ResubmitAllElementExtents();
sl@0: 	MWsElement* GetElementFromWindow(const CWsClientWindow& aWindow) const;
sl@0: 	
sl@0: public:
sl@0: 	const CWsClientWindow* DebugWindowAt(TUint aWin)const;
sl@0: 	const TBackgroundAttributes* DebugBackgroundAt(TUint aWin)const;
sl@0: 	const TPlacedAttributes* DebugPlacedAt(TUint aWin,TUint aPlace)const;
sl@0: //Note: The following methods are currently unused
sl@0: //	const TPlacedAttributes* DebugPlacedAt(const CWsClientWindow& aWindow,TInt aPlace)const;
sl@0: //	const RRegion* DebugCacheAt(TInt aWin,TInt aPlace)const;
sl@0: 	TInt DebugPlacedCountAt(TUint aWin)const; 
sl@0: 
sl@0: protected:
sl@0: 	CWindowElement* FindElement(const CWsClientWindow& aWindow) const;
sl@0: 
sl@0: private:
sl@0: 	CWindowElementSet(MWsScene& aScene);
sl@0: 	TInt FindEntry(const CWsClientWindow& aWindow, TInt& aIndex, TBool aLinearSearch = EFalse) const;
sl@0: 	static TBool WindowMatch(const CWindowElement& aFirst, const CWindowElement& aSecond);
sl@0: 	static TInt WindowOrder(const CWindowElement& aFirst, const CWindowElement& aSecond);
sl@0: 	void DestroyWindowElementEntry(const TInt aWinElementIndex);
sl@0: 
sl@0: private:
sl@0: 	RPointerArray<CWindowElement> iElements;
sl@0: 	MWsScene& iScene;
sl@0: };
sl@0: 
sl@0: /** Gc to element rotation function
sl@0: */
sl@0: inline MWsElement::TElementRotation GcToElementRotation(CFbsBitGc::TGraphicsOrientation aGcRotation)
sl@0: 	{
sl@0: 	MWsElement::TElementRotation elementRotation = MWsElement::EElementAntiClockwise0;
sl@0: 	
sl@0: 	switch (aGcRotation)
sl@0: 		{
sl@0: 		case CFbsBitGc::EGraphicsOrientationRotated90:
sl@0: 			elementRotation = MWsElement::EElementAntiClockwise90;
sl@0: 			break;
sl@0: 		case CFbsBitGc::EGraphicsOrientationRotated180:
sl@0: 			elementRotation = MWsElement::EElementAntiClockwise180;
sl@0: 			break;
sl@0: 		case CFbsBitGc::EGraphicsOrientationRotated270:
sl@0: 			elementRotation = MWsElement::EElementAntiClockwise270;
sl@0: 			break;
sl@0: 		default:
sl@0: 			break;
sl@0: 		}
sl@0: 	return elementRotation;
sl@0: 	}
sl@0: 
sl@0: #endif // !defined(__WINDOWELEMENTSET_H__)