EPOC   SDK Home Glossary Indexes Previous   Up

CCoeControl class


CCoeControl class — CONE control base class

Section Contents

The CCoeControl class is defined in coecntrl.h. For full documentation of CCoeControl, see The CCoeControl class. The following functions have been added to CCoeControl's API in EPOC Release 5.


OverrideColorL() — Override colour mapping

void OverrideColorL(TInt aLogicalColor,TRgb aColor);

Compatibility

Applications that call this member function will not work correctly on a version of EPOC earlier than ER5.

Description

This function allows a control to override a colour setting specified in the application's colour scheme.

This function does not change the application's colour scheme — it changes the colour mapping used in this control only.

Arguments

TInt aLogicalColor

The logical colour. Indicates which part of a control the physical colour maps to. The set of logical colours for an EIKON application are defined in the TEikLogicalColor enum in eikcolor.h.

TRgb aColor

The new physical colour to which the logical colour should be mapped.

Leave considerations

This function can only leave with KErrNoMemory.


GetColor() — Retrieve overriden physical colour

TBool GetColor(TInt aLogicalColor,TRgb& aColor) const;

Compatibility

Applications that call this member function will not work correctly on a version of EPOC earlier than ER5.

Description

This function retrieves the physical colour which has been mapped to the logical colour specified by a call to OverrideColorL(). If the logical colour specified has not been overriden, the aColor value is not changed.

Arguments

TInt aLogicalColor

The logical colour for which the corresponding physical colour will be retrieved. The set of logical colours for an EIKON application are defined in the TEikLogicalColor enum in eikcolor.h.

TRgb& aColor

On return, contains the physical colour which has been mapped to aLogicalColour by a call to OverrideColorL().

Return value

TBool

ETrue if aLogicalColour has been overridden, EFalse otherwise.

EPOC       SDK Home Glossary Indexes Previous   Up