sl@0: // Copyright (c) 1994-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: // Window functions
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include "server.h"
sl@0: #include "rootwin.h"
sl@0: #include "window.h"
sl@0: #include "walkwindowtree.h"
sl@0: #include "wstop.h"
sl@0: #include "ScrDev.H"
sl@0: #include "EVENT.H"
sl@0: #include "ANIM.H"
sl@0: #include "Direct.H"
sl@0: #include "panics.h"
sl@0: #include "backedupwindow.h"
sl@0: #include "wstypes.h"
sl@0: #include "offscreenbitmap.h"
sl@0: 
sl@0: CWsWindow* CWsWindow::iAccessListRecentEnd = 0;
sl@0: CWsWindow* CWsWindow::iAccessListOldestEnd = 0;
sl@0: 
sl@0: CWsWindow::CWsWindow(CWsClient* aOwner,WH_HANDLES aType, CScreen* aScreen) : CWsWindowBase(aOwner,aType,aScreen),
sl@0: 	iFlags(EFlagHidden),
sl@0: 	 iDSAs(_FOFF(CWsDirectScreenAccess,iMultipleDSALink))
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CWsWindow::~CWsWindow()
sl@0: 	{
sl@0: 	iFadableRegion.Close();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::Construct()
sl@0: 	{
sl@0: 	InsertIntoAccessListOldestEnd();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::Shutdown()
sl@0: 	{
sl@0: 	TWindowServerEvent::NotifyDrawer(TWservCrEvent(TWservCrEvent::EWindowClosing, 0, 0, this));
sl@0: 	RemoveFromAccessList();	
sl@0: 	CWsAnim::WindowClosing(iAnimList);	// Destroy any animated objects attached to this window
sl@0: 	iVisibleRegion.Close();
sl@0: 	iScheduledRegion.Close();
sl@0: 	AbortAllDSAs();
sl@0: 	CWsWindowBase::Shutdown();
sl@0: 	SetPointerCursor(NULL);
sl@0: 	delete iRedraw;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Region and invalid area functions //
sl@0: //
sl@0: 
sl@0: TRect CWsWindow::FullRect() const
sl@0: 	{
sl@0: 	return(TRect(iOrigin,iRel.Size()));
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Normal regions //
sl@0: //
sl@0: 
sl@0: void CWsWindow::SetNonFading(TBool aNonFade)
sl@0: 	{
sl@0: 	if (aNonFade)
sl@0: 		iFlags|=EFlagNonFadingWindow;
sl@0: 	else
sl@0: 		iFlags&=(~EFlagNonFadingWindow);
sl@0: 	}
sl@0: 
sl@0: TPoint CWsWindow::InquireOffset(TUint32 aHandle) const
sl@0: 	{
sl@0: 	CWsWindowBase *win2;
sl@0: 	iWsOwner->HandleToWindow(aHandle,&win2);
sl@0: 	return(iOrigin-win2->Origin());
sl@0: 	}
sl@0: 
sl@0: TDisplayMode CWsWindow::DisplayMode() const
sl@0: 	{
sl@0: 	return iScreen->DisplayMode();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::StatusDump(TDes &aBuf)
sl@0: 	{
sl@0: 	_LIT(KStatusString1,"CWsWindow[0x%x]RWindow[0x%x,%d],Pos(%d,%d),Size(%d,%d)");
sl@0: 	_LIT(KStatusString3,",Mode=%d");
sl@0: 	_LIT(KStatusInvisible,",Inv");
sl@0: 	aBuf.AppendFormat(KStatusString1,this,iClientHandle,LogHandle(),iRel.iTl.iX,iRel.iTl.iY,Size().iWidth,Size().iHeight);
sl@0: 	aBuf.AppendFormat(KStatusString3,(TInt)iScreen->DisplayMode());
sl@0: 	if (!IsVisible())
sl@0: 		aBuf.Append(KStatusInvisible);
sl@0: 	}
sl@0: 
sl@0: TDblQue<TPointerKeyList> *CWsWindow::PointerKeyList() const
sl@0: 	{
sl@0: 	return(NULL);
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::AbortAllDSAs()
sl@0: 	{
sl@0: 	iScreen->AbortDSAs(RDirectScreenAccess::ETerminateRegion,iDSAs);
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::PossibleVisibilityChangedEvent(TBool aForceSend)
sl@0: 	{
sl@0: 	// notify plugin
sl@0: 	//
sl@0: 	TWservCrEvent crEvent(TWservCrEvent::EWindowVisibilityChanged, HasBeenDrawnToScreen(), IsVisible()? &iVisibleRegion : NULL, this);
sl@0: 	TWindowServerEvent::NotifyDrawer(crEvent);
sl@0: 	
sl@0: 	if (!(iFlags & EFlagGeneratesVisibilityEvents))
sl@0: 		return;
sl@0: 
sl@0: 	if (!IsVisible())
sl@0: 		{
sl@0: 		goto notvisible;
sl@0: 		}
sl@0: 
sl@0: 	if (iVisibleRegion.Count() == 0)
sl@0: 		{
sl@0: 		goto notvisible;
sl@0: 		}
sl@0: 
sl@0: 		{// braces here to avoid gccxml error
sl@0: 		TInt visibleArea = 0;
sl@0: 		TInt count = iVisibleRegion.Count();
sl@0: 		TInt ii;
sl@0: 		for (ii = 0; ii < count; ii++)
sl@0: 			{
sl@0: 			visibleArea+= iVisibleRegion[ii].Width() * iVisibleRegion[ii].Height();
sl@0: 			}
sl@0: 
sl@0: 		const TRegion* baseRegion = (static_cast<CWsClientWindow*>(this))->BaseArea();
sl@0: 		TInt baseArea = 0;
sl@0: 		count = baseRegion->Count();
sl@0: 		for (ii = 0; ii < count; ii++)
sl@0: 			{
sl@0: 			const TRect& rect = (*baseRegion)[ii];
sl@0: 			baseArea+= rect.Width() * rect.Height();
sl@0: 			}
sl@0: 
sl@0: 		if (visibleArea == baseArea)
sl@0: 			{
sl@0: 			goto fullyvisible;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			goto partiallyvisible;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: fullyvisible:
sl@0: 	if (aForceSend || !(iFlags & EFlagNotCantBeSeen) || !(iFlags & EFlagCanBeSeen))
sl@0: 		{
sl@0: 		iFlags |= (EFlagCanBeSeen | EFlagNotCantBeSeen);
sl@0: 		TWindowServerEvent::SendVisibilityChangedEvents(this, TWsVisibilityChangedEvent::EPartiallyVisible | TWsVisibilityChangedEvent::EFullyVisible);
sl@0: 		// we have to set EPartiallyVisible too for compatibility reasons
sl@0: 		}
sl@0: 	return;
sl@0: 
sl@0: partiallyvisible:
sl@0: 	if (aForceSend || !(iFlags & EFlagCanBeSeen) || (iFlags & EFlagNotCantBeSeen))
sl@0: 		{
sl@0: 		iFlags |= EFlagCanBeSeen;
sl@0: 		iFlags &= ~EFlagNotCantBeSeen;
sl@0: 		TWindowServerEvent::SendVisibilityChangedEvents(this, TWsVisibilityChangedEvent::EPartiallyVisible);
sl@0: 		}
sl@0: 	return;
sl@0: 
sl@0: notvisible:
sl@0: 	if (aForceSend || (iFlags & EFlagCanBeSeen) || (iFlags & EFlagNotCantBeSeen))
sl@0: 		{
sl@0: 		iFlags &= ~(EFlagCanBeSeen | EFlagNotCantBeSeen);
sl@0: 		TWindowServerEvent::SendVisibilityChangedEvents(this, TWsVisibilityChangedEvent::ENotVisible);
sl@0: 		}
sl@0: 	return;
sl@0: 	}
sl@0: 
sl@0: TPoint CWsWindow::Origin() const
sl@0: 	{
sl@0: 	return iOrigin;
sl@0: 	}
sl@0: 
sl@0: TRect CWsWindow::AbsRect() const
sl@0: 	{
sl@0: 	return iAbs;
sl@0: 	}
sl@0: 	
sl@0: TSize CWsWindow::Size() const
sl@0: 	{
sl@0: 	return iRel.Size();
sl@0: 	}
sl@0: 
sl@0: TBool CWsWindow::SetScheduledRegion(const RWsRegion& aRegion)
sl@0: 	{
sl@0: 	iScheduledRegion.Copy(aRegion);
sl@0: 	return !iScheduledRegion.CheckError();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::ClearScheduledRegion()
sl@0: 	{
sl@0: 	iScheduledRegion.Clear();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::SetFadeBehind(TBool aFade)
sl@0: 	{
sl@0: 	if (aFade != ((iFlags & EFlagFadeBehind) != 0))
sl@0: 		{
sl@0: 		iFlags ^= EFlagFadeBehind;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::FocusChanged(TBool aNewFocusState)
sl@0: 	{
sl@0: 	TRAPD(err,FocusChangedL(aNewFocusState));
sl@0: 	if (err!=KErrNone)
sl@0: 		OwnerPanic(EWservPanicAnimLeave);
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::FocusChangedL(TBool aNewFocusState)
sl@0: 	{
sl@0: 	for (CWsAnim * anim = iAnimList; anim; anim = anim->Next())
sl@0: 		{
sl@0: 		anim->FocusChanged(aNewFocusState);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: // Moves a window to the recent end of the accessed list
sl@0: void CWsWindow::Accessed()
sl@0: 	{
sl@0: 	WS_ASSERT_DEBUG(iAccessListRecentEnd && iAccessListOldestEnd, EWsPanicAccessList);
sl@0: 
sl@0: 	RemoveFromAccessList();	
sl@0: 	InsertIntoAccessListRecentEnd();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::InsertIntoAccessListOldestEnd()
sl@0: 	{
sl@0: 	iAccessListPrev = 0;
sl@0: 	iAccessListNext = iAccessListOldestEnd;
sl@0: 	if (iAccessListNext)
sl@0: 		iAccessListNext->iAccessListPrev = this;
sl@0: 	iAccessListOldestEnd = this;
sl@0: 	if (!iAccessListRecentEnd)
sl@0: 		iAccessListRecentEnd = this;
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::InsertIntoAccessListRecentEnd()
sl@0: 	{
sl@0: 	iAccessListNext = 0;
sl@0: 	iAccessListPrev = iAccessListRecentEnd;
sl@0: 	if (iAccessListPrev)
sl@0: 		iAccessListPrev->iAccessListNext = this;
sl@0: 	iAccessListRecentEnd = this;
sl@0: 	if (!iAccessListOldestEnd)
sl@0: 		iAccessListOldestEnd = this;
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::RemoveFromAccessList()
sl@0: 	{
sl@0: 	if (iAccessListOldestEnd == this)
sl@0: 		iAccessListOldestEnd = iAccessListNext;
sl@0: 	if (iAccessListRecentEnd == this)
sl@0: 		iAccessListRecentEnd = iAccessListPrev;
sl@0: 	if (iAccessListPrev)
sl@0: 		iAccessListPrev->iAccessListNext = iAccessListNext;
sl@0: 	if (iAccessListNext)
sl@0: 		iAccessListNext->iAccessListPrev = iAccessListPrev;
sl@0: 	}
sl@0: 	
sl@0: TBool CWsWindow::ReleaseMemory(MWsMemoryRelease::TMemoryReleaseLevel aLevel)
sl@0: 	{
sl@0: 	for (CWsWindow * access = iAccessListOldestEnd; access; access = access->iAccessListNext)
sl@0: 		{
sl@0: 		if(access->Redraw())
sl@0: 			{
sl@0: 			if (access->Redraw()->ReleaseMemory(aLevel))
sl@0: 				return ETrue;
sl@0: 			}
sl@0: 		}
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: const TRegion& CWsWindow::VisibleRegion() const
sl@0: 	{
sl@0: 	return(iVisibleRegion);
sl@0: 	}
sl@0: 
sl@0: TBool CWsWindow::IsDSAHost() const
sl@0: 	{
sl@0: 	TBool res = EFalse; 
sl@0: 	if ( !iDSAs.IsEmpty() )
sl@0: 		{
sl@0: 		TSglQueIter<CWsDirectScreenAccess> iter( (TSglQueBase&)iDSAs );
sl@0: 		iter.SetToFirst();
sl@0: 		CWsDirectScreenAccess* dsa;
sl@0: 		while ( (dsa = iter++) != NULL && !res )
sl@0: 			{
sl@0: 			res = dsa->IsVisible() || dsa->IsSyncTimeoutPending();
sl@0: 			}
sl@0: 		}
sl@0: 	return res;
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::ResetVisibleRegion()
sl@0: 	{
sl@0: 	if (!iVisibleRegion.IsEmpty())
sl@0: 		{
sl@0: 		iVisibleRegion.Clear();
sl@0: 		}
sl@0: 	iFadableRegion.Clear();
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::SetVisibleRegion(const TRegion& aNewRegion, const TRegion* aTop, TRegion& aNewFadableRegion)
sl@0: 	{
sl@0: 	STACK_REGION difference;
sl@0: 	TBool diffs = EFalse;
sl@0: 
sl@0: 	difference.Copy(iVisibleRegion);
sl@0: 	difference.SubRegion(aNewRegion);
sl@0: 	if (!difference.IsEmpty())
sl@0: 		{
sl@0: 		diffs = ETrue;
sl@0: 		if (IsTranslucent())
sl@0: 			{
sl@0: 			// Andy - If this is a client window (what else could it be) we can also subtract the
sl@0: 			// user defined opaque region before doing this:
sl@0: 			iScreen->AddRedrawRegion(difference, EFalse);
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	difference.Copy(aNewRegion);
sl@0: 	if (HasBeenDrawnToScreen())
sl@0: 		{
sl@0: 		difference.SubRegion(iVisibleRegion);
sl@0: 		}
sl@0: 	if (!difference.IsEmpty())
sl@0: 		{
sl@0: 		diffs = ETrue;
sl@0: 		STACK_REGION topDiff;
sl@0: 		topDiff.Copy(difference);
sl@0: 		WS_ASSERT_DEBUG(aTop,EWsPanicRegion);
sl@0: 		topDiff.Intersect(*aTop);
sl@0: 		difference.SubRegion(topDiff);
sl@0: 		iScreen->AddRedrawRegion(topDiff, EFalse, ERedrawTopOnly);
sl@0: 		iScreen->AddRedrawRegion(difference, EFalse, ERedrawAll);
sl@0: 		topDiff.Close();
sl@0: 		}
sl@0: 
sl@0: 	difference.Close();
sl@0: 
sl@0: 	AbortDsaIfRequired(aNewRegion, aTop);
sl@0: 
sl@0: 	if (diffs)
sl@0: 		{
sl@0: 		ResetVisibleRegion();
sl@0: 		iVisibleRegion.Copy(aNewRegion);
sl@0: 		PossibleVisibilityChangedEvent(EFalse);
sl@0: 		}
sl@0: 
sl@0: 	iFadableRegion.Copy( aNewFadableRegion );
sl@0: 	
sl@0: 	// Just because the visible region (screen coordinates) didn't change doesn't
sl@0: 	// mean the invalid region (window coordinates) didn't change, so we always call this.
sl@0: 	iRedraw->VisibleRegionChange();
sl@0: 	}
sl@0: 	
sl@0: void CWsWindow::ClearVisibleRegion()
sl@0: 	{
sl@0: 	AbortAllDSAs();         
sl@0: 	iScreen->AddRedrawRegion(VisibleRegion(), EFalse);
sl@0: 	ResetVisibleRegion();
sl@0: 	PossibleVisibilityChangedEvent(EFalse);
sl@0: 	iFlags &= ~EFlagDrawnToScreen;
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::AbortDsaIfRequired(const TRegion& aNewRegion, const TRegion* aTop)
sl@0: 	{
sl@0: 	if (!iDSAs.IsEmpty())
sl@0: 		{
sl@0: 		// If the top visible region of this window has changed, DSA clients may need
sl@0: 		// to be sent a DSA abort, as they may be drawing to a different region
sl@0: 		STACK_REGION newTopVisible;
sl@0: 		newTopVisible.Copy(aNewRegion); // new visible region
sl@0: 		if (aTop!=NULL)
sl@0: 			{
sl@0: 			newTopVisible.Intersect(*aTop); // area of new visible region not obscured by any other opaque or translucent windows
sl@0: 			}
sl@0: 		// Build a list of DSA clients that need to be sent a DSA abort
sl@0: 		TSglQue<CWsDirectScreenAccess> dsaList(_FOFF(CWsDirectScreenAccess,iAbortLink));
sl@0: 		TSglQueIter<CWsDirectScreenAccess> iter(iDSAs);
sl@0: 		CWsDirectScreenAccess* dsa;
sl@0: 		while ((dsa=iter++)!=NULL)
sl@0: 			{
sl@0: 			if (dsa->IsAbortRequired(newTopVisible))
sl@0: 				{
sl@0: 				dsaList.AddLast(*dsa);
sl@0: 				}
sl@0: 			}
sl@0: 		if (!dsaList.IsEmpty())
sl@0: 			{
sl@0: 			iScreen->AbortDSAs(RDirectScreenAccess::ETerminateRegion, dsaList);
sl@0: 			}
sl@0: 		newTopVisible.Close();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: const TRegion* CWsWindow::VisibleRegionIfValid() const
sl@0: 	{
sl@0: 	return iVisibleRegion.CheckError() ? NULL : &iVisibleRegion;
sl@0: 	}
sl@0: 	
sl@0: TBool CWsWindow::ReadyToDraw() const
sl@0: 	{
sl@0: 	return iRedraw->ReadyToDraw();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: This function draws the region specified
sl@0: Andy - I would be happier if no region was specified here - the GC should incorporate that information
sl@0: */
sl@0: void CWsWindow::Render(CFbsBitGc * aGc, const TRegion& aRegion)
sl@0: 	{
sl@0: 	WS_ASSERT_DEBUG(IsVisible() || (WinType() == EWinTypeRoot), EWsPanicScheduledRedraw);
sl@0: 	
sl@0: 	Accessed();
sl@0: 	iFlags |= EFlagDrawnToScreen;
sl@0: 	
sl@0: 	iRedraw->PreDrawWindow(aGc, aRegion);
sl@0: 	iRedraw->DrawWindow();
sl@0: 	iRedraw->PostDrawWindow(aGc);
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::SetNextScheduled(CWsWindow * aWin)
sl@0: 	{
sl@0: 	iNextScheduled = aWin;
sl@0: 	}
sl@0: 	
sl@0: CWsWindow * CWsWindow::NextScheduled()  const
sl@0: 	{
sl@0: 	return iNextScheduled;
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::AddSprite(CWsSpriteBase * aSprite)
sl@0: 	{
sl@0: 	aSprite->SetNext(iSpriteList);
sl@0: 	iSpriteList = aSprite;
sl@0: 	}
sl@0: 	
sl@0: void CWsWindow::RemoveSprite(CWsSpriteBase * aSprite)
sl@0: 	{
sl@0: 	if (aSprite == iSpriteList)
sl@0: 		{
sl@0: 		iSpriteList = aSprite->Next();
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		for (CWsSpriteBase * sprite = iSpriteList; sprite; sprite = sprite->Next())
sl@0: 			{
sl@0: 			if (sprite->Next() == aSprite)
sl@0: 				{
sl@0: 				sprite->SetNext(aSprite->Next());
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	aSprite->SetNext(0);
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::DeactivateAllSprites()
sl@0: 	{
sl@0: 	CWsSpriteBase * current = iSpriteList;
sl@0: 	while (current)
sl@0: 		{
sl@0: 		CWsSpriteBase * next = current->Next();
sl@0: 		current->Deactivate();
sl@0: 		current = next;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CWsWindow::ClipRectToViewport(TRect& aRect) const
sl@0: 	{
sl@0: 	const CWsWindowBase * win = this;
sl@0: 	while (win)
sl@0: 		{
sl@0: 		if (win->WinType() != EWinTypeGroup)
sl@0: 			{
sl@0: 			aRect.Intersection(win->AbsRect());
sl@0: 			}
sl@0: 		win = win->BaseParent();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: const TRegion& CWsWindow::FadableRegion() const
sl@0: 	{
sl@0: 	return iFadableRegion;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: MWsWindow
sl@0: */
sl@0: MWsWindow * CWsWindow::FindChildByHandle(TUint32 aHandle)
sl@0: 	{
sl@0: 	TWalkWindowTreeFindByHandle wwt(aHandle);
sl@0: 	WalkWindowTree(wwt, EWalkChildren);
sl@0: 	return wwt.Found();
sl@0: 	}
sl@0: 
sl@0: TUint32 CWsWindow::Handle() const
sl@0: 	{
sl@0: 	return ClientHandle();
sl@0: 	}
sl@0: 
sl@0: MWsScreen * CWsWindow::WsScreen() const
sl@0: 	{
sl@0: 	return iScreen;
sl@0: 	}
sl@0: 
sl@0: TInt CWsWindow::OrdinalPriority() const
sl@0: 	{
sl@0: 	return iOrdinalPriority;
sl@0: 	}