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: // CWsWindowBase and associated classes definitions
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __WINBASE_H__
sl@0: #define __WINBASE_H__
sl@0: 
sl@0: #include "server.h"
sl@0: 
sl@0: class TWalkWindowTreeBase;
sl@0: class TResumableWalkWindowTreeBase;
sl@0: class CWsAnim;
sl@0: class CWsSprite;
sl@0: class CWsBlankWindow;
sl@0: 
sl@0: /** The base class that represents a node in the window tree.
sl@0: 
sl@0: Every window and window group is part of a window tree. The root of the tree is an instance of the
sl@0: CWsRootWindow class.
sl@0: 
sl@0: @see RWindowTreeNode
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: class CWsWindowBase : public CWsScreenObject, public MWsWindowTreeNode
sl@0: 	{
sl@0: public:
sl@0: 	CWsWindowBase(CWsClient *aOwner,WH_HANDLES aType, CScreen* aScreen);
sl@0: 	void ConstructL(CWsWindowBase *aParent);
sl@0: 	virtual void AreaCovered(TRegion &aRegion)=0;
sl@0: 	virtual TPoint Origin() const = 0;
sl@0: 	virtual TRect AbsRect() const = 0;
sl@0: 	virtual TSize Size() const = 0;
sl@0: 	CWsWindowGroup *WinGroup() const;
sl@0: 	inline TUint32 ClientHandle() const;
sl@0: 	inline CWsWindowBase *BaseParent() const;
sl@0: 	inline CWsWindowBase *BaseChild() const;
sl@0: 	inline CWsWindowBase *NextSibling() const;
sl@0: 	CWsWindowBase *GetPrevSibling() const;
sl@0: 	CWsWindowBase *LastSibling() const;
sl@0: 	CWsWindowBase *PrevSiblingMultiParent() const;
sl@0: 	CWsWindowBase *NextSiblingMultiParent() const;
sl@0: 	inline TWinType WinType() const;
sl@0: 	virtual void StatusDump(TDes &aBuf)=0;
sl@0: 	TBool QueueEvent(TInt aEvent, TInt aIntVal = 0) const;
sl@0: 	inline TBool AdvancedPointersEnabled() const;
sl@0: 	inline CWsPointerCursor *PointerCursor() const;
sl@0: 	TEventQueueWalkRet EventPurgeCheck(TWsEvent *aEvent);
sl@0: 	virtual void SetOrdinalPosition(TInt aPos);
sl@0: 	TBool TreeIsObscured() const;
sl@0: 	CEventQueue *EventQueue() const;
sl@0: 	TInt Depth() const;
sl@0: 	void WalkWindowTree(TWalkWindowTreeBase &doIt,TWalkMode aMode);
sl@0: 	void WalkWindowTree(TResumableWalkWindowTreeBase& aWalkClass, TWalkMode aMode, TBool aResume);
sl@0: 	void WalkWindowTreeBackToFront(TWalkWindowTreeBase &doIt, TWalkModeBackToFront aMode);
sl@0: 	void PurgeEvents();
sl@0: 	inline TInt FadeCount() const;
sl@0:   void AddSprite(CWsSpriteBase * aSprite);
sl@0:   void RemoveSprite(CWsSpriteBase * aSprite);
sl@0: 	inline TBool HasSprite() const;
sl@0: 	virtual TBool IsDSAHost() const;
sl@0: 	virtual void SendState(MWsWindowTreeObserver& aWindowTreeObserver) const;
sl@0: 	
sl@0: public:	// from CWsObject
sl@0: 	TBool CommandL(TInt aOpcode, TWsWinCmdUnion &aCmd);
sl@0: 	
sl@0: public: // from MWsWindowTreeNode
sl@0: 	MWsWindowTreeNode::TType NodeType() const;
sl@0: 	const MWsWindow* Window() const;
sl@0: 	const MWsSprite* Sprite() const;
sl@0: 	const MWsStandardTextCursor* StandardTextCursor() const;
sl@0: 	const MWsWindowGroup* WindowGroup() const;
sl@0: 	const MWsWindowTreeNode* ParentNode() const;	
sl@0: 	
sl@0: protected:
sl@0: 	TInt OrdinalPosition(TBool aFull) const;
sl@0: 	TBool CheckOrdinalPositionChange(TInt aPos);
sl@0: 	virtual void Shutdown();	// Part of two phase destruction
sl@0: 	void SetPointerCursor(CWsPointerCursor *aCursor);
sl@0: 	void SetPointerCursorByIndex(TInt aIndex);
sl@0: 	void ChangeWindowPosition(TInt aPos,CWsWindowBase* aNewParent);
sl@0: 
sl@0: private:
sl@0: 	void RemoveFromSiblingList();
sl@0: 	virtual TBool IsActivated() const;
sl@0: 
sl@0: public:	
sl@0: 	CWsSpriteBase *iSpriteList; // Start of linked list of sprites attached to the window		
sl@0: 	
sl@0: protected:
sl@0: 	enum TBaseWinFlags
sl@0: 		{
sl@0: 		EBaseWinAdvancedPointersEnabled = 0x00000001,
sl@0: 		EBaseWinNodeCreated				= 0x00000002,
sl@0: 		};
sl@0: 	
sl@0: 	CWsWindowBase *iParent;
sl@0: 	CWsWindowBase *iSibling;
sl@0: 	CWsWindowBase *iChild;
sl@0: 	/** The handle specified by the client when the object was created.
sl@0: 	
sl@0: 	This is different from CWsObject::iWsOwner which is the handle assigned to the object by the server.
sl@0: 	@see CWsObject::iWsOwner
sl@0: 	*/
sl@0: 	TUint32 iClientHandle;
sl@0: 	TInt iOrdinalPriority;
sl@0: 	TWinType iWinType;
sl@0: 	TInt iFadeCount;
sl@0: 	TUint iBaseWinFlags;
sl@0: 
sl@0: private:
sl@0: 	CWsPointerCursor *iPointerCursor;
sl@0: 	
sl@0: #if defined(_DEBUG)
sl@0: public:
sl@0: 	void CheckTree();
sl@0: 	TBool IsClientHandleInUse(TUint32 aHandle);
sl@0: #endif
sl@0: 	};
sl@0: 	
sl@0: inline TWinType CWsWindowBase::WinType() const
sl@0: 	{
sl@0: 	return iWinType;
sl@0: 	}
sl@0: 
sl@0: inline CWsPointerCursor *CWsWindowBase::PointerCursor() const
sl@0: 	{
sl@0: 	return iPointerCursor;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowBase *CWsWindowBase::NextSibling() const
sl@0: 	{
sl@0: 	return iSibling;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowBase *CWsWindowBase::BaseChild() const
sl@0: 	{
sl@0: 	return iChild;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowBase *CWsWindowBase::BaseParent() const
sl@0: 	{
sl@0: 	return iParent;
sl@0: 	}
sl@0: 
sl@0: inline TUint32 CWsWindowBase::ClientHandle() const
sl@0: 	{
sl@0: 	return iClientHandle;
sl@0: 	}
sl@0: 
sl@0: inline TInt CWsWindowBase::FadeCount() const
sl@0: 	{
sl@0: 	return iFadeCount;
sl@0: 	}
sl@0: 
sl@0: inline TBool CWsWindowBase::AdvancedPointersEnabled() const
sl@0: 	{
sl@0: 	return iBaseWinFlags&EBaseWinAdvancedPointersEnabled;
sl@0: 	}
sl@0: 
sl@0: inline TBool CWsWindowBase::HasSprite() const
sl@0: 	{
sl@0: 	return (NULL != iSpriteList);
sl@0: 	}
sl@0: 
sl@0: #endif