#include <mw/coecoloruse.h>
| class TCoeColorUse |
| Public Member Enumerations | |
|---|---|
| enum | TAreas { EContents, EHighlights, ESurrounds, EBorders } |
| enum | TFocus { EActive, EDimmed, EShadowed, EPressed } |
| enum | TGround { EFore, EBack } |
| enum | TState { ENormal, ESet, EChecked } |
| enum | TTones { ENeutral, ELight, EMidLight, EMid, EDark } |
| Public Member Functions | |
|---|---|
| TCoeColorUse() | |
| IMPORT_C TBool | IsActive() |
| IMPORT_C TBool | IsBackground() |
| IMPORT_C TBool | IsBorders() |
| IMPORT_C TBool | IsContents() |
| IMPORT_C TBool | IsDimmed() |
| IMPORT_C TBool | IsForeground() |
| IMPORT_C TBool | IsHighlights() |
| IMPORT_C TBool | IsNormal() |
| IMPORT_C TBool | IsPressed() |
| IMPORT_C TBool | IsSet() |
| IMPORT_C TBool | IsSurrounds() |
| IMPORT_C TInt | LogicalColor() |
| IMPORT_C void | SetLogicalColor(TInt) |
| IMPORT_C void | SetUse(TInt) |
| IMPORT_C TInt | Use() |
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.
Flags that control the area in which colour is used.
Focus category flags
Tone flags
| IMPORT_C TBool | IsActive | ( | ) | const |
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.
Returns: ETrue if the logical colour is active, otherwise EFalse.
| IMPORT_C TBool | IsBackground | ( | ) | const |
Tests whether the logical colour is used as a background colour.
Returns: ETrue if the logical colour is used as a background colour, otherwise EFalse.
| IMPORT_C TBool | IsBorders | ( | ) | const |
Tests whether the logical colour is used to draw a control's borders.
Returns: ETrue if the logical colour is used to draw a control's borders, otherwise EFalse.
| IMPORT_C TBool | IsContents | ( | ) | const |
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.
Returns: ETrue if the logical colour is used to draw a control's contents, otherwise EFalse.
| IMPORT_C TBool | IsDimmed | ( | ) | const |
Tests whether the logical colour is used to draw the control when dimmed and either focused or unfocused.
Returns: ETrue if the logical colour is used to draw the control when dimmed and either focused or unfocused, otherwise EFalse.
| IMPORT_C TBool | IsForeground | ( | ) | const |
Tests whether the logical colour is used as a foreground colour.
Returns: ETrue if the logical colour is used as a foreground colour, otherwise EFalse.
| IMPORT_C TBool | IsHighlights | ( | ) | const |
Tests whether the logical colour is used to draw a control's highlighted contents.
Returns: ETrue if the logical colour is used to draw a control's highlighted contents, otherwise EFalse.
| IMPORT_C TBool | IsNormal | ( | ) | const |
Tests whether the logical colour is used to draw the control in a normal state.
Returns: ETrue if the logical colour is used to draw the control in a normal state, otherwise EFalse.
| IMPORT_C TBool | IsPressed | ( | ) | const |
Tests whether the logical colour is used to draw the control when focused and pressed.
Returns: ETrue if the logical colour is used to draw the control when focused and pressed, otherwise EFalse.
| IMPORT_C TBool | IsSet | ( | ) | const |
Tests whether the logical colour is used to draw the control in a set state.
Returns: ETrue if the logical colour is used to draw the control in a set state, otherwise EFalse.
| IMPORT_C TBool | IsSurrounds | ( | ) | const |
Tests whether the logical colour is used to draw a control's surrounds.
Returns: ETrue if the logical colour is used to draw a control's surrounds, otherwise EFalse.
| IMPORT_C TInt | LogicalColor | ( | ) | const |
Gets the logical colour which has its use described by this TCoeColourUse.
Returns: The logical colour.
| IMPORT_C void | SetLogicalColor | ( | TInt | aLogicalColor | ) |
Sets the logical colour which has its use described by this object.
| Parameter | Description |
|---|---|
| aLogicalColor | The logical colour. |
| IMPORT_C void | SetUse | ( | TInt | aUse | ) |
Sets the use of the logical colour.
| Parameter | Description |
|---|---|
| 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 TInt | Use | ( | ) | const |
Gets the value describing the use of the logical colour.
Returns: 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.