Collapse all Symbian^3 Product Developer Library

CWindowAnim Class Reference

class CWindowAnim : public CAnim

Window animation interface.

This interface is provided to create animations other than sprites. A window animation can be provided by deriving from this class.

The interface inherits from CAnim and has access to its functions. It additionally can access an interface for querying and manipulating the window in which the animation takes place, using its iWindowFunctions member.

The derived class is constructed in the DLL factory class CAnimDll::CreateInstanceL().

CFreeTimerWindowAnim CSpriteAnim

Inherits from

CWindowAnim
- CAnim
  - CBase

Public Member Functions
void	ConstructL(TAny *, TBool)
void	FocusChanged(TBool)
void	Redraw()

Protected Member Functions
	CWindowAnim()

Private Member Functions
void	ReservedW1()
void	ReservedW2()

Inherited Functions
	CAnim::Animate(TDateTime *)
	CAnim::Command(TInt,TAny *)
	CAnim::CommandReplyL(TInt,TAny *)
	CAnim::HandleNotification(const TWsEvent &)
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
CAnimGc *	iGc
MAnimWindowFunctions *	iWindowFunctions

Inherited Attributes
	CAnim::iFunctions

Constructor & Destructor Documentation

CWindowAnim()

CWindowAnim

(

)

[protected, inline]

Protected constructor.

Prevents objects of this class being directly constructed.

Member Functions Documentation

ConstructL(TAny *, TBool)

void	ConstructL	(	TAny *	aArgs,
			TBool	aHasFocus
		)	[pure virtual]

Server side construction and initialisation of an animation class.

Note: the aHasFocus argument allows the animation to start in a known focus state. For example, an animation may or may not have focus, depending on how it was started. Together with the FocusChanged() function, this allows an animation to always know its focus state.

Parameters

TAny * aArgs	Packaged arguments which may be required during construction. These are transferred from the aParams argument of the client side constructor's RAnim::Construct().
TBool aHasFocus	Specifies whether or not the animation has window server focus.

FocusChanged(TBool)

void

FocusChanged

(

TBool

aState

)

[pure virtual]

Notifies change of focus.

The function is called by the window server to notify a change of focus, allowing the animation code to track whether it does or does not have focus, and to change its appearance accordingly.

Parameters

TBool aState

Indicates whether the focus has or has not changed.

Redraw()

void

Redraw

(

)

[pure virtual]

Redraws the objects.

The function is called by the window server when it needs to redraw the object. The object must provide all the low level drawing code.

ReservedW1()

void

ReservedW1

(

)

const [private, inline, virtual]

ReservedW2()

void

ReservedW2

(

)

const [private, inline, virtual]

Member Data Documentation

CAnimGc * iGc

CAnimGc *

iGc

[protected]

Pointer to the graphics context.

MAnimWindowFunctions * iWindowFunctions

MAnimWindowFunctions *

iWindowFunctions

[protected]

Pointer to a class containing functions implemented by the window server.

These are available to any CWindowAnim-derived class.

Note that this and the iGc pointer are automatically set for you by the animation framework - you do not need to assign a value to them.