Class RAnalogClock

RAnalogClock

Support

Supported from 5.0

Description

An analogue clock.

Derivation

RAnalogClock An analogue clock RAnim Client-side handle to a server-side animation class RAnimWithUtils Utility class to support clock animation RClock Sets the time for clocks RTimeDevice Sets display parameters for clocks

Defined in RAnalogClock:
AddHandL(), ConstructL(), RAnalogClock(), SetBackgroundColor(), SetBrushColor(), SetPenColor(), SetTextColor()

Inherited from RAnim:
Command(), CommandReply(), Construct(), Destroy()

Inherited from RAnimWithUtils:
Close()

Inherited from RClock:
SetUniversalTimeOffset()

Inherited from RTimeDevice:
Draw(), SetPosition(), SetPositionAndSize(), SetSize(), SetVisible(), UpdateDisplay()

RAnalogClock(RAnimDll& aAnimDll, const RWindowBase& aWindow);

Description

Creates an analogue clock object.

To complete construction, you must call ConstructL().

Parameters

RAnimDll& aAnimDll This RAnimDll must have been loaded with the server-side clock animation DLL, clocka.dll const RWindowBase& aWindow Window to which to add the clock

void ConstructL(TTimeIntervalSeconds aUniversalTimeOffset, const TPoint& aPosition, const TSize& aSize, const TMargins& aMargins, const STimeDeviceShadow& aShadow, TInt aFaceHandle, TInt aFaceMaskHandle, TInt aNumHands, const AnalogDisplayAmPm* aAmPm=NULL);

Description

Completes construction of an analogue clock.

The bitmaps specified in aFaceHandle and aFaceMaskHandle cannot be destroyed until the clock has been completely constructed, including all necessary calls to RAnalogClock::AddHandL().

Parameters

TTimeIntervalSeconds aUniversalTimeOffset Initial time for the clock, expressed as an offset from universal time const TPoint& aPosition Clock's on-screen position const TSize& aSize Clock's on-screen size const TMargins& aMargins Margin settings const STimeDeviceShadow& aShadow Shadow settings TInt aFaceHandle Handle to a bitmap of the clock face. You can obtain a bitmap handle through CFbsBitmap::Handle(). TInt aFaceMaskHandle Handle to a bitmap mask for the clock face. This can be 0, if no mask is required. TInt aNumHands Number of hands on the clock. For each hand, you must call AddHandL(). const SAnalogDisplayAmPm* aAmPm=NULL Options for displaying AM/PM

See also:

• CFbsBitmap::Handle()

void AddHandL(const TAnalogDisplayHand& aHand);

Description

Adds a hand to the clock.

This function can only be called after full construction of the clock.

Parameters

const TAnalogDisplayHand& aHand Settings for the hand

void SetBackgroundColor(TRgb aBackgroundColor, TRgb aShadowColor);

Support

Supported from 6.0

Description

Sets the background colour for the clock.

This function can only be called after full construction of the clock.

Parameters

TRgb aBackgroundColor Background colour TRgb aShadowColor Shadow colour

void SetBrushColor(const TRgb aBrushColor);

Support

Supported from 6.0

Description

Sets the brush colour for the hands.

This function can only be called after full construction of the clock.

Parameters

const TRgb aBrushColor Brush colour

void SetPenColor(const TRgb aPenColor);

Support

Supported from 6.0

Description

Sets the pen colour for the hands.

This function can only be called after full construction of the clock.

Parameters

const TRgb aPenColor Pen colour

void SetTextColor(TRgb aTextColor);

Support

Supported from 6.0

Description

Sets the text colour.

This function can only be called after full construction of the clock.

Parameters

TRgb aTextColor Text colour