sl@0: // Copyright (c) 1994-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: //
sl@0: 
sl@0: #ifndef GRAPHICDRAWER_INTERNAL_H
sl@0: #define GRAPHICDRAWER_INTERNAL_H
sl@0: 
sl@0: class MWsAnimationScheduler: public MWsObjectProvider
sl@0: /** A system mechanism for customising the animation timer to a particular hardware variant or to a
sl@0: 	particular external compositor e.g. an out-of-scene transition engine.
sl@0: 	The default animation scheduler in WSERV does not understand device-dependant parameters e.g.
sl@0: 	screen refresh rates
sl@0: 	@internalComponent
sl@0: 	@released
sl@0: */	{
sl@0: public:
sl@0: 	/** Called to schedule an animation event for a screen to occur not before some point
sl@0: 	A screen may be scheduled to animate several times without actually receiving an animation event from the scheduler
sl@0: 	If the scheduler cannot honour the request e.g. device constraints, it ignores the request.
sl@0: 	@param aScreen the screen to recieve the event
sl@0: 	@param aWhen the point in time the event need not occur before
sl@0: 	*/
sl@0: 	virtual void ScheduleAnimation(MWsScreen& aScreen,const TTime& aWhen) = 0;
sl@0: 	/** Called if a screen determines that it no longer needs to schedule any animation
sl@0: 	@param aScreen the screen not needing to receive any animation events
sl@0: 	*/
sl@0: 	virtual void UnscheduleAnimation(MWsScreen& aScreen) = 0;
sl@0: 	/** Called to schedule the redrawing of all screens containing this graphic.
sl@0: 	The redrawing of affected screens can be deferred by the scheduler.
sl@0: 	@param aId the ID of the graphic to be redrawn.  The graphic itself need not exist
sl@0: 		(e.g. it has just been deleted, hence the need to redraw all potentially affected screens). */
sl@0: 	virtual void Invalidate(const TGraphicDrawerId& aId) = 0;
sl@0: 	/** Called when the Window Server receives a TRawEvent::EInactive  event, to signal power-saving */
sl@0: 	virtual void OnInactive() = 0;
sl@0: 	/** Called when the Window Server receives a TRawEvent::EActive event, to signal screen back on */
sl@0: 	virtual void OnActive() = 0;
sl@0: 
sl@0: 	/** Called to schedule a redraw for a screen which is out of date
sl@0: 	A screen may be scheduled to redraw several times without actually receiving aredraw event from the scheduler
sl@0: 	If this request is ignored then the screen will be draw incorrectly untill a such a request is not ignored.
sl@0: 	@param aScreen the screen to recieve the event
sl@0: 	@param aWhen the point in time the event need not occur before
sl@0: 	*/
sl@0: 	virtual void ScheduleRedraw(MWsScreen& aScreen,const TTime& aWhen) = 0;
sl@0: 	/** Called to force a previously scheduled redraw for a screen to happen immediately.
sl@0: 	Used when we are about to loose our ability to perform the redraw correctly.
sl@0: 	@param aScreen the screen to recieve the event
sl@0: 	*/
sl@0: 	virtual void DoRedrawNow(MWsScreen& aScreen) = 0;
sl@0: 	
sl@0: 	/** Interface to be implemented by callers of the asynchronous overload of 
sl@0: 	DoRedrawNow, which takes a reference to this interface as argument to be able 
sl@0: 	to give a callback once the screen update has been completed.
sl@0: 	*/
sl@0: 	class MScreenUpdateObserver 
sl@0: 		{
sl@0: 	public:
sl@0: 		/** Callback when an asynchronous DoRedrawNow has been completed. */
sl@0: 		virtual void ScreenUpdateComplete(TInt aResult) = 0;
sl@0: 		};
sl@0: 	
sl@0: 	/** Called to force a previously scheduled redraw for a screen to happen immediately. 
sl@0: 	@param aScreen the screen to recieve the event
sl@0: 	@param aObserver reference which will receive a notification when the screen has been updated
sl@0: 	*/
sl@0: 	virtual void DoRedrawNow(MWsScreen& aScreen, MScreenUpdateObserver& aObserver) = 0;
sl@0: 	
sl@0: 	/** Callback to use if aObserver gets deleted before screen update takes place. */
sl@0: 	virtual void ClearScreenUpdateObserver(const MScreenUpdateObserver& aObserver) = 0;
sl@0: 
sl@0: protected:
sl@0: 	IMPORT_C void Animate(MWsScreen& aScreen);
sl@0: 	IMPORT_C void Animate(MWsScreen& aScreen, TRequestStatus* aFinished);
sl@0: 	IMPORT_C void Redraw(MWsScreen& aScreen);
sl@0: 	IMPORT_C TBool RedrawInvalid(MWsScreen& aScreen,const TArray<TGraphicDrawerId>& aInvalid);
sl@0: 	};
sl@0: 	
sl@0: #endif