CAnimationGroup Class Reference

#include <mw/animationgroup.h>

Link against: animation.lib

class CAnimationGroup : public CAnimation, public CAnimation

Inherits from

CAnimationGroup
- CAnimation
  - CBase
- CAnimation
  - CBase

Public Member Functions
	~CAnimationGroup()
IMPORT_C const RPointerArray< CAnimation > &	Animations()
IMPORT_C RPointerArray< CAnimation > &	Animations()
virtual void	Freeze()
virtual void	Hold()
CAnimationGroup *	NewL()
virtual void	Pause()
virtual void	Resume()
virtual void	SetPosition(const TPoint &)
virtual void	Start(const TAnimationConfig &)
virtual void	Stop()
virtual void	Unfreeze()
virtual void	Unhold()

Protected Member Functions
virtual IMPORT_C void	CAnimationGroup_Reserved1()
virtual IMPORT_C void	CAnimationGroup_Reserved2()

Inherited Functions
	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()

Detailed Description

Handles groups of other animations.

When it is appropriate to have several animations starting and stopping together, add them all to an animation group and control them through that.

In addition to making the code easier to both read and write, the animation group handles synchronisation issues which can occur when issuing a sequence of asynchronous requests.

Care must be taken to remove an animation from any groups it may have been added to before deleting it.

Constructor & Destructor Documentation

~CAnimationGroup ( )

~CAnimationGroup

(

)

Destructor.

Member Function Documentation

Animations ( )

IMPORT_C const RPointerArray< CAnimation > &

Animations

(

)

const

Returns a reference to the array of animations being grouped.

It is intended for animations to be added to and removed from this array directly.

Return Value: the array of animations currently held in the group.

Animations ( )

IMPORT_C RPointerArray< CAnimation > &

Animations

(

)

Returns a reference to the array of animations being grouped.

It is intended for animations to be added to and removed from this array directly.

Return Value: the array of animations currently held in the group.

CAnimationGroup_Reserved1 ( )

IMPORT_C void

CAnimationGroup_Reserved1

(

)

[protected, virtual]

Reserved for future use

CAnimationGroup_Reserved2 ( )

IMPORT_C void

CAnimationGroup_Reserved2

(

)

[protected, virtual]

Reserved for future use

Freeze ( )

void

Freeze

(

)

[virtual]

Reimplemented from CAnimation::Freeze()

Freeze all of the animations.

Hold ( )

void

Hold

(

)

[virtual]

Reimplemented from CAnimation::Hold()

Hold all of the animations.

NewL ( )

CAnimationGroup *

NewL

(

)

[static]

Two stage constructor.

Creates an empty animation group.

Return Value: The new object

Pause ( )

void

Pause

(

)

[virtual]

Reimplemented from CAnimation::Pause()

Pauses all of the animations.

Resume ( )

void

Resume

(

)

[virtual]

Reimplemented from CAnimation::Resume()

Resumes all of the animations.

SetPosition ( const TPoint & )

void

SetPosition

(

const TPoint &

aPoint

)

[virtual]

Reimplemented from CAnimation::SetPosition(const TPoint &)

Set the position of all the animations.

Note that this will cause all the animations to be in the same place, which is unlikely to be a desired effect. It is implemented here for completeness.

Parameters
aPoint	The new location of the top left corner of the animation, relative to the window in which it is to be drawn

Start ( const TAnimationConfig & )

void

Start

(

const TAnimationConfig &

aConfig

)

[virtual]

Reimplemented from CAnimation::Start(const TAnimationConfig &)

Starts all of the animations.

Parameters
aConfig	Specifies run time attributes of the animation

Stop ( )

void

Stop

(

)

[virtual]

Reimplemented from CAnimation::Stop()

Stops all of the animations.

Unfreeze ( )

void

Unfreeze

(

)

[virtual]

Reimplemented from CAnimation::Unfreeze()

Unfreeze all of the animations.

Unhold ( )

void

Unhold

(

)

[virtual]

Reimplemented from CAnimation::Unhold()

Unhold all of the animations.