Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: CLOCK.H
Link against: clock.lib

Class RDigitalClock

class RDigitalClock : public RClock;

Description

A digital clock.

A digital clock is composed of one or more text sections, which define how the time information is displayed.

Derivation

Members

Defined in RDigitalClock:
AddTextSectionL(), ConstructL(), RDigitalClock(), SetBackgroundColor(), SetTextColor()

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

Inherited from RAnimWithUtils:
Close()

Inherited from RClock:
SetUniversalTimeOffset()

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


Construction and destruction


RDigitalClock()

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

Description

Creates a digital 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


ConstructL()

IMPORT_C void ConstructL(TTimeIntervalSeconds aUniversalTimeOffset, const TPoint &aPosition, const TSize &aSize, const TMargins &aMargins, const STimeDeviceShadow &aShadow, TRgb aBackgroundColor, TInt aNumTextSections);

Description

Completes construction of a digital clock.

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

TRgb aBackgroundColor

Background color

TInt aNumTextSections

Number of text sections

[Top]


Member functions


AddTextSectionL()

IMPORT_C void AddTextSectionL(const TDigitalDisplayTextSection &aTextSection);

Description

Adds a text section to the clock.

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

Parameters

const TDigitalDisplayTextSection &aTextSection

Describes text section to add


SetBackgroundColor()

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


SetTextColor()

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