Class CColorArray

class CColorArray : public CBase;

Description

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 - A dynamic array of mappings between logical and physical colours (TRgb values).

Members

Defined in CColorArray:

• AddL(TInt,TRgb)Adds a logical to physical colour mapping to the colour array. The specified log...
• Color(TInt)constGets the physical colour (TRgb) which corresponds to a logical colour.
• Contains(TInt)constTests whether the colour array contains the specified logical colour.
• Count()constGets the number of logical to physical colour mappings in the array.
• NewL()Creates a colour array.
• NewLC()Creates a colour array and leaves it on the cleanup stack.
• Remove(TInt)Removes a logical to physical colour mapping from the array.
• Reset()Resets the colour array.
• SetColor(TInt,TRgb)Changes a logical to physical mapping in the colour array. The specified logical...
• ~CColorArray()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...

IMPORT_C static CColorArray* NewL();

Description

Creates a colour array.

Return value

IMPORT_C static CColorArray* NewLC();

Description

Creates a colour array and leaves it on the cleanup stack.

Return value

IMPORT_C ~CColorArray();

Description

Destructor.

IMPORT_C TRgb Color(TInt aLogicalColor) const;

Description

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

Parameters

Return value

Panic codes

IMPORT_C void SetColor(TInt aLogicalColor, TRgb aColor);

Description

Changes a logical to physical mapping in the colour array. The specified logical colour must already exist in the colour array.

Parameters

Panic codes

IMPORT_C TBool Contains(TInt aLogicalColor) const;

Description

Tests whether the colour array contains the specified logical colour.

Parameters

Return value

IMPORT_C TInt Count() const;

Description

Gets the number of logical to physical colour mappings in the array.

Return value

IMPORT_C void Reset();

Description

Resets the colour array.

IMPORT_C void AddL(TInt aLogicalColor, TRgb aColor);

Description

Adds a logical to physical colour mapping to the colour array. The specified logical colour must not already exist in the colour array.

Parameters

Panic codes

IMPORT_C void Remove(TInt aLogicalColor);

Description

Removes a logical to physical colour mapping from the array.

Parameters

Panic codes