#include <cnode.h>
Link against: wnode.lib

Class `CNode`

class CNode : public CBase;

Description

Derivation

CBase - Base class for all classes to be instantiated on the heap.

CNode - (No abstract)

Members

Defined in CNode:

AddAttributeL(TAny *,CBase *)Adds an attribute.
AddDataAndAttributeL(HBufC16 *,TAny *,CBase *)Sets node data and adds an attribute.
AppendNodeL(TAny *)Creates a new child node.
AppendNodeToThisNodeL(CNode *)Adds an existing node as a child.
Attribute(TAny *)constGets an attribute value for a specified attribute type.
AttributeByIndex(TInt)constGets the attribute value of an attribute at a specified index.
AttributeByIndex(TInt,TAny *&)constGets the attribute value and type of an attribute at a specified index..
AttributeCount()constGets the number of attributes of this node.
AttributeExists(TAny *)constTests if an attribute of a specified type exists.
AttributeTypeByIndex(TInt)constGets the attribute value of an attribute at a specified index
Child(TInt)constGets a child node by index.
ClearSetDataNoDeleteL()Sets the object to delete the node data in its destructor.
Data()constGets the node data.
DeleteAllAttributes()Delete all node attributes.
DeleteAllChildNodes()Deletes all the child nodes of this node.
DeleteAttribute(TAny *)Deletes an attribute of a specified type.
DeleteChildNode(CNode *)Deletes a specified child node.
NewL(TAny *,CNode *)Allocates and constructs a new node.
NextChild(const CNode *)constGets the first child or the next child after a specified child.
NextSibling()constGets the next sibling node.
NumberImmediateChildren()constGets the number of children of this node.
Parent()constGets the parent of this node.
PrevChild(const CNode &)constGets the previous child before a specified child.
PrevSibling()constGets the previous sibling node.
RemoveAttributeNoDelete(TAny *)Removes an attribute of a specified type, but does not delete it.
ReparentL(CNode *)Changes the parent of the node.
Reserved1()
Reserved1()const
ResetDataPointer(HBufC16 *)Resets the node data to a specified pointer.
Root()constGets the absolute root node of the tree.
SetDataL(HBufC16 *)Sets the node data.
SetDataNoDeleteL()Sets the object not to delete the node data in its destructor.
SetFileDataL(HBufC16 *)Sets the node data to be taken from a specified file.
SetType(TAny *)Sets the node type.
Type()constGets the node type.
iChildList
iDataValue
iParent
iType
iTypes
iTypesBasePtr
iValues
~CNode()Destructor.

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
Extension_(TUint,TAny *&,TAny *)Extension function
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Construction and destruction

`~CNode()`

IMPORT_C ~CNode();

Description

Destructor.

Data (if owned by the object), child nodes and attributes are deleted.

`NewL(TAny ,CNode )`

IMPORT_C static CNode* NewL(TAny *aType, CNode *aParent);

Description

Allocates and constructs a new node.

Parameters

`TAny *aType`	The type of the node
`CNode *aParent`	The parent of this node

Return value

CNode *

New node

Member functions

`DeleteChildNode(CNode *)`

IMPORT_C void DeleteChildNode(CNode *aNode);

Description

Deletes a specified child node.

Parameters


                                 						CNode *aNode

Node to delete

`DeleteAllChildNodes()`

IMPORT_C void DeleteAllChildNodes();

Description

Deletes all the child nodes of this node.

`AppendNodeL(TAny *)`

IMPORT_C CNode& AppendNodeL(TAny *aType=0);

Description

Creates a new child node.

Parameters


                                 						TAny *aType

Node type

Return value

CNode &

The new child node

`AppendNodeToThisNodeL(CNode *)`

IMPORT_C void AppendNodeToThisNodeL(CNode *aNode);

Description

Adds an existing node as a child.

Parameters


                                 						CNode *aNode

Node to make a child

`SetDataL(HBufC16 *)`

IMPORT_C void SetDataL(HBufC16 *aDataNowNodeOwns);

Description

Sets the node data.

The object will delete the data in its destructor.

Parameters


                                 						HBufC16 *aDataNowNodeOwns

Node data

`Data()const`

IMPORT_C HBufC16* Data() const;

Description

Gets the node data.

Return value

HBufC16 *

Node data or NULL if no data is set

`SetDataNoDeleteL()`

IMPORT_C void SetDataNoDeleteL();

Description

Sets the object not to delete the node data in its destructor.

Note that the function internally reallocates memory. If it leaves, the data is lost.

`ClearSetDataNoDeleteL()`

IMPORT_C void ClearSetDataNoDeleteL();

Description

Sets the object to delete the node data in its destructor.

Note that the function internally reallocates memory. If it leaves, the data is lost.

`SetFileDataL(HBufC16 *)`

IMPORT_C void SetFileDataL(HBufC16 *aFileDataLocationNowNodeOwns);

Description

Sets the node data to be taken from a specified file.

If the data is deleted, the referenced file is also deleted.

Parameters


                                 						HBufC16 *aFileDataLocationNowNodeOwns

Name of the file containing the data

`ResetDataPointer(HBufC16 *)`

IMPORT_C void ResetDataPointer(HBufC16 *aData);

Description

Resets the node data to a specified pointer.

Existing data owned by the node is deleted.

Parameters


                                 						HBufC16 *aData

Root node

`Root()const`

IMPORT_C const CNode& Root() const;

Description

Gets the absolute root node of the tree.

Return value

const CNode &

Root node

`Child(TInt)const`

IMPORT_C CNode* Child(TInt aByIndex) const;

Description

Gets a child node by index.

Parameters


                                 						TInt aByIndex

Index of the child node

Return value

CNode *

Child node

`NextChild(const CNode *)const`

IMPORT_C CNode* NextChild(const CNode *aNode=0) const;

Description

Gets the first child or the next child after a specified child.

Parameters

const CNode *aNode

Child node or NULL to get the first child

Return value

CNode *

First or next child node

`PrevChild(const CNode &)const`

IMPORT_C CNode* PrevChild(const CNode &aNode) const;

Description

Gets the previous child before a specified child.

Parameters

const CNode &aNode

Child node

Return value

CNode *

Previous child node

`Parent()const`

IMPORT_C CNode* Parent() const;

Description

Gets the parent of this node.

Return value

CNode *

Parent

`ReparentL(CNode *)`

IMPORT_C void ReparentL(CNode *aParent);

Description

Changes the parent of the node.

The node is removed from the childlist of its current parent.

Parameters


                                 						CNode *aParent

New parent

`NextSibling()const`

IMPORT_C CNode* NextSibling() const;

Description

Gets the next sibling node.

This asks for the next child of its parent.

Return value

CNode *

Next sibling node

`PrevSibling()const`

IMPORT_C CNode* PrevSibling() const;

Description

Gets the previous sibling node.

This asks for the previous child of its parent.

Return value

CNode *

Previous sibling node

`NumberImmediateChildren()const`

IMPORT_C TInt NumberImmediateChildren() const;

Description

Gets the number of children of this node.

Return value

TInt

Number of children of this node

`DeleteAttribute(TAny *)`

IMPORT_C void DeleteAttribute(TAny *aAttributeType);

Description

Deletes an attribute of a specified type.

Note that the attribute value will be deleted.

Parameters


                                 						TAny *aAttributeType

Attribute type

`DeleteAllAttributes()`

IMPORT_C void DeleteAllAttributes();

Description

Delete all node attributes.

Note that attribute values will be deleted.

`RemoveAttributeNoDelete(TAny *)`

IMPORT_C void RemoveAttributeNoDelete(TAny *aAttributeType);

Description

Removes an attribute of a specified type, but does not delete it.

The caller is now responsible for the destruction of the attribute value.

Parameters


                                 						TAny *aAttributeType

Attribute type

`AttributeCount()const`

IMPORT_C TInt AttributeCount() const;

Description

Gets the number of attributes of this node.

Return value

TInt

Number of attributes of this node

`AttributeTypeByIndex(TInt)const`

IMPORT_C TAny* AttributeTypeByIndex(TInt aIndex) const;

Description

Gets the attribute value of an attribute at a specified index

Parameters


                                 						TInt aIndex

Attribute index

Return value

TAny *

Attribute value

`AttributeByIndex(TInt)const`

IMPORT_C CBase* AttributeByIndex(TInt aIndex) const;

Description

Gets the attribute value of an attribute at a specified index.

Parameters


                                 						TInt aIndex

Attribute index

Return value

CBase *

Attribute value

`AttributeByIndex(TInt,TAny *&)const`

IMPORT_C CBase* AttributeByIndex(TInt aIndex, TAny *&aType) const;

Description

Gets the attribute value and type of an attribute at a specified index..

Parameters

`TInt aIndex`	Attribute index
`TAny *&aType`	On return, the attribute type

Return value

CBase *

Attribute value

`AddAttributeL(TAny ,CBase )`

IMPORT_C void AddAttributeL(TAny *AttributeType, CBase *aAttributeValue);

Description

Adds an attribute.

The node takes ownership of aAttributeValue.

Parameters

`TAny *AttributeType`	Attribute type
`CBase *aAttributeValue`	Attribute value

`AddDataAndAttributeL(HBufC16 ,TAny ,CBase *)`

IMPORT_C void AddDataAndAttributeL(HBufC16 *aData, TAny *AttributeType, CBase *aAttributeValue);

Description

Sets node data and adds an attribute.

The node takes ownership of aDataand aAttributeValue. Existing node data owned by the node is deleted.

Parameters

`HBufC16 *aData`	Node data
`TAny *AttributeType`	Attribute type
`CBase *aAttributeValue`	Attribute value

`Attribute(TAny *)const`

IMPORT_C CBase* Attribute(TAny *AttributeType) const;

Description

Gets an attribute value for a specified attribute type.

Parameters


                                 						TAny *AttributeType

Attribute type

Return value

CBase *

Attribute value

`AttributeExists(TAny *)const`

IMPORT_C TBool AttributeExists(TAny *aAttributeType) const;

Description

Tests if an attribute of a specified type exists.

Parameters


                                 						TAny *aAttributeType

Attribute type

Return value

TBool

True if the attribute exists, otherwise false

`Type()const`

IMPORT_C TAny* Type() const;

Description

Gets the node type.

Return value

TAny *

Node type

`SetType(TAny *)`

IMPORT_C void SetType(TAny *aType);

Description

Sets the node type.

Parameters


                                 						TAny *aType

Node type

`Reserved1()`

private: virtual void Reserved1();

Description

`Reserved1()const`

private: virtual void Reserved1() const;

Description

Member data

`iType`

protected: TAny * iType;

Description

`iParent`

protected: CNode * iParent;

Description

`iValues`

protected: CArrayPtrFlat< CBase > iValues;

Description

`iTypes`

protected: CArrayPtrFlat< TAny > iTypes;

Description

`iTypesBasePtr`

protected: TInt32 * iTypesBasePtr;

Description

`iDataValue`

protected: CDataNoDelete * iDataValue;

Description

`iChildList`

protected: CArrayPtr< CNode > * iChildList;

Class CNode

Description

Derivation

Members

Construction and destruction

~CNode()

Description

NewL(TAny *,CNode *)

Description

Parameters

Return value

Member functions

DeleteChildNode(CNode *)

Description

Parameters

DeleteAllChildNodes()

Description

AppendNodeL(TAny *)

Description

Parameters

Return value

AppendNodeToThisNodeL(CNode *)

Description

Parameters

SetDataL(HBufC16 *)

Description

Parameters

Data()const

Description

Return value

SetDataNoDeleteL()

Description

ClearSetDataNoDeleteL()

Description

SetFileDataL(HBufC16 *)

Description

Parameters

ResetDataPointer(HBufC16 *)

Description

Parameters

Root()const

Description

Return value

Child(TInt)const

Description

Parameters

Return value

NextChild(const CNode *)const

Description

Parameters

Return value

PrevChild(const CNode &)const

Description

Parameters

Return value

Parent()const

Description

Return value

ReparentL(CNode *)

Description

Parameters

NextSibling()const

Description

Return value

PrevSibling()const

Description

Return value

NumberImmediateChildren()const

Description

Return value

DeleteAttribute(TAny *)

Description

Parameters

DeleteAllAttributes()

Description

RemoveAttributeNoDelete(TAny *)

Description

Parameters

AttributeCount()const

Description

Class `CNode`

`~CNode()`

`NewL(TAny ,CNode )`

`DeleteChildNode(CNode *)`

`DeleteAllChildNodes()`

`AppendNodeL(TAny *)`

`AppendNodeToThisNodeL(CNode *)`

`SetDataL(HBufC16 *)`

`Data()const`

`SetDataNoDeleteL()`

`ClearSetDataNoDeleteL()`

`SetFileDataL(HBufC16 *)`

`ResetDataPointer(HBufC16 *)`

`Root()const`

`Child(TInt)const`

`NextChild(const CNode *)const`

`PrevChild(const CNode &)const`

`Parent()const`

`ReparentL(CNode *)`

`NextSibling()const`

`PrevSibling()const`

`NumberImmediateChildren()const`

`DeleteAttribute(TAny *)`

`DeleteAllAttributes()`

`RemoveAttributeNoDelete(TAny *)`

`AttributeCount()const`

`AttributeTypeByIndex(TInt)const`

`AttributeByIndex(TInt)const`

`AttributeByIndex(TInt,TAny *&)const`

`AddAttributeL(TAny ,CBase )`

`AddDataAndAttributeL(HBufC16 ,TAny ,CBase *)`

`Attribute(TAny *)const`

`AttributeExists(TAny *)const`

`Type()const`

`SetType(TAny *)`

`Reserved1()`

`Reserved1()const`

`iType`

`iParent`

`iValues`

`iTypes`

`iTypesBasePtr`

`iDataValue`

`iChildList`