MWsGraphicDrawerEnvironment Class Reference

class MWsGraphicDrawerEnvironment : public MWsObjectProvider

The environment for a graphic drawer

Inherits from

Member Functions Documentation

ClearCustomAnimationScheduler(MWsAnimationScheduler *)

TBool ClearCustomAnimationScheduler(MWsAnimationScheduler *aCurrentScheduler)[pure virtual]

Clears a custom animation scheduler

Parameters

MWsAnimationScheduler * aCurrentScheduler

HasCustomAnimationScheduler()

TBool HasCustomAnimationScheduler()const [pure virtual]

Query whether a custom animation scheduler has been set

Invalidate(const TGraphicDrawerId &)

voidInvalidate(const TGraphicDrawerId &aId)[protected, pure virtual]

Schedules all potentially affected parts of the screen to repaint This is called automatically whenever a graphic is added, replaced or removed. However, if a graphic which changes representation during runtime must call this explicitly. Note: this is not a suitable method for animating a graphic. For animation, use MWsGc::Invalidate when the graphic is being drawn to schedule the next animation frame instead.

Parameters

const TGraphicDrawerId & aIdthe ID of the artwork; the artwork may not exist

Log(TInt, const TDesC &, TInt)

voidLog(TIntaPriority,
const TDesC &aFmt,
TIntaParam = 0
)[pure virtual]

Logs a message to the wserv logger, if one is loaded

Parameters

TInt aPriorityThe priority of the message - low priority is 1, high is 9
const TDesC & aFmtThe string to log. This may contain a single d, x or equivalent
TInt aParam = 0An integer parameter corresponding to a d, if present

RegisterEventHandler(CWsGraphicDrawer *, MWsEventHandler *, TUint32)

TInt RegisterEventHandler(CWsGraphicDrawer *aDrawer,
MWsEventHandler *aHandler,
TUint32aEventMask
)[pure virtual]

Register to be notified when some events occur.

Parameters

CWsGraphicDrawer * aDrawer
MWsEventHandler * aHandler
TUint32 aEventMask

RegisterMemoryRelease(MWsMemoryRelease *)

TInt RegisterMemoryRelease(MWsMemoryRelease *aMemoryRelease)[pure virtual]

Registers an interface for releasing memory in low memory situations. The release function may be called as a result of any Alloc or ReAlloc attempts in the window server process.

Parameters

MWsMemoryRelease * aMemoryReleasea callback interface

RegisterWsEventHandler(MWsEventHandler *, TUint32)

TInt RegisterWsEventHandler(MWsEventHandler *aHandler,
TUint32aEventMask
)[pure virtual]

Register to be notified when some events occur.

Parameters

MWsEventHandler * aHandler
TUint32 aEventMask

ResolveGraphic(const TGraphicDrawerId &)

const CWsGraphicDrawer *ResolveGraphic(const TGraphicDrawerId &aId)const [pure virtual]

Locate a graphic by ID

Parameters

const TGraphicDrawerId & aId

Screen(TInt)

MWsScreen *Screen(TIntaIndex)[pure virtual]

Get a particular screen by ordinal

Parameters

TInt aIndex

Screen(TInt)

const MWsScreen *Screen(TIntaIndex)const [pure virtual]

Get a particular screen by ordinal

Parameters

TInt aIndex

ScreenCount()

TInt ScreenCount()const [pure virtual]

The number of screens the device has; this is constant for a device

SetCustomAnimationScheduler(MWsAnimationScheduler *)

TBool SetCustomAnimationScheduler(MWsAnimationScheduler *aScheduler)[pure virtual]

Not supported

Parameters

MWsAnimationScheduler * aScheduler

UnregisterEventHandler(CWsGraphicDrawer *)

TInt UnregisterEventHandler(CWsGraphicDrawer *aDrawer)[pure virtual]

Unregister from events notification

Parameters

CWsGraphicDrawer * aDrawer

UnregisterMemoryRelease(MWsMemoryRelease *)

voidUnregisterMemoryRelease(MWsMemoryRelease *aMemoryRelease)[pure virtual]

Removes a registration set by RegisterMemoryRelease

Parameters

MWsMemoryRelease * aMemoryReleasethe registered release object to remove

UnregisterWsEventHandler(MWsEventHandler *)

TInt UnregisterWsEventHandler(MWsEventHandler *aHandler)[pure virtual]

Unregister from events notification

Parameters

MWsEventHandler * aHandler