Collapse all Symbian^3 Product Developer Library

Alf::IAlfMap Class Reference

class Alf::IAlfMap : public Alf::IAlfVariantType

An interface for Container data type.

hitchcockwidgetmodel.lib

Since: S60 ?S60_version Draft

Inherits from

Alf::IAlfMap
- Alf::IAlfVariantType

Public Member Functions
	~IAlfMap()
void	addItem(IAlfVariantType *, const UString &)
void	addItem(uint, IAlfVariantType *, const UString &)
void	clear()
IAlfMap *	clone()
int	count()
IAlfVariantType *	item(uint)
IAlfVariantType *	item(const UString &)
int	itemIndex(const UString &)
const UString &	name(uint)
void	removeItem(uint)
void	removeItem(const UString &)
void	replaceItem(uint, IAlfVariantType *)
void	replaceItem(const UString &, IAlfVariantType *)

Inherited Functions
	Alf::IAlfVariantType::boolean()const
	Alf::IAlfVariantType::branch()
	Alf::IAlfVariantType::container()
	Alf::IAlfVariantType::customData()
	Alf::IAlfVariantType::integer()const
	Alf::IAlfVariantType::map()
	Alf::IAlfVariantType::real()const
	Alf::IAlfVariantType::set(IAlfVariantType &)
	Alf::IAlfVariantType::string()const
	Alf::IAlfVariantType::type()const
	Alf::IAlfVariantType::uinteger()const
	Alf::IAlfVariantType::~IAlfVariantType()

Inherited Enumerations
	Alf::IAlfVariantType:Type

Constructor & Destructor Documentation

~IAlfMap()

~IAlfMap

(

)

[inline, virtual]

Destructor

Since: S60 ?S60_version

Member Functions Documentation

addItem(IAlfVariantType *, const UString &)

void	addItem	(	IAlfVariantType *	aData,
			const UString &	aName
		)	[pure virtual]

Adds a variantData item into the container

Since: S60 ?S60_version

Parameters

IAlfVariantType * aData	- varaint Data Item to be added into the container
const UString & aName

addItem(uint, IAlfVariantType *, const UString &)

void	addItem	(	uint	aIndex,
			IAlfVariantType *	aData,
			const UString &	aName
		)	[pure virtual]

Adds a variantData item into the container

Since: S60 ?S60_version

Parameters

uint aIndex	index where the data is added
IAlfVariantType * aData	- variant Data Item to be added into the container
const UString & aName

clear()

void

clear

(

)

[pure virtual]

Clear the Container

Since: S60 ?S60_version

clone()

IAlfMap *

clone

(

)

[pure virtual]

Clones the entire container

Since: S60 ?S60_version

count()

int

count

(

)

const [pure virtual]

Gets the Number of items in the container

Since: S60 ?S60_version

item(uint)

IAlfVariantType *

item

(

uint

aIndex

)

[pure virtual]

Gets the Item at a given index in the container

Since: S60 ?S60_version

Parameters

uint aIndex

- index at which the element is required

item(const UString &)

IAlfVariantType *

item

(

const UString &

aName

)

[pure virtual]

Gets the item by the given name.

Since: S60 ?S60_version

Parameters

const UString & aName

The name associated with requested item.

itemIndex(const UString &)

int

itemIndex

(

const UString &

aName

)

[pure virtual]

Gets the index of the item by the given name.

Since: S60 ?S60_version

Parameters

const UString & aName

The name associated with requested item.

name(uint)

const UString &

name

(

uint

aIndex

)

const [pure virtual]

Gets the Name at a given index in the container

Since: S60 ?S60_version

Parameters

uint aIndex

- index at which the name of the element in the map is required

removeItem(uint)

void

removeItem

(

uint

aIndex

)

[pure virtual]

Removes an item from given index in the container

Since: S60 ?S60_version

Parameters

uint aIndex

- index at which the element is to be removed

removeItem(const UString &)

void

removeItem

(

const UString &

aName

)

[pure virtual]

Removes the Item associated with a name

Since: S60 ?S60_version

Parameters

const UString & aName

- Name associated with this Variant Data Item that is required to be removed in the map

replaceItem(uint, IAlfVariantType *)

void	replaceItem	(	uint	aIndex,
			IAlfVariantType *	aNewData
		)	[pure virtual]

Replace an item from given index in the container

Since: S60 ?S60_version

Parameters

uint aIndex	- index at which the element is to be replaced
IAlfVariantType * aNewData	- new Data to be replaced

replaceItem(const UString &, IAlfVariantType *)

void	replaceItem	(	const UString &	aName,
			IAlfVariantType *	aNewData
		)	[pure virtual]

Replaces the Item associated with a name in the container with a new variant data type

Since: S60 ?S60_version

Parameters

const UString & aName	- Name associated with this Variant Data Item that is required to be replaced in the map - New Data to be set
IAlfVariantType * aNewData