CColorArray Class Reference

#include <mw/gulcolor.h>

Link against: egul.lib

class CColorArray : public CBase

Inherits from

CColorArray

Public Member Functions
	~CColorArray()
IMPORT_C void	AddL(TInt, TRgb)
IMPORT_C TRgb	Color(TInt)
IMPORT_C TBool	Contains(TInt)
IMPORT_C TInt	Count()
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
IMPORT_C CColorArray *	NewL()
IMPORT_C CColorArray *	NewLC()
CColorArray *	NewLC(const CColorArray &)
IMPORT_C void	Remove(TInt)
IMPORT_C void	Reset()
IMPORT_C void	SetColor(TInt, TRgb)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

A dynamic array of mappings between logical and physical colours (TRgb values).

Constructor & Destructor Documentation

~CColorArray ( )

IMPORT_C

~CColorArray

(

)

Destructor.

Member Function Documentation

AddL ( TInt, TRgb )

IMPORT_C void	AddL	(	TInt	aLogicalColor,
			TRgb	aColor
		)

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

panic: EGUL 4 The logical colour specified already exists in the array. Debug builds only.

Parameter	Description
aLogicalColor	The logical colour.
aColor	The TRgb colour.

Color ( TInt )

IMPORT_C TRgb

Color

(

TInt

aLogicalColor

)

const

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

panic: EGUL 3 The logical colour specified is not found in the colour array.

Parameter	Description
aLogicalColor	The logical colour.

Returns: The TRgb value.

Contains ( TInt )

IMPORT_C TBool

Contains

(

TInt

aLogicalColor

)

const

Tests whether the colour array contains the specified logical colour.

Parameter	Description
aLogicalColor	The logical colour.

Returns: True if the logical colour is found in the colour array, false if not.

Count ( )

IMPORT_C TInt

Count

(

)

const

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

Returns: The number of logical to physical colour mappings in the array.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

NewL ( )

IMPORT_C CColorArray *

NewL

(

)

[static]

Creates a colour array.

Returns: Pointer to the colour array.

NewLC ( )

IMPORT_C CColorArray *

NewLC

(

)

[static]

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

Returns: Pointer to the colour array.

NewLC ( const CColorArray & )

CColorArray *

NewLC

(

const CColorArray &

aArray

)

[static]

Remove ( TInt )

IMPORT_C void

Remove

(

TInt

aLogicalColor

)

Removes a logical to physical colour mapping from the array.

panic: EGUL 3 The logical colour specified is not found in the array.

Parameter	Description
aLogicalColor	The logical colour to remove.

Reset ( )

IMPORT_C void

Reset

(

)

Resets the colour array.

SetColor ( TInt, TRgb )

IMPORT_C void	SetColor	(	TInt	aLogicalColor,
			TRgb	aColor
		)

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

panic: EGUL 3 The logical colour specified is not found in the colour array.

Parameter	Description
aLogicalColor	The logical colour.
aColor	The TRgb value.