Collapse all Symbian^3 Product Developer Library

CSAnimStartupCtrl Class Reference

class CSAnimStartupCtrl : public CSAnimCtrl

Start-up Animation UI control class with support for reading animation properties from Central Repository and synchronising wilt Secondary Display.

sanimctrl.lib

Since: S60 3.2

Inherits from

CSAnimStartupCtrl
- CSAnimCtrl
  - CCoeControl
    - CBase

Public Member Functions
	~CSAnimStartupCtrl()
TBool	HasContent()
void	Load(const TAnimationParams &, const TBool, const TInt, TRequestStatus &)
	NONSHARABLE_CLASS(TAnimationParams)
IMPORT_C CSAnimStartupCtrl *	NewL(const TRect &, const CCoeControl &)
void	Start(TRequestStatus &)

Protected Member Functions
	CSAnimStartupCtrl()
void	CancelMediatorCommand(TUid, TUid, TInt)
void	CommandResponseL(TUid, TUid, TInt, TInt, const TDesC8 &)
IMPORT_C void	ConstructL(const TRect &, const CCoeControl &)
void	HandlePointerEventL(const TPointerEvent &)
void	LoadL(const TAnimationParams &, TRequestStatus &)
void	MediatorCommandL(TUid, TUid, TInt, TVersion, const TDesC8 &)
void	ReadFileNameL(RFs &, CRepository &, const TUint32, TDes &)
TInt	ReadIntValue(CRepository &, const TUint32)
TInt	ReadVolume(CRepository &, const TUint32)
void	StartAnimation()

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

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::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()
	CSAnimCtrl::BaseConstructL(const TRect &,const CCoeControl &)
	CSAnimCtrl::CSAnimCtrl()
	CSAnimCtrl::Cancel()
	CSAnimCtrl::Clear()
	CSAnimCtrl::ComponentControl(TInt)const
	CSAnimCtrl::CountComponentControls()const
	CSAnimCtrl::Draw(const TRect &)const
	CSAnimCtrl::Load(const TDesC &,const TTimeIntervalMicroSeconds32 &,const TBool,const TInt,const TDesC &,const TInt,const TTimeIntervalMicroSeconds &,const TInt,TRequestStatus &)
	CSAnimCtrl::UpdateScreen(const CFbsBitmap &)
	CSAnimCtrl::UpdateScreen(const CFbsBitmap &,const CFbsBitmap &)
	CSAnimCtrl::~CSAnimCtrl()

Inherited Enumerations
	CCoeControl:TZoomType

Protected Attributes
TRequestStatus *	iClientStatus
CMediatorCommandInitiator *	iCommandInitiator
CMediatorCommandResponder *	iCommandResponder
TBool	iHasContent
TBool	iPlayDefaultBeep
TInt	iSyncCommand

Private Attributes
TAny *	iReserved1
TAny *	iReserved2
TInt	iReserved4
TBool	iWaitingForSyncResponse

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CSAnimCtrl::iBackgroundColour
	CSAnimCtrl::iEngine
	CSAnimCtrl::iImage
	CSAnimCtrl::iMask

Constructor & Destructor Documentation

CSAnimStartupCtrl()

IMPORT_C

CSAnimStartupCtrl

(

)

[protected]

First phase constructor.

Since: S60 3.2

CSAnimStartupCtrl(const CSAnimStartupCtrl &)

CSAnimStartupCtrl

(

const CSAnimStartupCtrl &

)

[private]

Copy constructor.

Parameters

const CSAnimStartupCtrl &

~CSAnimStartupCtrl()

~CSAnimStartupCtrl

(

)

[virtual]

Destructor.

Since: S60 3.2

Member Functions Documentation

CancelMediatorCommand(TUid, TUid, TInt)

void	CancelMediatorCommand	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId
		)	[protected]

MMediatorCommandObserver Cancel a Mediator Service command. Does nothing.

Since: S60 5.0

Parameters

TUid aDomain	The identifier of the domain. Not used.
TUid aCategory	The identifier of the category. Not used.
TInt aCommandId	The identifier of the command. Not used.

CommandResponseL(TUid, TUid, TInt, TInt, const TDesC8 &)

void	CommandResponseL	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId,
			TInt	aStatus,
			const TDesC8 &	aData
		)	[protected, virtual]

A response to a Mediator Service command. From MMediatorCommandResponseObserver.

Since: S60 3.2

Parameters

TUid aDomain	The identifier of the domain
TUid aCategory	The identifier of the category.
TInt aCommandId	The identifier of the command.
TInt aStatus	Standard Symbian error code indicating the success of the command.
const TDesC8 & aData	The parameters of the response.

ConstructL(const TRect &, const CCoeControl &)

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

Second phase constructor.

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.

HandlePointerEventL(const TPointerEvent &)

void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[protected, virtual]

From CCoeControl. Handles pointer events.

Since: S60 5.0

Parameters

const TPointerEvent & aPointerEvent

The pointer event.

HasContent()

TBool

HasContent

(

)

const [virtual]

Return ETrue if the animation has any content (image or tone).

Since: S60 3.2

Load(const TAnimationParams &, const TBool, const TInt, TRequestStatus &)

void	Load	(	const TAnimationParams &	aParams,
			const TBool	aPlayDefaultBeep,
			const TInt	aSyncCommand,
			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. From CSAnimCtrl.

Since: S60 3.2

Parameters

const TAnimationParams & aParams	Central Repository keys for finding out details of the animation.
const TBool aPlayDefaultBeep	Indicates whether the default 'beep' tone should be played during the animation, if the parameters do not specify a valid tone file.
const TInt aSyncCommand	Identifies the parameters for secondary display
TRequestStatus & aStatus	Request to complete when loading is complete.

LoadL(const TAnimationParams &, TRequestStatus &)

void	LoadL	(	const TAnimationParams &	aParams,
			TRequestStatus &	aStatus
		)	[protected, virtual]

Leavable version of Load. Leaves if there is an error reading animation properties.

Since: S60 3.2

Parameters

const TAnimationParams & aParams	Central Repository keys for finding out details of the animation.
TRequestStatus & aStatus	Request to complete when loading is complete.

MediatorCommandL(TUid, TUid, TInt, TVersion, const TDesC8 &)

void	MediatorCommandL	(	TUid	aDomain,
			TUid	aCategory,
			TInt	aCommandId,
			TVersion	aVersion,
			const TDesC8 &	aData
		)	[protected]

MMediatorCommandObserver A Mediator Service command.

Since: S60 5.0

Parameters

TUid aDomain	The identifier of the domain.
TUid aCategory	The identifier of the category.
TInt aCommandId	The identifier of the command.
TVersion aVersion	The version information of the command. Not used.
const TDesC8 & aData	The parameters of the command. Not used.

NONSHARABLE_CLASS(TAnimationParams)

NONSHARABLE_CLASS

(

TAnimationParams

)

[inline]

Contains Central Repository keys which can be used to find out parameters for the animation.

Since: S60 3.2

Parameters

TAnimationParams

NewL(const TRect &, const CCoeControl &)

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

Constructs a CSAnimStartupCtrl 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-up sync command (only required if secondary display is supported).

ReadFileNameL(RFs &, CRepository &, const TUint32, TDes &)

void	ReadFileNameL	(	RFs &	aFs,
			CRepository &	aRepository,
			const TUint32	aKey,
			TDes &	aBuf
		)	[protected, virtual]

Read a file name value from Central Repository key identified by parameter. Return empty value if the file does not exist or can not be opened.

Since: S60 3.2

Parameters

RFs & aFs	File server session for checking the existence of the file.
CRepository & aRepository	Central repository to read the file name from.
const TUint32 aKey	Identifies the key to read.
TDes & aBuf	On return, contains a file name.

ReadIntValue(CRepository &, const TUint32)

TInt	ReadIntValue	(	CRepository &	aRepository,
			const TUint32	aKey
		)	[protected, virtual]

Read an integer value from Central Repository key identified by parameter. Return 0 on failure.

Since: S60 3.2

Parameters

CRepository & aRepository	Central repository to read the file name from.
const TUint32 aKey	Identifies the key to read.

ReadVolume(CRepository &, const TUint32)

TInt	ReadVolume	(	CRepository &	aRepository,
			const TUint32	aKey
		)	[protected, virtual]

Read a volume level value from Central Repository key identified by parameter. If device ringing tone is silent in profile settings, return 0. If the volume level is lower than the minimum allowed, return the minimum allowed value. If the volume level is higher than the maximum allowed, return the maximum allowed value. Otherwise return the volume level read from Central Repository.

Since: S60 3.2

Parameters

CRepository & aRepository	Central repository to read the file name from.
const TUint32 aKey	Identifies the key to read.

Start(TRequestStatus &)

void

Start

(

TRequestStatus &

aStatus

)

[virtual]

Send synchronization command to Secondary Display (if required) and start the show (image/animation and/or tone). Completes immediately with KErrNone if the show has no parts. From CSAnimCtrl.

Since: S60 3.2

Parameters

TRequestStatus & aStatus

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

StartAnimation()

void

StartAnimation

(

)

[protected, virtual]

Start playing the animation.

Since: S60 3.2

operator=(const CSAnimStartupCtrl &)

CSAnimStartupCtrl &

operator=

(

const CSAnimStartupCtrl &

)

[private]

Assignment operator.

Parameters

const CSAnimStartupCtrl &

Member Data Documentation

TRequestStatus * iClientStatus

TRequestStatus *

iClientStatus

[protected]

Request status stored here until secondary display sync command completes and animation can be started. Not owned. May be NULL.

CMediatorCommandInitiator * iCommandInitiator

CMediatorCommandInitiator *

iCommandInitiator

[protected]

For sending commands to Secondary Display using Mediator. Owned. May be NULL.

CMediatorCommandResponder * iCommandResponder

CMediatorCommandResponder *

iCommandResponder

[protected]

For responding to commands from Secondary Display using Mediator. Owned. May be NULL.

TBool iHasContent

TBool

iHasContent

[protected]

ETrue if the animation has any content (image or tone).

TBool iPlayDefaultBeep

TBool

iPlayDefaultBeep

[protected]

ETrue if default 'beep' tone should be played.

TAny * iReserved1

TAny *

iReserved1

[private]

TAny * iReserved2

TAny *

iReserved2

[private]

Reserved for future use.

TInt iReserved4

TInt

iReserved4

[private]

Reserved for future use.

TInt iSyncCommand

TInt

iSyncCommand

[protected]

Identifies the message to send to secondary display (if supported) to synchronise the animation.

TBool iWaitingForSyncResponse

TBool

iWaitingForSyncResponse

[private]

Reserved for future use. Set to ETrue when sending a sync command to secondary display, and EFalse when a response is received. Responses arriving while the value is EFalse are not handled.