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(), AddDataAndAttributeL(), AppendNodeL(), AppendNodeToThisNodeL(), Attribute(), AttributeByIndex(), AttributeByIndex(), AttributeCount(), AttributeExists(), AttributeTypeByIndex(), Child(), ClearSetDataNoDeleteL(), Data(), DeleteAllAttributes(), DeleteAllChildNodes(), DeleteAttribute(), DeleteChildNode(), NewL(), NextChild(), NextSibling(), NumberImmediateChildren(), Parent(), PrevChild(), PrevSibling(), RemoveAttributeNoDelete(), ReparentL(), Reserved1(), Reserved1(), ResetDataPointer(), Root(), SetDataL(), SetDataNoDeleteL(), SetFileDataL(), SetType(), Type(), iChildList, iDataValue, iParent, iType, iTypes, iTypesBasePtr, iValues, ~CNode()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C ~CNode();

Description

Destructor.

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

static IMPORT_C 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

IMPORT_C void DeleteChildNode(CNode *aNode);

Description

Deletes a specified child node.

Parameters

CNode *aNode Node to delete

IMPORT_C void DeleteAllChildNodes();

Description

Deletes all the child nodes of this node.

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

IMPORT_C void AppendNodeToThisNodeL(CNode *aNode);

Description

Adds an existing node as a child.

Parameters

CNode *aNode Node to make a child

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

IMPORT_C HBufC16 *Data() const;

Description

Gets the node data.

Return value

HBufC16 * Node data or NULL if no data is set

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.

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.

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

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

IMPORT_C const CNode &Root() const;

Description

Gets the absolute root node of the tree.

Return value

const CNode & Root node

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

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

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

IMPORT_C CNode *Parent() const;

Description

Gets the parent of this node.

Return value

CNode * Parent

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

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

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

IMPORT_C TInt NumberImmediateChildren() const;

Description

Gets the number of children of this node.

Return value

TInt Number of children of this node

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

IMPORT_C void DeleteAllAttributes();

Description

Delete all node attributes.

Note that attribute values will be deleted.

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

IMPORT_C TInt AttributeCount() const;

Description

Gets the number of attributes of this node.

Return value

TInt Number of attributes of this node

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

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

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

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

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

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

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

IMPORT_C TAny *Type() const;

Description

Gets the node type.

Return value

TAny * Node type

IMPORT_C void SetType(TAny *aType);

Description

Sets the node type.

Parameters

TAny *aType Node type

private: virtual void Reserved1();

Description

private: virtual void Reserved1() const;

Description

protected: TAny * iType;

Description

protected: CNode * iParent;

Description

protected: CArrayPtrFlat< CBase > iValues;

Description

protected: CArrayPtrFlat< TAny > iTypes;

Description

protected: TInt32 * iTypesBasePtr;

Description

protected: CDataNoDelete * iDataValue;

Description

protected: CArrayPtr< CNode > * iChildList;

Description