Symbian^3 Application Developer Library >

ChspsDomList Class Reference

class ChspsDomList : public CBase

Represents streamable list object, which holds MhspsDomListItem objects.

hspsdomdocument.lib
Since
S60 5.0

Inherits from

Public Member Functions
~ChspsDomList ()
IMPORT_C void AddItemL ( MhspsDomListItem *)
IMPORT_C void AddItemL ( MhspsDomListItem *, TInt )
TInt Count ()
IMPORT_C void DeleteItem ( TInt )
IMPORT_C void DeleteItem ( MhspsDomListItem *)
void ExternalizeL ( RWriteStream &)
IMPORT_C MhspsDomListItem * FindByName (const TDesC8 &)
IMPORT_C MhspsDomListItem * First ()
void InternalizeL ( RReadStream &)
IMPORT_C MhspsDomListItem * Item ( TInt )
IMPORT_C TInt ItemIndex (const MhspsDomListItem &)
IMPORT_C MhspsDomListItem * Last ()
IMPORT_C TInt Length ()
ChspsDomList * NewL ( TListType , ChspsDomStringPool &)
ChspsDomList * NewL ( RReadStream &, ChspsDomStringPool &)
IMPORT_C void RemoveItem ( TInt )
IMPORT_C void RemoveItem ( MhspsDomListItem *)
IMPORT_C void Reset ()
TInt Size ()
IMPORT_C ChspsDomStringPool & StringPool ()
TListType Type ()
Private Member Functions
ChspsDomList ( TListType , ChspsDomStringPool &)
void ConstructL ()
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()
Public Member Enumerations
enum TListType { ENodeList  = 0, EAttributeList }
Protected Attributes
RPointerArray < MhspsDomListItem > iList
TListType iListType
Private Attributes
ChspsDomStringPool & iStringPool

Constructor & Destructor Documentation

ChspsDomList(TListType, ChspsDomStringPool &)

ChspsDomList ( TListType aListType,
ChspsDomStringPool & aStringPool
) [private]

C++ default constructor.

Parameters

TListType aListType
ChspsDomStringPool & aStringPool

~ChspsDomList()

~ChspsDomList ( ) [virtual]

Destructor.

Member Functions Documentation

AddItemL(MhspsDomListItem *)

IMPORT_C void AddItemL ( MhspsDomListItem * aListItem )

List owns items.

Since
S60 5.0

Parameters

MhspsDomListItem * aListItem to add.

AddItemL(MhspsDomListItem *, TInt)

IMPORT_C void AddItemL ( MhspsDomListItem * aListItem,
TInt aIndex
)

List owns items.

Since
S60 5.0

Parameters

MhspsDomListItem * aListItem to add.
TInt aIndex Index in list where the item is added.

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

Count()

TInt Count ( ) const

Count items in a list.

DeleteItem(TInt)

IMPORT_C void DeleteItem ( TInt aIndex )

Delete item from list.

Since
S60 5.0

Parameters

TInt aIndex Item to delete.

DeleteItem(MhspsDomListItem *)

IMPORT_C void DeleteItem ( MhspsDomListItem * aItem )

Delete item from list.

Since
S60 5.0

Parameters

MhspsDomListItem * aItem item to delete.

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const
Externalize list's data.
Since
Series 60 3.1

Parameters

RWriteStream & aStream Output stream

FindByName(const TDesC8 &)

IMPORT_C MhspsDomListItem * FindByName ( const TDesC8 & aName )

Find list item by item name. Searches list items which have name attribute.

Since
S60 5.0

Parameters

const TDesC8 & aName UTF8 encoded item's name to be searched

First()

IMPORT_C MhspsDomListItem * First ( )

Get the first item in a list.

Since
S60 5.0

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream )
Internalize list's data.
Since
Series 60 3.1

Parameters

RReadStream & aStream Input stream

Item(TInt)

IMPORT_C MhspsDomListItem * Item ( TInt aIndex ) const

List items are accessed by index, i.e like arrays

Since
S60 5.0

Parameters

TInt aIndex list item index.

ItemIndex(const MhspsDomListItem &)

IMPORT_C TInt ItemIndex ( const MhspsDomListItem & aItem ) const

Get item index

Since
S60 5.0

Parameters

const MhspsDomListItem & aItem Item to be searched.

Last()

IMPORT_C MhspsDomListItem * Last ( )

The last item in a list

Since
S60 5.0

Length()

IMPORT_C TInt Length ( ) const

Number of items in a list.

Since
S60 5.0

NewL(TListType, ChspsDomStringPool &)

ChspsDomList * NewL ( TListType aListType,
ChspsDomStringPool & aStringPool
) [static]

Two-phased constructor.

Parameters

TListType aListType
ChspsDomStringPool & aStringPool

NewL(RReadStream &, ChspsDomStringPool &)

ChspsDomList * NewL ( RReadStream & aStream,
ChspsDomStringPool & aStringPool
) [static]

Two-phased stream constructor.

Parameters

RReadStream & aStream
ChspsDomStringPool & aStringPool

RemoveItem(TInt)

IMPORT_C void RemoveItem ( TInt aIndex )

Remove item from list.

Since
S60 5.0

Parameters

TInt aIndex to aList item to remove.

RemoveItem(MhspsDomListItem *)

IMPORT_C void RemoveItem ( MhspsDomListItem * aItem )

Remove item from list.

Since
S60 5.0

Parameters

MhspsDomListItem * aItem Item to remove.

Reset()

IMPORT_C void Reset ( )

Frees memory allocated for all items in a list.

Since
S60 5.0

Size()

TInt Size ( ) const
Get list's data size in bytes.
Since
Series 60 3.1

StringPool()

IMPORT_C ChspsDomStringPool & StringPool ( ) const

Get reference to the dom's string pool.

Since
S60 5.0

Type()

TListType Type ( ) const [inline]
Get list item type.
Since
Series 60 3.1

Member Enumerations Documentation

Enum TListType

Enumerators

ENodeList = 0
EAttributeList

Member Data Documentation

RPointerArray< MhspsDomListItem > iList

RPointerArray < MhspsDomListItem > iList [protected]

TListType iListType

TListType iListType [protected]

ChspsDomStringPool & iStringPool

ChspsDomStringPool & iStringPool [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.