Collapse all Symbian^3 Application Developer Library

MWsGc Class Reference

class MWsGc : public MWsObjectProvider

A destination for a drawing occasion of a CWsGraphicDrawer Used to register invalidation schedules for animation

Inherits from

MWsGc
- MWsObjectProvider

Public Member Functions
CFbsBitGc &	BitGc ()
MWsClient &	Client ()
const TRegion &	ClippingRegion ()
TPoint	GcOrigin ()
const TTime &	Now ()
void	PopBitGcSettings ()
TInt	PushBitGcSettings ()
void	ScheduleAnimation (const TRect &, const TTimeIntervalMicroSeconds &)
void	ScheduleAnimation (const TRect &, const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)
MWsScreen &	Screen ()
void	SetGcOrigin (const TPoint &)

Inherited Functions
	MWsObjectProvider::ObjectInterface()
	MWsObjectProvider::ObjectInterface()const
	MWsObjectProvider::ResolveObjectInterface(TUint)

Member Functions Documentation

BitGc()

CFbsBitGc &

BitGc

(

)

[pure virtual]

The BITGDI graphics context to draw to

Client()

MWsClient &

Client

(

)

[pure virtual]

The Client requesting this drawing occasion

ClippingRegion()

const TRegion &

ClippingRegion

(

)

[pure virtual]

The clipping region currently being used

GcOrigin()

TPoint

GcOrigin

(

)

const [pure virtual]

The origin of the GC relative to the screen's origin

Now()

const TTime &

Now

(

)

const [pure virtual]

The time for the current redraw

PopBitGcSettings()

void

PopBitGcSettings

(

)

[pure virtual]

Restores the last GC state that was saved.

PushBitGcSettings()

TInt

PushBitGcSettings

(

)

[pure virtual]

Saves the state of the GC to an internal buffer. Several GC states can be saved in a FILO. Do not restore a GC (using PopBitGcSettings() ) that wasn't properly saved!

ScheduleAnimation(const TRect &, const TTimeIntervalMicroSeconds &)

void	ScheduleAnimation	(	const TRect &	aRect,
			const TTimeIntervalMicroSeconds &	aFromNow
		)	[pure virtual]

Schedule an animation of a rectangle in the future. Scheduled animation doesn't work in low memory conditions or if aRect values fall outside the window area of this animation.

Parameters

const TRect & aRect	the rectangle to animate, in the GC's coordinates
const TTimeIntervalMicroSeconds & aFromNow	the time in microseconds from Now() that the rectangle will be invalid

ScheduleAnimation(const TRect &, const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &, const TTimeIntervalMicroSeconds &)

void	ScheduleAnimation	(	const TRect &	aRect,
			const TTimeIntervalMicroSeconds &	aFromNow,
			const TTimeIntervalMicroSeconds &	aFreq,
			const TTimeIntervalMicroSeconds &	aStop
		)	[pure virtual]

Schedule an animation of a rectangle in the future

Parameters

const TRect & aRect	the rectangle to animate, in the GC's coordinates
const TTimeIntervalMicroSeconds & aFromNow	the time in microseconds from Now() that the rectangle will be invalid
const TTimeIntervalMicroSeconds & aFreq	microseconds between frames that this rectangle will probably be invalid in the future (0 means no such hint is known)
const TTimeIntervalMicroSeconds & aStop	the duration in microseconds from Now() that the aFreq hint will be valid for (0 means indefinitely)

Screen()

MWsScreen &

Screen

(

)

[pure virtual]

The screen that is currently being drawn to

SetGcOrigin(const TPoint &)

void

SetGcOrigin

(

const TPoint &

aOrigin

)

[pure virtual]

Sets the origin of gc

Parameters

const TPoint & aOrigin

The new origin of the gc