EPOC   SDK Home Glossary Indexes Previous Next Up

CEikonEnv class


CEikonEnv class — The EIKON environment

Section Contents

The following functions are new in ER5. They are provided to enable custom controls to retrieve colours from the colour list, and to override the system default colour settings. CEikonEnv is defined in eikenv.h.


ColorList() — Retrieve colour list

CEikColorList& ColorList() 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 application's colour list. The colour list provides member functions to retrieve and modify colours in the list, and to append new arrays of colours to the colour list.

Return value

CEikColorList&

The application's colour list


Color() — Retrieve logical to physical colour mapping

TRgb Color(TEikLogicalColor aLogicalColor) const;

Compatibility

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

Description

Use this function to retrieve the physical (TRgb) colour which corresponds to the logical colour specified, from the application's colour list.

Arguments

TEikLogicalColor aLogicalColor

A logical colour value.

Return value

TRgb

The physical colour which corresponds to aLogicalColor.


ControlColor() — Retrieve (overriden) logical to physical colour mapping

TRgb ControlColor(TEikLogicalColor aLogicalColor,const CCoeControl& aControl) const;

Compatibility

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

Description

Use this function to retrieve the physical (TRgb) colour which corresponds to the logical colour specified, from the application's colour list.

If the colour of the control specified in aControl has been overriden using CCoeControl::OverrideColorL(), this function will return the overriden colour.

Arguments

TEikLogicalColor aLogicalColor

A logical colour value.

const CCoeControl& aControl

A pointer to the control itself (*this).

Return value

TRgb

The physical colour which corresponds to aLogicalColor.


SetColor() — Set colour mapping

void SetColor(TEikLogicalColor aLogicalColor, TRgb aColor);

Compatibility

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

Description

Use this function to set the mapping in the application's colour list between the logical and physical colours specified.

Arguments

TEikLogicalColor aLogicalColor

A logical colour value.

TRgb aColor

A physical colour value.

EPOC       SDK Home Glossary Indexes Previous Next Up