Class CTypedNode

class CTypedNode : public CNode;

Description

Template class for a node in a node tree.

The node type is set to the template parameter TNodeType and the attribute type to TAttributeType. These parameters should be pointers to the type required to store the type value: e.g. for a string, a const TDesC*.

The class is thin template over CNode.

Derivation

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

• CNode - (No abstract)

• CTypedNode - Template class for a node in a node tree.

Members

Defined in CTypedNode:

• AddAttributeL(TAttributeType,CBase *)Adds an attribute.
• AddDataAndAttributeL(HBufC16 *,TAttributeType,CBase *)Sets node data and adds an attribute.
• AppendNodeL(TNodeType)Creates a new child node.
• AppendNodeToThisNodeL(CNode *)Adds an existing node as a child.
• Attribute(TAttributeType)constGets an attribute value for a specified attribute type.
• AttributeByIndex(TInt)constGets the attribute value of an attribute at a specified index
• AttributeByIndex(TInt,TAttributeType &)constGets the attribute value and type of an attribute at a specified index..
• AttributeCount()constGets the number of attributes of this node.
• AttributeExists(TAttributeType)constTests if an attribute of a specified type exists.
• AttributeTypeByIndex(TInt)constGets the attribute value of an attribute at a specified index
• CTypedNode(TNodeType,CNode *)
• 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(TAttributeType)Deletes an attribute of a specified type.
• DeleteChildNode(CNode *)Deletes a specified child node.
• NewL(TNodeType,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(TAttributeType)Removes an attribute of a specified type, but does not delete it.
• ReparentL(CNode *)Changes the parent of the node.
• 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(TNodeType)Sets the node type.
• Type()constGets the node type.

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...

Inherited from 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.
• Attribute(TAny *)constGets an attribute value for a specified attribute type.
• AttributeByIndex(TInt,TAny *&)constGets the attribute value and type of an attribute at a specified index..
• AttributeExists(TAny *)constTests if an attribute of a specified type exists.
• DeleteAttribute(TAny *)Deletes an attribute of a specified type.
• NewL(TAny *,CNode *)Allocates and constructs a new node.
• RemoveAttributeNoDelete(TAny *)Removes an attribute of a specified type, but does not delete it.
• SetType(TAny *)Sets the node type.
• iChildList
• iDataValue
• iParent
• iType
• iTypes
• iTypesBasePtr
• iValues

static inline CTypedNode* NewL(TNodeType aType, CNode *aParent);

Description

Allocates and constructs a new node.

Parameters

Return value

protected: inline CTypedNode(TNodeType aType, CNode *aParent);

Description

Parameters

inline void DeleteChildNode(CNode *aNode);

Description

Deletes a specified child node.

Parameters

inline void DeleteAllChildNodes();

Description

Deletes all the child nodes of this node.

inline CTypedNode< TNodeType, TAttributeType >& AppendNodeL(TNodeType aType);

Description

Creates a new child node.

Parameters

Return value

inline void AppendNodeToThisNodeL(CNode *aNode);

Description

Adds an existing node as a child.

Parameters

inline void SetDataL(HBufC16 *aDataNowNodeOwns);

Description

Sets the node data.

The object will delete the data in its destructor.

Parameters

inline 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.

inline 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.

inline 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

inline void ResetDataPointer(HBufC16 *aData);

Description

Resets the node data to a specified pointer.

Existing data owned by the node is deleted.

Parameters

inline HBufC16* Data() const;

Description

Gets the node data.

Return value

inline const CTypedNode& Root() const;

Description

Gets the absolute root node of the tree.

Return value

inline CTypedNode* Child(TInt aByIndex) const;

Description

Gets a child node by index.

Parameters

Return value

inline CTypedNode* NextChild(const CNode *aNode=0) const;

Description

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

Parameters

Return value

inline CTypedNode* PrevChild(const CNode &aNode) const;

Description

Gets the previous child before a specified child.

Parameters

Return value

inline CTypedNode* Parent() const;

Description

Gets the parent of this node.

Return value

inline void ReparentL(CNode *aParent);

Description

Changes the parent of the node.

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

Parameters

inline CTypedNode* NextSibling() const;

Description

Gets the next sibling node.

This asks for the next child of its parent.

Return value

inline CTypedNode* PrevSibling() const;

Description

Gets the previous sibling node.

This asks for the previous child of its parent.

Return value

inline TInt NumberImmediateChildren() const;

Description

Gets the number of children of this node.

Return value

inline void DeleteAttribute(TAttributeType aAttributeType);

Description

Deletes an attribute of a specified type.

Note that the attribute value will be deleted.

Parameters

inline void DeleteAllAttributes();

Description

Delete all node attributes.

Note that attribute values will be deleted.

inline void RemoveAttributeNoDelete(TAttributeType 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

inline TInt AttributeCount() const;

Description

Gets the number of attributes of this node.

Return value

inline TAttributeType AttributeTypeByIndex(TInt aIndex) const;

Description

Gets the attribute value of an attribute at a specified index

Parameters

Return value

inline CBase* AttributeByIndex(TInt aIndex) const;

Description

Gets the attribute value of an attribute at a specified index

Parameters

Return value

inline CBase* AttributeByIndex(TInt aIndex, TAttributeType &aType) const;

Description

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

Parameters

Return value

inline void AddAttributeL(TAttributeType aAttributeType, CBase *aAttributeValue);

Description

Adds an attribute.

The node takes ownership of aAttributeValue.

Parameters

inline void AddDataAndAttributeL(HBufC16 *aData, TAttributeType aAttributeType, 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

inline CBase* Attribute(TAttributeType aAttributeType) const;

Description

Gets an attribute value for a specified attribute type.

Parameters

Return value

inline TBool AttributeExists(TAttributeType aAttributeType) const;

Description

Tests if an attribute of a specified type exists.

Parameters

Return value

inline TNodeType Type() const;

Description

Gets the node type.

Return value

inline void SetType(TNodeType aType);

Description

Sets the node type.

Parameters