TCoeColorUse in Application Framework Control

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:

EActiveThe logical colour is used to draw the control when active and either focused or...
EBackThe logical colour is used to draw the control when it is in the background.
EBordersThe logical colour is used to draw a control's borders.
ECheckedThe logical colour is used to draw the control in the checked state.
EContentsThe logical colour is used to draw a control's contents.
EDarkThe logical colour is used to draw the control in dark tones.
EDimmedThe logical colour is used to draw the control when dimmed and either focused or...
EForeThe logical colour is used to draw the control when it is in the foreground.
EHighlightsThe logical colour is used to draw a control's highlighted contents.
ELightThe logical colour is used to draw the control in light tones.
EMidThe logical colour is used to draw the control in mid tones.
EMidLightThe logical colour is used to draw the control in midlight tones.
ENeutralThe logical colour is used to draw the control in neutral tones.
ENormalThe logical colour is used to draw the control in the normal state.
EPressedThe logical colour is used to draw the control when focused and pressed.
ESetThe logical colour is used to draw the control in the set state.
EShadowedThe logical colour is used to draw the control when it is shadowed.
ESurroundsThe logical colour is used to draw a control's surrounds.
IsActive()constTests whether the logical colour is active. i.e. whether or not it is used to dr...
IsBackground()constTests whether the logical colour is used as a background colour.
IsBorders()constTests whether the logical colour is used to draw a control's borders.
IsContents()constTests whether the logical colour is used to draw a control's contents.
IsDimmed()constTests whether the logical colour is used to draw the control when dimmed and eit...
IsForeground()constTests whether the logical colour is used as a foreground colour.
IsHighlights()constTests whether the logical colour is used to draw a control's highlighted content...
IsNormal()constTests whether the logical colour is used to draw the control in a normal state.
IsPressed()constTests whether the logical colour is used to draw the control when focused and pr...
IsSet()constTests whether the logical colour is used to draw the control in a set state.
IsSurrounds()constTests whether the logical colour is used to draw a control's surrounds.
LogicalColor()constGets the logical colour which has its use described by this TCoeColourUse.
SetLogicalColor(TInt)Sets the logical colour which has its use described by this object.
SetUse(TInt)Sets the use of the logical colour.
TAreasFlags that control the area in which colour is used.
TCoeColorUse()Constructor.
TFocusFocus category flags
TGroundForeground and background category flags
TStateState category flags
TTonesTone flags
Use()constGets the value describing the use of the logical colour.

IMPORT_C TCoeColorUse();

Description

Constructor.

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

IMPORT_C void SetLogicalColor(TInt aLogicalColor);

Description

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

Parameters


                                 						TInt aLogicalColor

The logical colour.

IMPORT_C TInt LogicalColor() const;

Description

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

Return value

TInt

The logical colour.

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

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

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

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

TBool

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

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

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

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

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

TBool

ETrue if the logical colour is active, otherwise EFalse.

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

TBool

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

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

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

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

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.

TAreas

Description

Flags that control the area in which colour is used.

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

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.

Class TCoeColorUse

Description

Members

Construction and destruction

TCoeColorUse()

Description

Member functions

SetUse(TInt)

Description

Parameters

SetLogicalColor(TInt)

Description

Parameters

LogicalColor()const

Description

Return value

Use()const

Description

Return value

IsForeground()const

Description

Return value

IsBackground()const

Description

Return value

IsContents()const

Description

Return value

IsHighlights()const

Description

Return value

IsSurrounds()const

Description

Return value

IsBorders()const

Description

Return value

IsActive()const

Description

Return value

IsDimmed()const

Description

Return value

IsPressed()const

Description

Return value

IsNormal()const

Description

Return value

IsSet()const

Description

Return value

Member enumerations

Enum TGround

Description

Enum TAreas

Description

Enum TFocus

Description

Enum TState

Description

Enum TTones

Description

Class `TCoeColorUse`

`TCoeColorUse()`

`SetUse(TInt)`

`SetLogicalColor(TInt)`

`LogicalColor()const`

`Use()const`

`IsForeground()const`

`IsBackground()const`

`IsContents()const`

`IsHighlights()const`

`IsSurrounds()const`

`IsBorders()const`

`IsActive()const`

`IsDimmed()const`

`IsPressed()const`

`IsNormal()const`

`IsSet()const`

Enum `TGround`

Enum `TAreas`

Enum `TFocus`

Enum `TState`

Enum `TTones`