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: // TWalkWindowTreeBase and associated classes definitions
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __WALKWINDOWTREE_H__
sl@0: #define __WALKWINDOWTREE_H__
sl@0: 
sl@0: #include "server.h"
sl@0: 
sl@0: class CWsWindow;
sl@0: class CWsWindowBase;
sl@0: class RWsTextCursor;
sl@0: 
sl@0: class TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	virtual TBool DoIt(CWsWindow *aWin)=0;
sl@0: 	};
sl@0: 
sl@0: class TResumableWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	virtual TBool DoIt(CWsWindow *aWin)=0;
sl@0: private: // walk state
sl@0: 	friend class CWsWindowBase;
sl@0: 	CWsWindowBase* iWin;
sl@0: 	CWsWindowBase* iEnd;
sl@0: 	CWsWindowBase* iNextChild;
sl@0: 	CWsWindowBase* iParent;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreeRegionBase : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	enum TTranslucentBehaviour
sl@0: 		{
sl@0: 		EDontWalkTranslucent,              //< Default behaviour - stop when you reach a window
sl@0: 		EWalkTranslucent,                  //< Walk through translucent parts of windows
sl@0: 		};
sl@0: protected:
sl@0: 	TWalkWindowTreeRegionBase(RWsRegion *aRegion, TTranslucentBehaviour aTranslucentBehaviour = EDontWalkTranslucent);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	virtual void DoIt2(CWsWindow *aWin)=0;
sl@0: 	virtual TBool DoIt3(CWsWindow *aWin);
sl@0: protected:
sl@0: 	TTranslucentBehaviour iTranslucentBehaviour;
sl@0: 	RWsRegion *iRegion;
sl@0: 	RWsRegion *iSubRegion;
sl@0: 	};
sl@0: 	
sl@0: /**
sl@0: This tree walker calculates the visible regions of all windows and schedules
sl@0: redraws for anywhere which has changed.
sl@0: */
sl@0: class TWalkWindowTreeUpdateRegions : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeUpdateRegions(CScreen & aScreen);
sl@0: 	TBool DoIt(CWsWindow * aWin);
sl@0: 	void Walk();
sl@0: 
sl@0: private:
sl@0: 	CScreen & iScreen;
sl@0: 	RWsRegion iVisible;
sl@0: 	RWsRegion iTop;
sl@0: 	RWsRegion iRemainsOfFadableScreen; // The remains after the accumulation of already faded regions
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: This schedules the visible regions of all windows walked for redraw.
sl@0: */
sl@0: class TWalkWindowTreeScheduleRedraws : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	enum
sl@0: 	{ // bit mask
sl@0: 	ERedrawFilterNoFilter = 0,
sl@0: 	ERedrawFilterOmitDSA	= 0x001
sl@0: 	};
sl@0: 	
sl@0: public:
sl@0: 	TWalkWindowTreeScheduleRedraws();
sl@0: 	TWalkWindowTreeScheduleRedraws( TUint32 aFilter );
sl@0: 	TBool DoIt(CWsWindow * aWin);
sl@0: 
sl@0: private:
sl@0: 	TUint32	iScheduleRedrawFilter;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: This offsets all the transparent regions
sl@0: */
sl@0: class TWalkWindowTreeOffsetTransparentRegions : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeOffsetTransparentRegions(const TPoint& aOffset);
sl@0: 	TBool DoIt(CWsWindow * aWin);
sl@0: 
sl@0: private:
sl@0: 	const TPoint & iOffset;	
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: This recalculates the user opaque regions
sl@0: */
sl@0: class TWalkWindowTreeRecalcOpaque : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeRecalcOpaque();
sl@0: 	TBool DoIt(CWsWindow * aWin);
sl@0: 	};
sl@0: 
sl@0: // Tree walkers which schedule a set of windows to be drawn derive from this
sl@0: class TWalkWindowTreeSchedule: public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeSchedule();
sl@0: 	CWsWindow * HeadWindow() const;
sl@0: 	virtual const TRegion * Region(const CWsWindow* aWin) const = 0;
sl@0: protected:
sl@0: 	CWsWindow* iHead;
sl@0: 	};
sl@0: 	
sl@0: // This walker uses regions to work out the minimum set of pixels that need updating
sl@0: // It requires memory allocation, and so can fail.  Check ScheduledRegionsOk before
sl@0: // relying on the results.
sl@0: class TWalkWindowTreeScheduleRegions: public TWalkWindowTreeSchedule
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeScheduleRegions(RWsRegion *aRegion, const TRegion& aTopLayer);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	TBool ScheduledRegionsOk() const;
sl@0: 	const TRegion * Region(const CWsWindow* aWin) const;
sl@0: private:
sl@0: 	RWsRegion *iRegion;
sl@0: 	const TRegion &iTopLayer;
sl@0: 	TBool iScheduledRegionsOk;
sl@0: 	};
sl@0: 	
sl@0: // This walker uses the screens fallback mechanism.  This does not require memory
sl@0: // allocation and so should never fail, but is significantly less efficient than the
sl@0: // region based walker.
sl@0: class TWalkWindowTreeScheduleFallback: public TWalkWindowTreeSchedule
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeScheduleFallback(CScreen::CFallbackMap * aFallbackMap);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	const TRegion * Region(const CWsWindow* aWin) const;
sl@0: private:
sl@0: 	CScreen::CFallbackMap * iFallbackMap;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreeFocusChanged : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeFocusChanged(TBool aNewFocusState);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: // Data	
sl@0: private:
sl@0: 	TBool iNewFocusState;
sl@0: 	};
sl@0: 	
sl@0: class TResumableWalkWindowTreeFindInvalid : public TResumableWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TResumableWalkWindowTreeFindInvalid(CWsWindowRedraw** aResult);
sl@0: 	TBool DoIt(CWsWindow* aWin);
sl@0: // Data
sl@0: private:
sl@0: 	CWsWindowRedraw** iResult;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreeDisconnect : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeDisconnect(RWsTextCursor *aCursor);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: private:
sl@0: 	RWsTextCursor *iTextCursor;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreeIsObscured : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeIsObscured(TBool &aResult);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: // Data	
sl@0: 	TBool *iResult;
sl@0: 	};
sl@0: 
sl@0: class TWalkWindowTreeSetNonFading : public TWalkWindowTreeBase  
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeSetNonFading(TBool aNonFading);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: // Data	
sl@0: 	const TBool iNonFading;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreeSetFaded : public TWalkWindowTreeBase 
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeSetFaded(TBool aFaded,CWsWindowBase* aWin,TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: // Data	
sl@0: 	const TUint8 iBlackMap;
sl@0: 	const TUint8 iWhiteMap;
sl@0: 	const TBool iFaded;
sl@0: 	const CWsWindowGroup* iGroup;
sl@0: 	};
sl@0: 	
sl@0: class TWalkWindowTreePurgeEvents : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreePurgeEvents();
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	};
sl@0: 
sl@0: class TWalkWindowTreeCalcInvalidGraphics: public TWalkWindowTreeRegionBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeCalcInvalidGraphics(RWsRegion *aRegion,TRegion &aDirty,const TArray<TGraphicDrawerId>& aInvalid);
sl@0: 	void CalcInvalid(CScreen& aScreen);
sl@0: 	TBool CreateSubRegion();
sl@0: 	void DoIt2(CWsWindow */*aWin*/) {}
sl@0: 	TBool DoIt3(CWsWindow *aWin);
sl@0: 	void DestroyRegions();
sl@0: private:
sl@0: 	TRegion& iDirty;
sl@0: 	const TArray<TGraphicDrawerId>& iInvalid;
sl@0: 	};
sl@0: 
sl@0: #if defined(_DEBUG)
sl@0: class TWalkWindowTreeCheck : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	};	
sl@0: 	
sl@0: #endif
sl@0: 
sl@0: class TWalkWindowTreeRedrawStoreSize : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeRedrawStoreSize();
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	TInt iTotalSize;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: // We can't do a proper find_if unless we are prepared to write our own
sl@0: // mem_fun, but this isn't a bad start
sl@0: class TWalkWindowTreeFindWithFlag : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeFindWithFlag(TUint aFlag) : iFlag(aFlag), iFound(0) { }
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	CWsWindow * Found() { return iFound; }
sl@0: private:
sl@0: 	TUint iFlag;
sl@0: 	CWsWindow * iFound;
sl@0: 	};
sl@0: 
sl@0: class TWalkWindowTreeFindByHandle : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeFindByHandle(TUint32 aHandle) : iHandle(aHandle) { }
sl@0: 	TBool DoIt(CWsWindow * aWin);
sl@0: 	CWsWindow * Found() { return iFound; }
sl@0: private:
sl@0: 	TUint32 iHandle;
sl@0: 	CWsWindow * iFound;
sl@0: 	};
sl@0: 
sl@0: class TWalkWindowTreeReactivateGcs : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	};
sl@0: 
sl@0: class TWalkWindowTreeScheduleFadeNoRedraw : public TWalkWindowTreeBase
sl@0: 	{
sl@0: public:
sl@0: 	TWalkWindowTreeScheduleFadeNoRedraw();
sl@0: 	TBool DoIt(CWsWindow *aWin);
sl@0: 	};
sl@0: 
sl@0: #endif