sl@0: // Copyright (c) 1999-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: // Definition of base class for all objects
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __OBJECT_H__
sl@0: #define __OBJECT_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include "w32cmd.h"
sl@0: #include "screen.h"
sl@0: 
sl@0: class CWsClient;
sl@0: class CWsRootWindow;
sl@0: 
sl@0: /** 
sl@0: CWsObject is the base class for the server-side objects that are visible to the client.
sl@0: 
sl@0: The client refers to these objects via a handle that is passed to it by the server.
sl@0: The association between handles and CWsObject instances is stored by the TWsObject class.
sl@0: 
sl@0: Derived classes must implement the CommandL() function so that it handles the requests
sl@0: the client sent.
sl@0: 
sl@0: Each client session has a list of all its CWsObject instances. When creating an instance of 
sl@0: a class derived from CWsObject the NewObjL() function must be called to add the new 
sl@0: object to the list. The CWsObject destructor takes care of removing the object from the list.
sl@0: 
sl@0: @see TWsObject
sl@0: @see CWsClient
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: class CWsObject : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	CWsObject(CWsClient* aOwner,WH_HANDLES aType);
sl@0: 	~CWsObject();
sl@0: 	virtual void CommandL(TInt aOpcode, const TAny *aCmdData)=0;
sl@0: 	virtual void CloseObject();
sl@0: 	TInt LogHandle() const;
sl@0: 	void NewObjL();
sl@0: 	void RemoveFromIndex();
sl@0: 	inline WH_HANDLES Type() const;
sl@0: 	inline CWsClient *WsOwner() const;
sl@0: 	inline void SetWsOwner(CWsClient *aOwner);
sl@0: 	void OwnerPanic(TClientPanic aPanic) const;
sl@0: protected:
sl@0: 	void SetReply(TInt aReply);
sl@0: 	
sl@0: private:
sl@0: 	WH_HANDLES iType;
sl@0: protected:
sl@0: 	/** Each client has a list of all its CWsObject instances. The CWsObject 
sl@0: 	has a pointer to its owner so that it can update the list when it is created and
sl@0: 	when it is destroyed. */
sl@0: 	CWsClient *iWsOwner;
sl@0: 	};
sl@0: 
sl@0: class CWsScreenObject : public CWsObject
sl@0: 	{
sl@0: public:
sl@0: 	inline CWsScreenObject(CWsClient *aOwner,WH_HANDLES aType,CScreen* aScreen);
sl@0: 	inline CScreen* Screen() const;
sl@0: 	inline CWsRootWindow* RootWindow() const;
sl@0: 
sl@0: protected:
sl@0: 	CScreen* iScreen;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: //
sl@0: // inlines			//
sl@0: //
sl@0: 
sl@0: //
sl@0: // CWsObject
sl@0: //
sl@0: inline CWsClient *CWsObject::WsOwner() const
sl@0: 	{return(iWsOwner);}
sl@0: inline void CWsObject::SetWsOwner(CWsClient *aOwner)
sl@0: 	{iWsOwner=aOwner;}
sl@0: inline WH_HANDLES CWsObject::Type() const
sl@0: 	{return(iType);}
sl@0: //
sl@0: // CWsScreenObject
sl@0: //
sl@0: inline CWsScreenObject::CWsScreenObject(CWsClient *aOwner,WH_HANDLES aType,CScreen* aScreen) : CWsObject(aOwner,aType), iScreen(aScreen)
sl@0: 	{}
sl@0: inline CScreen* CWsScreenObject::Screen() const
sl@0: 	{return iScreen;}
sl@0: inline CWsRootWindow* CWsScreenObject::RootWindow() const
sl@0: 	{return iScreen->RootWindow();}
sl@0: #endif