TCoeColorUse Class Reference

class TCoeColorUse

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.

Public Member Functions
TCoeColorUse()
IMPORT_C TBoolIsActive()
IMPORT_C TBoolIsBackground()
IMPORT_C TBoolIsBorders()
IMPORT_C TBoolIsContents()
IMPORT_C TBoolIsDimmed()
IMPORT_C TBoolIsForeground()
IMPORT_C TBoolIsHighlights()
IMPORT_C TBoolIsNormal()
IMPORT_C TBoolIsPressed()
IMPORT_C TBoolIsSet()
IMPORT_C TBoolIsSurrounds()
IMPORT_C TIntLogicalColor()
IMPORT_C voidSetLogicalColor(TInt)
IMPORT_C voidSetUse(TInt)
IMPORT_C TIntUse()
Public Member Enumerations
enumTAreas { EContents = 0x10, EHighlights = 0x20, ESurrounds = 0x40, EBorders = 0x80 }
enumTFocus { EActive = 0x100, EDimmed = 0x200, EShadowed = 0x400, EPressed = 0x800 }
enumTGround { EFore = 0x01, EBack = 0x02 }
enumTState { ENormal = 0x1000, ESet = 0x2000, EChecked = 0x4000 }
enumTTones { ENeutral = 0x10000, ELight = 0x20000, EMidLight = 0x40000, EMid = 0x80000, EDark = 0x100000 }
Private Attributes
TInt iLogicalColor
TInt iTCoeColorUse_Reserved1
TInt iUse

Constructor & Destructor Documentation

TCoeColorUse()

IMPORT_CTCoeColorUse()

Member Functions Documentation

IsActive()

IMPORT_C TBoolIsActive()const

IsBackground()

IMPORT_C TBoolIsBackground()const

IsBorders()

IMPORT_C TBoolIsBorders()const

IsContents()

IMPORT_C TBoolIsContents()const

IsDimmed()

IMPORT_C TBoolIsDimmed()const

IsForeground()

IMPORT_C TBoolIsForeground()const

IsHighlights()

IMPORT_C TBoolIsHighlights()const

IsNormal()

IMPORT_C TBoolIsNormal()const

IsPressed()

IMPORT_C TBoolIsPressed()const

IsSet()

IMPORT_C TBoolIsSet()const

IsSurrounds()

IMPORT_C TBoolIsSurrounds()const

LogicalColor()

IMPORT_C TIntLogicalColor()const

SetLogicalColor(TInt)

IMPORT_C voidSetLogicalColor(TIntaLogicalColor)

Parameters

TInt aLogicalColor

SetUse(TInt)

IMPORT_C voidSetUse(TIntaUse)

Parameters

TInt aUse

Use()

IMPORT_C TIntUse()const

Member Enumerations Documentation

Enum TAreas

Flags that control the area in which colour is used.

Enumerators

EContents = 0x10

The logical colour is used to draw a control's contents.

EHighlights = 0x20

The logical colour is used to draw a control's highlighted contents.

ESurrounds = 0x40

The logical colour is used to draw a control's surrounds.

EBorders = 0x80

The logical colour is used to draw a control's borders.

Enum TFocus

Focus category flags

Enumerators

EActive = 0x100

The logical colour is used to draw the control when active and either focused or unfocused.

EDimmed = 0x200

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

EShadowed = 0x400

The logical colour is used to draw the control when it is shadowed.

EPressed = 0x800

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

Enum TGround

Foreground and background category flags

Enumerators

EFore = 0x01

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

EBack = 0x02

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

Enum TState

State category flags

Enumerators

ENormal = 0x1000

The logical colour is used to draw the control in the normal state.

ESet = 0x2000

The logical colour is used to draw the control in the set state.

EChecked = 0x4000

The logical colour is used to draw the control in the checked state.

Enum TTones

Tone flags

Enumerators

ENeutral = 0x10000

The logical colour is used to draw the control in neutral tones.

ELight = 0x20000

The logical colour is used to draw the control in light tones.

EMidLight = 0x40000

The logical colour is used to draw the control in midlight tones.

EMid = 0x80000

The logical colour is used to draw the control in mid tones.

EDark = 0x100000

The logical colour is used to draw the control in dark tones.

Member Data Documentation

TInt iLogicalColor

TInt iLogicalColor[private]

TInt iTCoeColorUse_Reserved1

TInt iTCoeColorUse_Reserved1[private]

TInt iUse

TInt iUse[private]