Class CColorArray

CColorArray

Support

Supported from 6.0

Description

Provides functions used to create a colour array, which contains a list of available colours.

The colour array is a dynamic array of mappings between logical and physical colours (TRgb values).

Derivation

CBase Base class for all classes to be instantiated on the heap CColorArray Provides functions used to create a colour array, which contains a list of available colours

Defined in CColorArray:
AddL(), Color(), Contains(), Count(), ExternalizeL(), InternalizeL(), NewL(), NewLC(), Remove(), Reset(), SetColor(), ~CColorArray()

Inherited from CBase:
operator new()

static CColorArray* NewL();

Description

Creates an array of colours.

Return value

CColorArray* Pointer to the colour array.

static CColorArray* NewLC();

Description

Creates an array of colours and puts it on the cleanup stack.

Return value

CColorArray* Pointer to the colour array.

static CColorArray* NewLC(const CColorArray& aArray);

Description

Creates an array of colours using an existing array and puts it on the cleanup stack.

Parameters

const CColorArray& aArray The colour array to copy.

Return value

CColorArray* Pointer to the colour array.

~CColorArray();

Description

Destructor.

TRgb Color(TInt aLogicalColor) const;

Description

Gets the physical (TRgb) colour which corresponds to a logical colour.

Parameters

TInt aLogicalColor The logical colour.

Return value

TRgb The TRgb colour.

void SetColor(TInt aLogicalColor,TRgb aColor);

Description

Sets a mapping in the colour array between the logical and physical colours specified.

A mapping must already exist for the logical colour.

Parameters

TInt aLogicalColor The logical colour. TRgb aColor TRgb colour.

TBool Contains(TInt aLogicalColor) const;

Description

Tests whether the colour array contains the logical colour specified.

Parameters

TInt aLogicalColor The logical colour.

Return value

TBool ETrue if the logical colour is contained in the colour array, otherwise EFalse.

TInt Count() const;

Description

Returns the number of elements held in the array.

Return value

TInt The number of elements held in the array.

void Reset();

Description

Resets the colour array.

void AddL(TInt aLogicalColor,TRgb aColor);

Description

Adds a colour to the array, with its logical and TRgb colours.

A mapping cannot already exist in the array for the logical colour.

Parameters

TInt aLogicalColor The logical colour. TRgb aColor The TRgb colour.

void Remove(TInt aLogicalColor);

Description

Removes a colour from the array.

Parameters

TInt aLogicalColor The logical colour to remove.

void InternalizeL(RReadStream& aStream);

Description

Internalises the colour array.

Parameters

RReadStream& aStream Stream from which the the colour array should be internalised.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the colour array.

Parameters

RWriteStream& aStream Stream to which the the colour array should be externalised.