Class TCoeColorUse

TCoeColorUse

Support

Supported from 5.1

Description

Logical colour use when drawing in controls.

This class pairs a logical colour value with an explanation of how it is used when drawing a control. The explanation is in terms of categories of use e.g. in the TGround category, the colour can used for either the foreground or background.

Defined in TCoeColorUse:
EActive, EBack, EBorders, EChecked, EContents, EDark, EDimmed, EFore, EHighlights, ELight, EMid, EMidLight, ENeutral, ENormal, EPressed, ESet, EShadowed, ESurrounds, IsActive(), IsBackground(), IsBorders(), IsContents(), IsDimmed(), IsForeground(), IsHighlights(), IsNormal(), IsPressed(), IsSet(), IsSurrounds(), LogicalColor(), SetLogicalColor(), SetUse(), TAreas, TCoeColorUse(), TFocus, TGround, TState, TTones, Use()

TCoeColorUse();

Description

Constructor.

TBool IsActive() const;

Description

Tests whether the logical colour is active. i.e. whether or not it is used to draw the control when active and either focused or unfocused.

Return value

TBool ETrue if the logical colour is active, otherwise EFalse.

TBool IsBackground() const;

Description

Tests whether the logical colour is used as a background colour.

Return value

TBool ETrue if the logical colour is used as a background colour, otherwise EFalse.

TBool IsBorders() const;

Description

Tests whether the logical colour is used to draw a control's borders.

Return value

TBool ETrue if the logical colour is used to draw a control's borders, otherwise EFalse.

TBool IsContents() const;

Description

Tests whether the logical colour is used to draw a control's contents.

The contents are the parts with the control that the user interacts with e.g. an editor field, the contents of a list box, the page of a web browser. This is opposed to the fascia (or 'surrounds') which are the parts of controls which make up the illusion that the contents are set into some sort of solid frontage.

Return value

TBool ETrue if the logical colour is used to draw a control's contents, otherwise EFalse.

TBool IsDimmed() const;

Description

Tests whether the logical colour is used to draw the control when dimmed and either focused or unfocused.

Return value

TBool ETrue if the logical colour is used to draw the control when dimmed and either focused or unfocused, otherwise EFalse.

TBool IsForeground() const;

Description

Tests whether the logical colour is used as a foreground colour.

Return value

TBool ETrue if the logical colour is used as a foreground colour, otherwise EFalse.

TBool IsHighlights() const;

Description

Tests whether the logical colour is used to draw a control's highlighted contents.

Return value

TBool ETrue if the logical colour is used to draw a control's highlighted contents, otherwise EFalse.

TBool IsNormal() const;

Description

Tests whether the logical colour is used to draw the control in a normal state.

Return value

TBool ETrue if the logical colour is used to draw the control in a normal state, otherwise EFalse.

TBool IsPressed() const;

Description

Tests whether the logical colour is used to draw the control when focused and pressed.

Return value

TBool ETrue if the logical colour is used to draw the control when focused and pressed, otherwise EFalse.

TBool IsSet() const;

Description

Tests whether the logical colour is used to draw the control in a set state.

Return value

TBool ETrue if the logical colour is used to draw the control in a set state, otherwise EFalse.

TBool IsSurrounds() const;

Description

Tests whether the logical colour is used to draw a control's surrounds.

Return value

TBool ETrue if the logical colour is used to draw a control's surrounds, otherwise EFalse.

TInt LogicalColor() const;

Description

Gets the logical colour which has its use described by this TCoeColourUse.

Return value

TInt The logical colour.

void SetLogicalColor(TInt aLogicalColor);

Description

Sets the logical colour which has its use described by this object.

Parameters

TInt aLogicalColor The logical colour.

void SetUse(TInt aUse);

Description

Sets the use of the logical colour.

Parameters

TInt aUse The use of the logical colour. A valid value describing a colour use consists of choices of one value from each of the enums TGround, TAreas, TFocus, TState and TTones ORed together.

TInt Use() const;

Description

Gets the value describing the use of the logical colour.

Return value

TInt The use of the logical colour. This is the logical OR of one value from each of the enums TGround, TAreas, TFocus, TState and TTones.

TAreas

Description

Area category flags. The area in which colour is used flags.

EContents The logical colour is used to draw a control's contents. EHighlights The logical colour is used to draw a control's highlighted contents. ESurrounds The logical colour is used to draw a control's surrounds. EBorders The logical colour is used to draw a control's borders.

TFocus

Description

Focus category flags

EActive The logical colour is used to draw the control when active and either focused or unfocused. EDimmed The logical colour is used to draw the control when dimmed and either focused or unfocused. . EShadowed The logical colour is used to draw the control when it is shadowed. EPressed The logical colour is used to draw the control when focused and pressed.

TGround

Description

Foreground and background category flags

EFore The logical colour is used to draw the control when it is in the foreground. EBack The logical colour is used to draw the control when it is in the background.

TState

Description

State category flags

ENormal The logical colour is used to draw the control in the normal state. ESet The logical colour is used to draw the control in the set state. EChecked The logical colour is used to draw the control in the checked state.

TTones

Description

Tone flags

ENeutral The logical colour is used to draw the control in neutral tones. ELight The logical colour is used to draw the control in light tones. EMidLight The logical colour is used to draw the control in midlight tones. EMid The logical colour is used to draw the control in mid tones. EDark The logical colour is used to draw the control in dark tones.