Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: clock.h
Link against: clock.lib

Class RDigitalClock

RDigitalClock

Support

Supported from 5.0

Description

A digital clock.

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

Derivation

RAnimClient-side handle to a server-side animation class
RAnimWithUtilsUtility class to support clock animation
RClockSets the time for clocks
RDigitalClockA digital clock
RTimeDeviceSets display parameters for clocks

Defined in RDigitalClock:
AddTextSectionL(), ConstructL(), RDigitalClock(), SetBackgroundColor(), 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()


RDigitalClock()

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

[Top]


ConstructL()

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]


AddTextSectionL()

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

[Top]


SetBackgroundColor()

void SetBackgroundColor(TRgb aBackgroundColor, TRgb aShadowColor);

Description

Sets 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

[Top]


SetTextColor()

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