sl@0: // Copyright (c) 2006-2010 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: // CWsWindow and associated classes definitions
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __WINDOWGROUP_H__
sl@0: #define __WINDOWGROUP_H__
sl@0: 
sl@0: #include "server.h"
sl@0: #include "tcursor.h"
sl@0: 
sl@0: class CWsWindowGroup : public CWsWindowBase, public MWsWindowGroup
sl@0: 	{
sl@0: private:
sl@0: 	enum {EMaxIdentifierCount=10000};	// Could go as high as the highest signed int, but this would be impractical to test
sl@0: 	enum TGroupWindowFlags {
sl@0: 		EGroupFlagDisableKeyClick=0x01,
sl@0: 		EGroupFlagReceivesFocus=  0x02,
sl@0: 		EGroupFlagAutoForeground= 0x04,
sl@0: 		EGroupFlagHandlesDeviceChange= 0x08,
sl@0: 		EGroupFlagScreenDeviceDeleted= 0x10,
sl@0: 		EGroupFlagMsgQueueActive= 0x20,
sl@0: 		EGroupFlagMsgQueueNew=	  0x40,
sl@0: 		EGroupFlagMessageSignalled= 0x80,
sl@0: 		};
sl@0: public:
sl@0: 	static CWsWindowGroup* NewL(CWsClient* aOwner, CScreen* aScreen, 
sl@0: 		const TWsClCmdCreateWindowGroup& aCmd);
sl@0: 	~CWsWindowGroup();
sl@0: private:
sl@0: 	CWsWindowGroup(CWsClient* aOwner,CScreen* aScreen);
sl@0: 	void ConstructL(const TWsClCmdCreateWindowGroup &aCmd);
sl@0: public: // virtual functions from CWsObject
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: public: // virtual functions from CWsWindowBase
sl@0: 	TPoint Origin() const;
sl@0: 	TRect AbsRect() const;
sl@0: 	TSize Size() const;
sl@0: 	void SendState(MWsWindowTreeObserver& aWindowTreeObserver) const;
sl@0: 	void SendStateWindowGroupChain(MWsWindowTreeObserver& aWindowTreeObserver) const;
sl@0: 	
sl@0: public: // virtual functions from MWsWindowGroup
sl@0: 	TInt Identifier() const;
sl@0: 	TPtrC Name() const;
sl@0: 	TBool IsFocusable() const;
sl@0: 	TInt OrdinalPriority() const;
sl@0:     const MWsClient * Client() const;
sl@0: 
sl@0: public:
sl@0: 	CWsTopClientWindow *Child() const;
sl@0: 	inline CWsWindowGroup *PrevSibling() const;
sl@0: 	inline CWsWindowGroup *NextSibling() const;
sl@0: 	CWsRootWindow *Parent() const;
sl@0: 	virtual void AreaCovered(TRegion &aRegion);
sl@0: 	void UpdateOrdinalPriority(TBool aDoAdjust);
sl@0: 	void LostFocus();
sl@0: 	void ReceivedFocus();
sl@0: 	inline RWsTextCursor *TextCursor();
sl@0: 	inline TBool ReceivesFocus() const;
sl@0: 	static TInt NumWindowGroups(TBool aAllPriorities, TInt aPriority);
sl@0: 	static TInt SendWindowGroupListAndChainL(TBool aAllPriorities, TInt aPriority, TInt aCount);
sl@0: 	static TBool SendEventToAllGroups(TBool aAllPriorities,TBool aOnePerClient,const TWsClCmdSendEventToWindowGroup& aData);
sl@0: 	static void SendMessageToAllGroupsL(CWsClient& aSender,TBool aAllPriorities,const TWsClCmdSendMessageToWindowGroup& aData);
sl@0: 	static void GetFocusWindowGroupL();
sl@0: 	static void ReleasePendedMessagesToAllGroups(CWsClient * aClient);
sl@0: 	virtual void SetOrdinalPosition(TInt pos);
sl@0: 	TBool SetOrdinalPosition(TInt pos,CWsWindowGroup *aClosingWindow);
sl@0: 	void SetOrdinalPriority(TInt aPos, TInt aPriority);
sl@0: 	void QueueMessageL(TUid aUid, TInt aDataLength, CWsClient& aSender);
sl@0: 	void AddPriorityKeyL(TUint aKeycode, TUint aModifierMask, TUint aModifiers);
sl@0: 	void RemovePriorityKey(TUint aKeycode, TUint aModifierMask, TUint aModifiers);
sl@0: 	void RemoveAllPriorityKeys();
sl@0: 	TBool CheckForPriorityKey(const TKeyEvent &aKeyEvent);
sl@0: 	inline CWsPointerCursor *GroupPointerCursor() const;
sl@0: 	static CWsWindowGroup *WindowGroupFromIdentifier(TInt aIdentifier);
sl@0: 	static CWsWindowGroup *WindowGroupFromIdentifierL(TInt aIdentifier);
sl@0: 	static CWsWindowGroup *FindWindowGroupL(CWsClient* aClient,TInt aIdentifier,TInt aOffset,const TPtrC *aMatch,const TThreadId *aThreadId);
sl@0: 	inline HBufC *GroupName();
sl@0: 	inline void SetNextDefaultOwningWindow(CWsWindowGroup *aNext);
sl@0: 	inline CWsWindowGroup **NextDefaultOwningWindowPtr();
sl@0: 	void SetScreenDeviceValidState(const DWsScreenDevice *aDevice);
sl@0: 	void SetScreenChangeEventStateL(TBool aEnabled);
sl@0: 	TBool ScreenDeviceValid() const;
sl@0: 	TBool CanReceiveFocus() const;
sl@0: 	static void SetScreenDeviceValidStates(const DWsScreenDevice *aDevice);
sl@0: 	static void SetScreenDeviceValidStates(CScreen* aScreen);
sl@0: 	static void NewOrientation(TInt aMode,CFbsBitGc::TGraphicsOrientation aRotation, CWsRootWindow* aRootWindow);
sl@0: 	inline DWsScreenDevice *Device();
sl@0: 	void FetchMessageL();
sl@0: 	static inline void SetFocusGainPreprocessing(TBool aDo);
sl@0: 	TBool IsChained(TInt& aParentId);
sl@0: 	inline TInt NumWindowGroupsOnMyScreen(TInt aPriority);
sl@0: 	static TInt NumWindowGroupsOnScreen(const CWsWindowGroup* aGroupWin,TBool aAllPriorities,TInt aPriority);
sl@0: 	inline void SetScreenDeviceDeleted();
sl@0: 	inline TBool ScreenDeviceDeleted() const;
sl@0: 	static TInt SendWindowGroupListL(TInt aScreenNumber, TBool aAllPriorities, TInt aPriority, TInt aCount);
sl@0: 	static void GetFocusWindowGroupL(TInt aScreenNumber);
sl@0: 	void SetScreenDevice(DWsScreenDevice *aDevice);
sl@0: 	static void SetEventQueueTestState(TBool aEventQueState);
sl@0: 	TBool HasVisibleTranslucentChild();
sl@0: 	void  ReleasePendedMessage();	
sl@0: private:
sl@0: 	void SwitchToOwningWindow(CWsWindowGroup *aClosingWindow);
sl@0: 	void MoveChainedWindows(TDblQueIter<CWsWindowGroup>& aIter,TBool aForward,TInt aPos,CWsWindowGroup* aClosingWindow);
sl@0: 	TBool DoSetOrdinalPosition1(TInt aPos,CWsWindowGroup *aClosingWindow);
sl@0: 	void DoSetOrdinalPosition2(TInt aPos,CWsWindowGroup *aClosingWindow);
sl@0: 	TBool SignalMessageReady();
sl@0: 	static void AdvanceIdentifierCount();
sl@0: 	void StatusDump(TDes &aBuf);
sl@0: 	void PurgeCapturedKeys();
sl@0: 	inline void UpdateKeyClickState();
sl@0: 	void ResetFocus(CWsWindowGroup *aClosingWindow);
sl@0: 	static TInt GetWindowGroupListL(TInt aScreenNo,TBool aAllPriorities,TInt aPriority,TInt aCount,CArrayFixFlat<TInt>* aList);	
sl@0: 	inline CWsWindowGroup* BeforeInChain();
sl@0: 	static void GetWindowGroupListAndChainL(TInt aScreen,TBool aAllPriorities,TInt aPriority
sl@0: 																,RArray<RWsSession::TWindowGroupChainInfo>& list,TInt& aCountLeft);
sl@0: 	TBool CheckCapability(TInt& aOrdinalPriority);
sl@0: 	void DeleteQueue(TDblQue<CWsWindowGroup>* aQueue);
sl@0: 	TInt NumClientWindowGroups();
sl@0: 	void DisconnectFloatingSprites();
sl@0: private:
sl@0: 	RWsTextCursor iTextCursor;
sl@0: 	TInt iFlags;
sl@0: 	TInt iOrdinalPriorityBase;
sl@0: 	TInt iOrdinalPriorityAdjust;
sl@0: 	TPriorityKey *iPriorityKeys;
sl@0: 	TInt iOwningWindowGroup;
sl@0: 	HBufC *iGroupName;
sl@0: 	TInt iIdentifier;
sl@0: 	CWsWindowGroup *iNextDefaultOwningWindow;
sl@0: 	CArrayVarSeg<TWsMessage> *iMessageArray;
sl@0: 	static TInt iIdentifierCount;
sl@0: 	DWsScreenDevice *iScreenDevice;
sl@0: 	static RPointerArray< TDblQue<CWsWindowGroup> > iChains;
sl@0: 	TDblQue<CWsWindowGroup>* iQueue;
sl@0: 	TDblQueLink iChainLink;
sl@0: 	TUint32 iChildSID;
sl@0: 	static TBool iFocusGainPreProcess;		//'REMOVEFADINGONFOCUSGAIN' flag in INI file
sl@0: 	// used for eventqueue testing
sl@0: #if defined(_DEBUG)
sl@0: 	static TInt iSkipCount;
sl@0: #endif
sl@0: 	static TBool iEventQueueTest;
sl@0: 	friend class TWsPointer;
sl@0: 	};
sl@0: 
sl@0: inline CWsTopClientWindow *CWsWindowGroup::Child() const
sl@0: 	{
sl@0: 	return (CWsTopClientWindow *)iChild;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowGroup *CWsWindowGroup::NextSibling() const
sl@0: 	{
sl@0: 	return (CWsWindowGroup *)iSibling;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowGroup *CWsWindowGroup::PrevSibling() const
sl@0: 	{
sl@0: 	return (CWsWindowGroup *)GetPrevSibling();
sl@0: 	}
sl@0: 
sl@0: inline CWsRootWindow *CWsWindowGroup::Parent() const
sl@0: 	{
sl@0: 	return (CWsRootWindow *)iParent;
sl@0: 	}
sl@0: 
sl@0: inline TBool CWsWindowGroup::ReceivesFocus() const
sl@0: 	{
sl@0: 	return(iFlags&EGroupFlagReceivesFocus);
sl@0: 	}
sl@0: 
sl@0: inline RWsTextCursor *CWsWindowGroup::TextCursor()
sl@0: 	{
sl@0: 	return &iTextCursor;
sl@0: 	}
sl@0: 
sl@0: inline HBufC *CWsWindowGroup::GroupName()
sl@0: 	{
sl@0: 	return iGroupName;
sl@0: 	}
sl@0: 
sl@0: inline void CWsWindowGroup::SetNextDefaultOwningWindow(CWsWindowGroup *aNext)
sl@0: 	{
sl@0: 	iNextDefaultOwningWindow=aNext;
sl@0: 	}
sl@0: 
sl@0: inline CWsWindowGroup **CWsWindowGroup::NextDefaultOwningWindowPtr()
sl@0: 	{
sl@0: 	return &iNextDefaultOwningWindow;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A pointer to the DWsScreenDevice used by this window-group, or 
sl@0: 		NULL when there is no DWsScreenDevice used by the window-group.
sl@0: */
sl@0: inline DWsScreenDevice *CWsWindowGroup::Device()
sl@0: 	{
sl@0: 	return iScreenDevice;
sl@0: 	}
sl@0: 
sl@0: inline void CWsWindowGroup::SetFocusGainPreprocessing(TBool aDo)
sl@0: 	{
sl@0: 	iFocusGainPreProcess=aDo;
sl@0: 	}
sl@0: 
sl@0: inline void CWsWindowGroup::SetScreenDeviceDeleted()
sl@0: 	{
sl@0: 	iFlags|=EGroupFlagScreenDeviceDeleted;
sl@0: 	iScreenDevice = NULL; //  PDEF100409
sl@0: 	}
sl@0: 
sl@0: inline TBool CWsWindowGroup::ScreenDeviceDeleted() const
sl@0: 	{
sl@0: 	return (iFlags&EGroupFlagScreenDeviceDeleted);
sl@0: 	}
sl@0: 
sl@0: #endif