Symbian^3 Product 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 voidAddItemL(MhspsDomListItem *)
IMPORT_C voidAddItemL(MhspsDomListItem *, TInt)
TInt Count()
IMPORT_C voidDeleteItem(TInt)
IMPORT_C voidDeleteItem(MhspsDomListItem *)
voidExternalizeL(RWriteStream &)
IMPORT_C MhspsDomListItem *FindByName(const TDesC8 &)
IMPORT_C MhspsDomListItem *First()
voidInternalizeL(RReadStream &)
IMPORT_C MhspsDomListItem *Item(TInt)
IMPORT_C TIntItemIndex(const MhspsDomListItem &)
IMPORT_C MhspsDomListItem *Last()
IMPORT_C TIntLength()
ChspsDomList *NewL(TListType, ChspsDomStringPool &)
ChspsDomList *NewL(RReadStream &, ChspsDomStringPool &)
IMPORT_C voidRemoveItem(TInt)
IMPORT_C voidRemoveItem(MhspsDomListItem *)
IMPORT_C voidReset()
TInt Size()
IMPORT_C ChspsDomStringPool &StringPool()
TListType Type()
Private Member Functions
ChspsDomList(TListType, ChspsDomStringPool &)
voidConstructL()
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
enumTListType { ENodeList = 0, EAttributeList }
Protected Attributes
RPointerArray< MhspsDomListItem >iList
TListType iListType
Private Attributes
ChspsDomStringPool &iStringPool

Constructor & Destructor Documentation

ChspsDomList(TListType, ChspsDomStringPool &)

ChspsDomList(TListTypeaListType,
ChspsDomStringPool &aStringPool
)[private]

C++ default constructor.

Parameters

TListType aListType
ChspsDomStringPool & aStringPool

~ChspsDomList()

~ChspsDomList()[virtual]

Destructor.

Member Functions Documentation

AddItemL(MhspsDomListItem *)

IMPORT_C voidAddItemL(MhspsDomListItem *aListItem)

List owns items.

Since
S60 5.0

Parameters

MhspsDomListItem * aListItemto add.

AddItemL(MhspsDomListItem *, TInt)

IMPORT_C voidAddItemL(MhspsDomListItem *aListItem,
TIntaIndex
)

List owns items.

Since
S60 5.0

Parameters

MhspsDomListItem * aListItemto add.
TInt aIndexIndex in list where the item is added.

ConstructL()

voidConstructL()[private]

By default Symbian 2nd phase constructor is private.

Count()

TInt Count()const

Count items in a list.

DeleteItem(TInt)

IMPORT_C voidDeleteItem(TIntaIndex)

Delete item from list.

Since
S60 5.0

Parameters

TInt aIndexItem to delete.

DeleteItem(MhspsDomListItem *)

IMPORT_C voidDeleteItem(MhspsDomListItem *aItem)

Delete item from list.

Since
S60 5.0

Parameters

MhspsDomListItem * aItemitem to delete.

ExternalizeL(RWriteStream &)

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

Parameters

RWriteStream & aStreamOutput 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 & aNameUTF8 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 &)

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

Parameters

RReadStream & aStreamInput stream

Item(TInt)

IMPORT_C MhspsDomListItem *Item(TIntaIndex)const

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

Since
S60 5.0

Parameters

TInt aIndexlist item index.

ItemIndex(const MhspsDomListItem &)

IMPORT_C TIntItemIndex(const MhspsDomListItem &aItem)const

Get item index

Since
S60 5.0

Parameters

const MhspsDomListItem & aItemItem to be searched.

Last()

IMPORT_C MhspsDomListItem *Last()

The last item in a list

Since
S60 5.0

Length()

IMPORT_C TIntLength()const

Number of items in a list.

Since
S60 5.0

NewL(TListType, ChspsDomStringPool &)

ChspsDomList *NewL(TListTypeaListType,
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 voidRemoveItem(TIntaIndex)

Remove item from list.

Since
S60 5.0

Parameters

TInt aIndexto aList item to remove.

RemoveItem(MhspsDomListItem *)

IMPORT_C voidRemoveItem(MhspsDomListItem *aItem)

Remove item from list.

Since
S60 5.0

Parameters

MhspsDomListItem * aItemItem to remove.

Reset()

IMPORT_C voidReset()

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.