Collapse all Symbian^3 Product Developer Library

CSAnimCtrl Class Reference

class CSAnimCtrl : public CCoeControl

Start-up Animation UI control class. Draws animation centered to the control.

sanimctrl.lib

Since: S60 3.2

Inherits from

CSAnimCtrl
- CCoeControl
  - CBase

Public Member Functions
	~CSAnimCtrl()
void	Cancel()
void	Clear()
void	Load(const TDesC &, const TTimeIntervalMicroSeconds32 &, const TBool, const TInt, const TDesC &, const TInt, const TTimeIntervalMicroSeconds &, const TInt, TRequestStatus &)
IMPORT_C CSAnimCtrl *	NewL(const TRect &, const CCoeControl &)
void	Start(TRequestStatus &)

Protected Member Functions
	CSAnimCtrl()
IMPORT_C void	BaseConstructL(const TRect &, const CCoeControl &)
CCoeControl *	ComponentControl(TInt)
TInt	CountComponentControls()
void	Draw(const TRect &)
void	UpdateScreen(const CFbsBitmap &, const CFbsBitmap &)
void	UpdateScreen(const CFbsBitmap &)

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

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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ConstructFromResourceL(TResourceReader &)
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandlePointerEventL(const TPointerEvent &)
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SizeChanged()
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Inherited Enumerations
	CCoeControl:TZoomType

Protected Attributes
TRgb	iBackgroundColour
CSAnimEngine *	iEngine
const CFbsBitmap *	iImage
const CFbsBitmap *	iMask

Private Attributes
TAny *	iReserved1
TAny *	iReserved2
TInt	iReserved3
TInt	iReserved4

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CSAnimCtrl()

IMPORT_C

CSAnimCtrl

(

)

[protected]

First phase constructor.

Since: S60 3.2

CSAnimCtrl(const CSAnimCtrl &)

CSAnimCtrl

(

const CSAnimCtrl &

)

[private]

Copy constructor.

Parameters

const CSAnimCtrl &

~CSAnimCtrl()

~CSAnimCtrl

(

)

[virtual]

Destructor.

Since: S60 3.2

Member Functions Documentation

BaseConstructL(const TRect &, const CCoeControl &)

IMPORT_C void	BaseConstructL	(	const TRect &	aRect,
			const CCoeControl &	aContainer
		)	[protected]

Second phase constructor for derived classes.

Since: S60 3.2

Parameters

const TRect & aRect	Rectangle designated for the control.
const CCoeControl & aContainer	The compound control that is the container for this control.

Cancel()

void

Cancel

(

)

[virtual]

Cancel activity.

Since: S60 3.2

Clear()

void

Clear

(

)

[virtual]

Clear drawing data.

Since: S60 3.2

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [protected, virtual]

From CCoeControl.

Since: S60 3.2

Parameters

TInt aIndex

Identifies the component control to return.

CountComponentControls()

TInt

CountComponentControls

(

)

const [protected, virtual]

From CCoeControl.

Since: S60 3.2

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

const [protected, virtual]

From CCoeControl.

Since: S60 3.2

Parameters

const TRect & aRect

The rectangle to draw into.

Load(const TDesC &, const TTimeIntervalMicroSeconds32 &, const TBool, const TInt, const TDesC &, const TInt, const TTimeIntervalMicroSeconds &, const TInt, TRequestStatus &)

void	Load	(	const TDesC &	aImageFileName,
			const TTimeIntervalMicroSeconds32 &	aFrameDelay,
			const TBool	aScalingEnabled,
			const TInt	aAnimRepeatCount,
			const TDesC &	aToneFileName,
			const TInt	aVolume,
			const TTimeIntervalMicroSeconds &	aVolumeRamp,
			const TInt	aToneRepeatCount,
			TRequestStatus &	aStatus
		)	[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

const TDesC & aImageFileName	Identifies the image file to use.
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 aAnimRepeatCount	How many times to repeat the animation. Zero indicates infinite.
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 aToneRepeatCount	How many times to repeat the tone.
TRequestStatus & aStatus	Request to complete when loading is complete.

NewL(const TRect &, const CCoeControl &)

IMPORT_C CSAnimCtrl *	NewL	(	const TRect &	aRect,
			const CCoeControl &	aContainer
		)	[static]

Constructs a CSAnimCtrl object.

Since: S60 3.2

Parameters

const TRect & aRect	Rectangle designated for the control.
const CCoeControl & aContainer	The compound control that is the container for this control.

Start(TRequestStatus &)

void

Start

(

TRequestStatus &

aStatus

)

[virtual]

Start the show (image/animation and/or tone). Completes immediately with KErrNone if the show has no parts.

Since: S60 3.2

Parameters

TRequestStatus & aStatus

Request to complete when all parts of the show have finished.

UpdateScreen(const CFbsBitmap &, const CFbsBitmap &)

void	UpdateScreen	(	const CFbsBitmap &	aFrame,
			const CFbsBitmap &	aMask
		)	[protected, virtual]

Draw an animation frame on the screen with a mask. From MSAnimObserver.

Since: S60 3.2

Parameters

const CFbsBitmap & aFrame	Contains the animation frame to draw on the screen.
const CFbsBitmap & aMask	Contains mask for the animation frame to draw on the screen.

UpdateScreen(const CFbsBitmap &)

void

UpdateScreen

(

const CFbsBitmap &

aFrame

)

[protected, virtual]

Draw an animation frame on the screen without a mask. From MSAnimObserver.

Since: S60 3.2

Parameters

const CFbsBitmap & aFrame

Contains the animation frame to draw on the screen.

operator=(const CSAnimCtrl &)

CSAnimCtrl &

operator=

(

const CSAnimCtrl &

)

[private]

Assignment operator.

Parameters

const CSAnimCtrl &

Member Data Documentation

TRgb iBackgroundColour

TRgb

iBackgroundColour

[protected]

Background colour to use when drawing.

CSAnimEngine * iEngine

CSAnimEngine *

iEngine

[protected]

Start-up Animation engine. Owned. May not be NULL.

const CFbsBitmap * iImage

const CFbsBitmap *

iImage

[protected]

Bitmap to draw next. Not owned. May be NULL.

const CFbsBitmap * iMask

const CFbsBitmap *

iMask

[protected]

Mask for the bitmap to draw next. Not owned. May be NULL.

TAny * iReserved1

TAny *

iReserved1

[private]

TAny * iReserved2

TAny *

iReserved2

[private]

Reserved for future use.

TInt iReserved3

TInt

iReserved3

[private]

Reserved for future use.

TInt iReserved4

TInt

iReserved4

[private]

Reserved for future use.