Class TCoeColorUse

class TCoeColorUse;

Description

Logical colour used 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.

Members

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()

IMPORT_C TCoeColorUse();

Description

Constructor.

IMPORT_C void SetUse(TInt aUse);

Description

Sets the use of the logical colour.

Parameters

IMPORT_C void SetLogicalColor(TInt aLogicalColor);

Description

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

Parameters

IMPORT_C TInt LogicalColor() const;

Description

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

Return value

IMPORT_C TInt Use() const;

Description

Gets the value describing the use of the logical colour.

Return value

IMPORT_C TBool IsForeground() const;

Description

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

Return value

IMPORT_C TBool IsBackground() const;

Description

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

Return value

IMPORT_C TBool IsContents() const;

Description

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

The contents are the parts of 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

IMPORT_C TBool IsHighlights() const;

Description

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

Return value

IMPORT_C TBool IsSurrounds() const;

Description

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

Return value

IMPORT_C TBool IsBorders() const;

Description

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

Return value

IMPORT_C 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

IMPORT_C TBool IsDimmed() const;

Description

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

Return value

IMPORT_C TBool IsPressed() const;

Description

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

Return value

IMPORT_C TBool IsNormal() const;

Description

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

Return value

IMPORT_C TBool IsSet() const;

Description

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

Return value

TGround

Description

Foreground and background category flags

TAreas

Description

Flags that control the area in which colour is used.

TFocus

Description

Focus category flags

TState

Description

State category flags

TTones

Description

Tone flags