|
sl@0
|
1 |
// Copyright (c) 1994-2010 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#ifndef GRAPHICDRAWER_INTERNAL_H
|
|
sl@0
|
17 |
#define GRAPHICDRAWER_INTERNAL_H
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
class MWsAnimationScheduler: public MWsObjectProvider
|
|
sl@0
|
20 |
/** A system mechanism for customising the animation timer to a particular hardware variant or to a
|
|
sl@0
|
21 |
particular external compositor e.g. an out-of-scene transition engine.
|
|
sl@0
|
22 |
The default animation scheduler in WSERV does not understand device-dependant parameters e.g.
|
|
sl@0
|
23 |
screen refresh rates
|
|
sl@0
|
24 |
@internalComponent
|
|
sl@0
|
25 |
@released
|
|
sl@0
|
26 |
*/ {
|
|
sl@0
|
27 |
public:
|
|
sl@0
|
28 |
/** Called to schedule an animation event for a screen to occur not before some point
|
|
sl@0
|
29 |
A screen may be scheduled to animate several times without actually receiving an animation event from the scheduler
|
|
sl@0
|
30 |
If the scheduler cannot honour the request e.g. device constraints, it ignores the request.
|
|
sl@0
|
31 |
@param aScreen the screen to recieve the event
|
|
sl@0
|
32 |
@param aWhen the point in time the event need not occur before
|
|
sl@0
|
33 |
*/
|
|
sl@0
|
34 |
virtual void ScheduleAnimation(MWsScreen& aScreen,const TTime& aWhen) = 0;
|
|
sl@0
|
35 |
/** Called if a screen determines that it no longer needs to schedule any animation
|
|
sl@0
|
36 |
@param aScreen the screen not needing to receive any animation events
|
|
sl@0
|
37 |
*/
|
|
sl@0
|
38 |
virtual void UnscheduleAnimation(MWsScreen& aScreen) = 0;
|
|
sl@0
|
39 |
/** Called to schedule the redrawing of all screens containing this graphic.
|
|
sl@0
|
40 |
The redrawing of affected screens can be deferred by the scheduler.
|
|
sl@0
|
41 |
@param aId the ID of the graphic to be redrawn. The graphic itself need not exist
|
|
sl@0
|
42 |
(e.g. it has just been deleted, hence the need to redraw all potentially affected screens). */
|
|
sl@0
|
43 |
virtual void Invalidate(const TGraphicDrawerId& aId) = 0;
|
|
sl@0
|
44 |
/** Called when the Window Server receives a TRawEvent::EInactive event, to signal power-saving */
|
|
sl@0
|
45 |
virtual void OnInactive() = 0;
|
|
sl@0
|
46 |
/** Called when the Window Server receives a TRawEvent::EActive event, to signal screen back on */
|
|
sl@0
|
47 |
virtual void OnActive() = 0;
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
/** Called to schedule a redraw for a screen which is out of date
|
|
sl@0
|
50 |
A screen may be scheduled to redraw several times without actually receiving aredraw event from the scheduler
|
|
sl@0
|
51 |
If this request is ignored then the screen will be draw incorrectly untill a such a request is not ignored.
|
|
sl@0
|
52 |
@param aScreen the screen to recieve the event
|
|
sl@0
|
53 |
@param aWhen the point in time the event need not occur before
|
|
sl@0
|
54 |
*/
|
|
sl@0
|
55 |
virtual void ScheduleRedraw(MWsScreen& aScreen,const TTime& aWhen) = 0;
|
|
sl@0
|
56 |
/** Called to force a previously scheduled redraw for a screen to happen immediately.
|
|
sl@0
|
57 |
Used when we are about to loose our ability to perform the redraw correctly.
|
|
sl@0
|
58 |
@param aScreen the screen to recieve the event
|
|
sl@0
|
59 |
*/
|
|
sl@0
|
60 |
virtual void DoRedrawNow(MWsScreen& aScreen) = 0;
|
|
sl@0
|
61 |
|
|
sl@0
|
62 |
/** Interface to be implemented by callers of the asynchronous overload of
|
|
sl@0
|
63 |
DoRedrawNow, which takes a reference to this interface as argument to be able
|
|
sl@0
|
64 |
to give a callback once the screen update has been completed.
|
|
sl@0
|
65 |
*/
|
|
sl@0
|
66 |
class MScreenUpdateObserver
|
|
sl@0
|
67 |
{
|
|
sl@0
|
68 |
public:
|
|
sl@0
|
69 |
/** Callback when an asynchronous DoRedrawNow has been completed. */
|
|
sl@0
|
70 |
virtual void ScreenUpdateComplete(TInt aResult) = 0;
|
|
sl@0
|
71 |
};
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/** Called to force a previously scheduled redraw for a screen to happen immediately.
|
|
sl@0
|
74 |
@param aScreen the screen to recieve the event
|
|
sl@0
|
75 |
@param aObserver reference which will receive a notification when the screen has been updated
|
|
sl@0
|
76 |
*/
|
|
sl@0
|
77 |
virtual void DoRedrawNow(MWsScreen& aScreen, MScreenUpdateObserver& aObserver) = 0;
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
/** Callback to use if aObserver gets deleted before screen update takes place. */
|
|
sl@0
|
80 |
virtual void ClearScreenUpdateObserver(const MScreenUpdateObserver& aObserver) = 0;
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
protected:
|
|
sl@0
|
83 |
IMPORT_C void Animate(MWsScreen& aScreen);
|
|
sl@0
|
84 |
IMPORT_C void Animate(MWsScreen& aScreen, TRequestStatus* aFinished);
|
|
sl@0
|
85 |
IMPORT_C void Redraw(MWsScreen& aScreen);
|
|
sl@0
|
86 |
IMPORT_C TBool RedrawInvalid(MWsScreen& aScreen,const TArray<TGraphicDrawerId>& aInvalid);
|
|
sl@0
|
87 |
};
|
|
sl@0
|
88 |
|
|
sl@0
|
89 |
#endif |