RXmlEngNodeListImpl Class Reference

#include <xml/dom/xmlengnodelist_impl.h>

class RXmlEngNodeListImpl
Public Member Functions
RXmlEngNodeListImpl()
IMPORT_C voidClose()
IMPORT_C TIntCount()
IMPORT_C TBoolHasNext()
IMPORT_C TXmlEngNodeNext()
voidOpen(void *, TXmlEngNode::TXmlEngDOMNodeType)
voidOpenL(void *, TXmlEngNode::TXmlEngDOMNodeType, const TDesC8 &, const TDesC8 &)

Detailed Description

This class should not be used directly. However, it defines the interface for RXmlEngNodeList<TXmlEngNode> through template specialization.

See also: RXmlEngNodeList

This class implements an iterator or filtered iterator for a tree. The OpenL() methods control which nodes are included in the iterator. It is possible to iterate across all node types or only a single type. It is possible to iterate only over nodes within a specific namespace. It is also possible to iterate over nodes with the same name.

Constructor & Destructor Documentation

RXmlEngNodeListImpl ( )

IMPORT_CRXmlEngNodeListImpl()

Default constructor

Member Function Documentation

Close ( )

IMPORT_C voidClose()

Closes a node list. This does not affect any of the nodes. Only internally used memory is freed.

Count ( )

IMPORT_C TIntCount()const

Gets the list length.

Returns: Number of nodes in the listNumber of nodes in a node list

HasNext ( )

IMPORT_C TBoolHasNext()const

Checks whether the next node exists in the list Checks whether next node exists in a node list

Returns: ETrue if the next node exists, EFalse otherwiseTRUE if next node exists, FALSE otherwise

Next ( )

IMPORT_C TXmlEngNodeNext()

Gets the next node in the list Retrieves next node from a node list

Returns: The next node or NULL if it does not existNext node

Open ( void *, TXmlEngNode::TXmlEngDOMNodeType )

voidOpen(void *aHead,
TXmlEngNode::TXmlEngDOMNodeTypeaType
)

Initializes the list. The parameters to this method control what nodes are included in the list. If aType is NULL, all nodes are included in the list.

ParameterDescription
aHeadThe first node in the list
aTypeOnly include nodes of this type

OpenL ( void *, TXmlEngNode::TXmlEngDOMNodeType, const TDesC8 &, const TDesC8 & )

voidOpenL(void *aHead,
TXmlEngNode::TXmlEngDOMNodeTypeaType,
const TDesC8 &aName =  KNullDesC8 ,
const TDesC8 &aNs =  KNullDesC8
)

Initializes the list. The parameters to this method control what nodes are included in the list. If aType is NULL, all nodes are included in the list. Both aName and aNs, if specified, are copied internally.

leave
  • One of the system-wide error codes

ParameterDescription
aHeadThe first node in the list
aTypeOnly include nodes of this type
aNameOnly include nodes that match this name
aNsOnly include nodes that match this namespace