#include <GULCOLOR.H>
Link against: egul.lib

Class `CColorList`

class CColorList : public CBase;

Description

A palette that maps logical colours (TLogicalColor) to physical (TRgb) values. It also supports independent sections for applications: a section is identified by an application UID, and the mappings are held as a colour array (CColorArray).

A colour list also supports mapping for both four-grey and 256-colour schemes; the 256-colour scheme will be used and will look good if the screen mode supports 16 or more colours. Otherwise, the four-grey scheme will be used.

Derivation

CBase - Base class for all classes to be instantiated on the heap.

CColorList - A palette that maps logical colours (TLogicalColor) to physical (TRgb) values. I...

Members

Defined in CColorList:

AddColorArrayL(TUid,CColorArray *)Creates a new entry in the colour list with the specified application UID and it...
Color(TLogicalColor)constGets the physical colour (TRgb) equivalent of a logical colour.
Color(TUid,TInt)constGets the physical colour (TRgb) equivalent of a logical colour from the specifie...
ColorArray(TUid)constGets an application's colour array.
ContainsColorArray(TUid)constTests whether the specified application has an entry in the colour list.
Count()constGets the number of colors in the list.
DeleteColorArray(TUid)Deletes the entry in the colour list for the specified application, and deletes ...
ExternalizeL(RWriteStream &)constExternalises the colour list to a write stream.
InternalizeL(RReadStream &)Internalises the colour list from a read stream.
MergeL(const CColorList &)Merges the specified CColorList with target object.
NewL(CArrayFix< TRgb > *)Allocates and constructs a new colour list.
NewLC()Allocates and constructs a new colour list and puts the pointer to the new colou...
SetColor(TLogicalColor,TRgb)Sets the TRgb colour value that a logical colour maps to.
~CColorList()Destructor.

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
Extension_(TUint,TAny *&,TAny *)Extension function
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Construction and destruction

`NewL(CArrayFix< TRgb > *)`

IMPORT_C static CColorList* NewL(CArrayFix< TRgb > *aColors);

Description

Allocates and constructs a new colour list.

Parameters


                                 						CArrayFix< TRgb > *aColors

The array of physical colours to store in the list. The colour list takes ownership.

Return value

CColorList *

The colour list.

`~CColorList()`

IMPORT_C ~CColorList();

Description

Destructor.

`NewLC()`

IMPORT_C static CColorList* NewLC();

Description

Allocates and constructs a new colour list and puts the pointer to the new colour list object onto the cleanup stack.

Return value

CColorList *

The colour list.

Member functions

`Color(TLogicalColor)const`

IMPORT_C TRgb Color(TLogicalColor aColor) const;

Description

Gets the physical colour (TRgb) equivalent of a logical colour.

Parameters


                                 						TLogicalColor aColor

Logical colour value.

Return value

TRgb

The physical colour equivalent of aColor.

Panic codes

EGUL

3 The logical color specified is not found in the colour list.

`Count()const`

IMPORT_C TInt Count() const;

Description

Gets the number of colors in the list.

Return value

TInt

The number of colors in the list

`Color(TUid,TInt)const`

IMPORT_C TRgb Color(TUid aApp, TInt aColor) const;

Description

Gets the physical colour (TRgb) equivalent of a logical colour from the specified application's colour array.

Parameters

`TUid aApp`	The UID of the application.
`TInt aColor`	A logical colour supported by the application.

Return value

TRgb

The physical colour equivalent of the logical colour.

Panic codes

EGUL

6 The specified application does not have an entry in the colour list.

`ColorArray(TUid)const`

IMPORT_C CColorArray* ColorArray(TUid aApp) const;

Description

Gets an application's colour array.

Parameters


                                 						TUid aApp

The UID of the application.

Return value

CColorArray *

The specified application's colour array. The caller does not take ownership.

Panic codes

EGUL

6 The specified application does not have an entry in the colour list.

`ContainsColorArray(TUid)const`

IMPORT_C TBool ContainsColorArray(TUid aApp) const;

Description

Tests whether the specified application has an entry in the colour list.

Parameters


                                 						TUid aApp

The UID of the application.

Return value

TBool

True if a colour array is found for the application, false if not.

`SetColor(TLogicalColor,TRgb)`

IMPORT_C void SetColor(TLogicalColor aLogicalColor, TRgb aColor);

Description

Sets the TRgb colour value that a logical colour maps to.

Parameters

`TLogicalColor aLogicalColor`	The logical colour that needs to be set.
`TRgb aColor`	The `TRgb` colour value.

`AddColorArrayL(TUid,CColorArray *)`

IMPORT_C void AddColorArrayL(TUid aApp, CColorArray *aArray);

Description

Creates a new entry in the colour list with the specified application UID and its colour array.

Parameters

`TUid aApp`	The UID of the application.
`CColorArray *aArray`	The application's colour array. The colour list takes ownership.

`DeleteColorArray(TUid)`

IMPORT_C void DeleteColorArray(TUid aApp);

Description

Deletes the entry in the colour list for the specified application, and deletes the application's colour array.

Parameters


                                 						TUid aApp

The UID of the application whose entry is deleted from the colour list.

Panic codes

EGUL

6 The specified application does not have an entry in the colour list.

`InternalizeL(RReadStream &)`

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the colour list from a read stream.

Parameters


                                 						RReadStream &aStream

Stream from which the object should be internalised.

`ExternalizeL(RWriteStream &)const`

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the colour list to a write stream.

Parameters


                                 						RWriteStream &aStream

Stream to which the object should be externalised.

`MergeL(const CColorList &)`

IMPORT_C void MergeL(const CColorList &aList);

Description

Merges the specified CColorList with target object.

Parameters

const CColorList &aList

A reference to the colour list object, set by calling CColorList::AddColorArray()

Class CColorList

Description

Derivation

Members

Construction and destruction

NewL(CArrayFix< TRgb > *)

Description

Parameters

Return value

~CColorList()

Description

NewLC()

Description

Return value

Member functions

Color(TLogicalColor)const

Description

Parameters

Return value

Panic codes

Count()const

Description

Return value

Color(TUid,TInt)const

Description

Parameters

Return value

Panic codes

ColorArray(TUid)const

Description

Parameters

Return value

Panic codes

ContainsColorArray(TUid)const

Description

Parameters

Return value

SetColor(TLogicalColor,TRgb)

Description

Parameters

AddColorArrayL(TUid,CColorArray *)

Description

Parameters

DeleteColorArray(TUid)

Description

Parameters

Panic codes

InternalizeL(RReadStream &)

Description

Parameters

ExternalizeL(RWriteStream &)const

Description

Parameters

MergeL(const CColorList &)

Description

Parameters

Class `CColorList`

`NewL(CArrayFix< TRgb > *)`

`~CColorList()`

`NewLC()`

`Color(TLogicalColor)const`

`Count()const`

`Color(TUid,TInt)const`

`ColorArray(TUid)const`

`ContainsColorArray(TUid)const`

`SetColor(TLogicalColor,TRgb)`

`AddColorArrayL(TUid,CColorArray *)`

`DeleteColorArray(TUid)`

`InternalizeL(RReadStream &)`

`ExternalizeL(RWriteStream &)const`

`MergeL(const CColorList &)`