windowing/windowserver/nonnga/SERVER/winbase.h
changeset 0 5d03bc08d59c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/windowing/windowserver/nonnga/SERVER/winbase.h	Tue Feb 02 01:47:50 2010 +0200
@@ -0,0 +1,142 @@
+// Copyright (c) 2006-2009 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:
+// CWsWindowBase and associated classes definitions
+// 
+//
+
+#ifndef __WINBASE_H__
+#define __WINBASE_H__
+
+#include "server.h"
+
+class TWalkWindowTreeBase;
+class TResumableWalkWindowTreeBase;
+class CWsAnim;
+class CWsSprite;
+class CWsBlankWindow;
+
+/** The base class that represents a node in the window tree.
+
+Every window and window group is part of a window tree. The root of the tree is an instance of the
+CWsRootWindow class.
+
+@see RWindowTreeNode
+@internalComponent
+@released
+*/
+class CWsWindowBase : public CWsScreenObject
+	{
+public:
+	CWsWindowBase(CWsClient *aOwner,WH_HANDLES aType, CScreen* aScreen);
+	void ConstructL(CWsWindowBase *aParent);
+	virtual TPoint Origin() const = 0;
+	virtual TRect AbsRect() const = 0;
+	virtual TSize Size() const = 0;
+	CWsWindowGroup *WinGroup() const;
+	inline TUint32 ClientHandle() const;
+	inline CWsWindowBase *BaseParent() const;
+	inline CWsWindowBase *BaseChild() const;
+	inline CWsWindowBase *NextSibling() const;
+	CWsWindowBase *GetPrevSibling() const;
+	CWsWindowBase *LastSibling() const;
+	CWsWindowBase *PrevSiblingMultiParent() const;
+	CWsWindowBase *NextSiblingMultiParent() const;
+	inline TWinType WinType() const;
+	virtual void StatusDump(TDes &aBuf)=0;
+	TBool QueueEvent(TInt aEvent) const;
+	inline CWsPointerCursor *PointerCursor() const;
+	TEventQueueWalkRet EventPurgeCheck(TWsEvent *aEvent);
+	virtual void SetOrdinalPosition(TInt aPos);
+	TBool TreeIsObscured() const;
+	CEventQueue *EventQueue() const;
+	void WalkWindowTree(TWalkWindowTreeBase &doIt,TWalkMode aMode);
+	void WalkWindowTree(TResumableWalkWindowTreeBase& aWalkClass, TWalkMode aMode, TBool aResume);
+	void PurgeEvents();
+	inline TInt FadeCount() const;
+
+	virtual TBool IsDSAHost() const;
+public:	// from CWsObject
+	TBool CommandL(TInt aOpcode, TWsWinCmdUnion &aCmd);
+
+protected:
+	TInt OrdinalPosition(TBool aFull) const;
+	TBool CheckOrdinalPositionChange(TInt aPos);
+	virtual void Shutdown();	// Part of two phase destruction
+	void SetPointerCursor(CWsPointerCursor *aCursor);
+	void SetPointerCursorByIndex(TInt aIndex);
+	void ChangeWindowPosition(TInt aPos,CWsWindowBase* aNewParent);
+
+private:
+	void RemoveFromSiblingList();
+
+protected:
+	CWsWindowBase *iParent;
+	CWsWindowBase *iSibling;
+	CWsWindowBase *iChild;
+	/** The handle specified by the client when the object was created.
+	
+	This is different from CWsObject::iWsOwner which is the handle assigned to the object by the server.
+	@see CWsObject::iWsOwner
+	*/
+	TUint32 iClientHandle;
+	TInt iOrdinalPriority;
+	TWinType iWinType;
+	TInt iFadeCount;
+
+private:
+	CWsPointerCursor *iPointerCursor;
+	
+#if defined(_DEBUG)
+public:
+	void CheckTree();
+	TBool IsClientHandleInUse(TUint32 aHandle);
+#endif
+	};
+	
+inline TWinType CWsWindowBase::WinType() const
+	{
+	return iWinType;
+	}
+
+inline CWsPointerCursor *CWsWindowBase::PointerCursor() const
+	{
+	return iPointerCursor;
+	}
+
+inline CWsWindowBase *CWsWindowBase::NextSibling() const
+	{
+	return iSibling;
+	}
+
+inline CWsWindowBase *CWsWindowBase::BaseChild() const
+	{
+	return iChild;
+	}
+
+inline CWsWindowBase *CWsWindowBase::BaseParent() const
+	{
+	return iParent;
+	}
+
+inline TUint32 CWsWindowBase::ClientHandle() const
+	{
+	return iClientHandle;
+	}
+
+inline TInt CWsWindowBase::FadeCount() const
+	{
+	return iFadeCount;
+	}
+
+#endif