Class RAnalogClock

class RAnalogClock : public RClock;

Description

An analogue clock.

Derivation

• RAnim - Client-side handle to a server-side animation class.

• RAnimWithUtils - Utility class to support clock animation.

• RTimeDevice - Sets display parameters for clocks.

• RClock - Sets the time for clocks.

• RAnalogClock - An analogue clock.

Members

Defined in RAnalogClock:

• AddHandL(const TAnalogDisplayHand &)Adds a hand to the clock.
• ConstructL(TTimeIntervalSeconds,const TPoint &,const TSize &,const TMargins &,const STimeDeviceShadow &,TInt,TInt,TInt,const SAnalogDisplayAmPm *)Completes construction of an analogue clock.
• RAnalogClock(RAnimDll &,const RWindowBase &)Creates an analogue clock object.
• SetBackgroundColor(TRgb,TRgb)Sets the background colour for the clock.
• SetBrushColor(const TRgb)Sets the brush colour for the hands.
• SetPenColor(const TRgb)Sets the pen colour for the hands.
• SetTextColor(TRgb)Sets the text colour.

Inherited from RAnim:

• AsyncCommandReply(TRequestStatus &,TInt,const TIpcArgs &)Sends a command and its arguments to the server-side CAnim instance asynchronous...
• Command(TInt)Sends a command to the server-side CAnim instance, and returns immediately.
• Command(TInt,const TPtrC8 &)Sends a command and its arguments to the server-side CAnim instance, and returns...
• CommandReply(TInt)Sends a command to the server-side CAnim instance, and waits for a response.
• CommandReply(TInt,const TDesC8 &,const TIpcArgs &)Sends a command and its arguments to the server-side CAnim instance, and waits f...
• CommandReply(TInt,const TPtrC8 &)Sends a command and its arguments to the server-side CAnim instance, and waits f...
• Construct(const RWindowBase &,TInt,const TDesC8 &)Completes construction of the object based on a window device, and creates the s...
• Construct(const RWindowBase &,TInt,const TDesC8 &,const TIpcArgs &)Completes construction of the object based on a window device, and creates the s...
• Construct(const RWsSprite &,TInt,const TDesC8 &)Completes construction of the Anim DLL based on a sprite.
• Construct(const RWsSprite &,TInt,const TDesC8 &,const TIpcArgs &)Completes construction of the Anim DLL based on a sprite.
• Destroy()Closes and deletes the server-side animation object.
• RAnim(RAnimDll &)Protected C++ constructor.

Inherited from RAnimWithUtils:

• Close()Closes the clock animation.

Inherited from RClock:

• SetUniversalTimeOffset(TTimeIntervalSeconds)Adjusts the clock's time.

Inherited from RTimeDevice:

• Draw()Draws the clock.
• SetPosition(const TPoint &)Sets the clock's on-screen position.
• SetPositionAndSize(const TPoint &,const TSize &)Sets the clock's on-screen position and size.
• SetSize(const TSize &)Sets the clock's on-screen size.
• SetVisible(TBool)Makes the clock visible. By default, clocks are invisible.
• UpdateDisplay()Forces an update to the clock's display.

See also:

• CFbsBitmap::Handle()constGets the handle number of the bitmap. The returned value can be used to give ano...

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

Description

Creates an analogue clock object.

To complete construction, you must call RAnalogClock::ConstructL(TTimeIntervalSeconds,const TPoint &,const TSize &,const TMargins &,const STimeDeviceShadow &,TInt,TInt,TInt,const SAnalogDisplayAmPm *).

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

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

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(const TAnalogDisplayHand &).

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()const. 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 RAnalogClock::AddHandL(const TAnalogDisplayHand &). const SAnalogDisplayAmPm *aAmPm Options for displaying AM/PM

See also:

• CFbsBitmap::Handle()constGets the handle number of the bitmap. The returned value can be used to give ano...

IMPORT_C 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.

IMPORT_C void SetBackgroundColor(TRgb aBackgroundColor, TRgb aShadowColor);

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.

IMPORT_C void SetTextColor(TRgb aTextColor);

Description

Sets the text colour.

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

Parameters

TRgb aTextColor Text colour.

IMPORT_C void SetPenColor(const TRgb aPenColor);

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.

IMPORT_C void SetBrushColor(const TRgb aBrushColor);

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.