Collapse all Symbian^3 Product Developer Library

CSAnimEngine Class Reference

class CSAnimEngine : public CBase

Start-up Animation Engine interface class.

None

Since: S60 3.2

Inherits from

CSAnimEngine
- CBase

Public Member Functions
	~CSAnimEngine()
TRgb	BackroundColour()
void	Cancel()
void	Load(TRequestStatus &)
IMPORT_C CSAnimEngine *	NewL(RFs &, MSAnimObserver &)
TInt	SetImageProperties(const TDesC &, const TDisplayMode, const TSize &, const TTimeIntervalMicroSeconds32 &, const TBool, const TInt)
TInt	SetToneProperties(const TDesC &, const TInt, const TTimeIntervalMicroSeconds &, const TInt)
void	Start(TRequestStatus &)

Protected Member Functions
	CSAnimEngine()

Private Member Functions
	CSAnimEngine(const CSAnimEngine &)
CSAnimEngine &	operator=(const CSAnimEngine &)

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

Constructor & Destructor Documentation

CSAnimEngine()

CSAnimEngine

(

)

[protected]

Constructor.

Since: S60 3.2

CSAnimEngine(const CSAnimEngine &)

CSAnimEngine

(

const CSAnimEngine &

)

[private]

Copy constructor.

Parameters

const CSAnimEngine &

~CSAnimEngine()

~CSAnimEngine

(

)

[virtual]

Destructor.

Since: S60 3.2

Member Functions Documentation

BackroundColour()

TRgb

BackroundColour

(

)

const [pure virtual]

Get the backgroud colour of the image. Should only be called after successfully loading the image.

Since: S60 3.2

Cancel()

void

Cancel

(

)

[pure virtual]

Cancel activity.

Since: S60 3.2

Load(TRequestStatus &)

void

Load

(

TRequestStatus &

aStatus

)

[pure virtual]

Load the parts of the show (image/animation and/or tone) from file(s). Completes immediately with KErrNone if the show has no parts.

Since: S60 3.2

Parameters

TRequestStatus & aStatus

Request to complete when loading is complete.

NewL(RFs &, MSAnimObserver &)

IMPORT_C CSAnimEngine *	NewL	(	RFs &	aFs,
			MSAnimObserver &	aObserver
		)	[static]

Constructs a CSAnimEngine object.

Since: S60 3.2

Parameters

RFs & aFs	Fileserver reference.
MSAnimObserver & aObserver	Observer for animation events..

SetImageProperties(const TDesC &, const TDisplayMode, const TSize &, const TTimeIntervalMicroSeconds32 &, const TBool, const TInt)

TInt	SetImageProperties	(	const TDesC &	aImageFileName,
			const TDisplayMode	aDisplayMode,
			const TSize &	aSize,
			const TTimeIntervalMicroSeconds32 &	aFrameDelay,
			const TBool	aScalingEnabled,
			const TInt	aRepeatCount
		)	[pure virtual]

Set the file name identifying the image / animation to show and other properties that affect how the image / animation is shown.

Since: S60 3.2

Parameters

const TDesC & aImageFileName	Identifies the image file to use.
const TDisplayMode aDisplayMode	Display mode to use, if supported by the image.
const TSize & aSize	Requested size for the image.
const TTimeIntervalMicroSeconds32 & aFrameDelay	Frame delay to use.
const TBool aScalingEnabled	Identifies whether to try to scale the image to fit the screen size or just use the target size of the animation as it is.
const TInt aRepeatCount	How many times to repeat the animation. Zero indicates infinite. For future use - not currently used.

SetToneProperties(const TDesC &, const TInt, const TTimeIntervalMicroSeconds &, const TInt)

TInt	SetToneProperties	(	const TDesC &	aToneFileName,
			const TInt	aVolume,
			const TTimeIntervalMicroSeconds &	aVolumeRamp,
			const TInt	aRepeatCount
		)	[pure virtual]

Set the file name identifying the tone to play and other properties that affect how the tone is played.

Since: S60 3.2

Parameters

const TDesC & aToneFileName	Identifies the tone file to use.
const TInt aVolume	Volume level to use.
const TTimeIntervalMicroSeconds & aVolumeRamp	Volume ramp: the period over which the volume level is to rise smoothly from nothing to the normal volume level.
const TInt aRepeatCount	How many times to repeat the tone. Zero indicates infinite. For future use - not currently used.