CTypedNode Class Reference

#include <mw/cnode.h>

class CTypedNode : public CNode

Inherits from

CTypedNode
- CNode
  - CBase

Public Member Functions
void	AddAttributeL(TAttributeType, CBase *)
void	AddDataAndAttributeL(HBufC16 , TAttributeType, CBase )
CTypedNode< TNodeType, TAttributeType > &	AppendNodeL(TNodeType)
void	AppendNodeToThisNodeL(CNode *)
CBase *	Attribute(TAttributeType)
CBase *	AttributeByIndex(TInt)
CBase *	AttributeByIndex(TInt, TAttributeType &)
TInt	AttributeCount()
TBool	AttributeExists(TAttributeType)
TAttributeType	AttributeTypeByIndex(TInt)
CTypedNode *	Child(TInt)
void	ClearSetDataNoDeleteL()
HBufC16 *	Data()
void	DeleteAllAttributes()
void	DeleteAllChildNodes()
void	DeleteAttribute(TAttributeType)
void	DeleteChildNode(CNode *)
CTypedNode *	NewL(TNodeType, CNode *)
CTypedNode *	NextChild(const CNode *)
CTypedNode *	NextSibling()
TInt	NumberImmediateChildren()
CTypedNode *	Parent()
CTypedNode *	PrevChild(const CNode &)
CTypedNode *	PrevSibling()
void	RemoveAttributeNoDelete(TAttributeType)
void	ReparentL(CNode *)
void	ResetDataPointer(HBufC16 *)
const CTypedNode &	Root()
void	SetDataL(HBufC16 *)
void	SetDataNoDeleteL()
void	SetFileDataL(HBufC16 *)
void	SetType(TNodeType)
TNodeType	Type()

Protected Member Functions
	CTypedNode(TNodeType, CNode *)

Inherited Attributes
	CNode::iChildList
	CNode::iDataValue
	CNode::iParent
	CNode::iType
	CNode::iTypes
	CNode::iTypesBasePtr
	CNode::iValues

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()
	CNode::AddAttributeL(TAny ,CBase )
	CNode::AddDataAndAttributeL(HBufC16 ,TAny ,CBase *)
	CNode::AdjustBasePointers()
	CNode::AppendNodeL(TAny *)
	CNode::Attribute(TAny *)const
	CNode::AttributeByIndex(TInt,TAny *&)const
	CNode::AttributeExists(TAny *)const
	CNode::CNode(TAny ,CNode )
	CNode::DeleteAttribute(TAny *)
	CNode::FindChild(const CNode *)const
	CNode::NewL(TAny ,CNode )
	CNode::RemoveAttributeNoDelete(TAny *)
	CNode::SetType(TAny *)
	CNode::SetupDeletableOrNonDeleteableDataLC()
	CNode::~CNode()

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

Constructor & Destructor Documentation

CTypedNode ( TNodeType, CNode * )

CTypedNode	(	TNodeType	aType,
		CNode *	aParent
	)	[protected, inline]

Member Function Documentation

AddAttributeL ( TAttributeType, CBase * )

void	AddAttributeL	(	TAttributeType	aAttributeType,
			CBase *	aAttributeValue
		)	[inline]

Adds an attribute.

The node takes ownership of aAttributeValue.

Parameters
aAttributeType	Attribute type
aAttributeValue	Attribute value

AddDataAndAttributeL ( HBufC16 , TAttributeType, CBase )

void	AddDataAndAttributeL	(	HBufC16 *	aData,
			TAttributeType	aAttributeType,
			CBase *	aAttributeValue
		)	[inline]

Sets node data and adds an attribute.

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

Parameters
aData	Node data
aAttributeType	Attribute type
aAttributeValue	Attribute value

AppendNodeL ( TNodeType )

CTypedNode< TNodeType, TAttributeType > &

AppendNodeL

(

TNodeType

aType

)

[inline]

Creates a new child node.

Parameters
aType	Node type

Return Value: The new child node

AppendNodeToThisNodeL ( CNode * )

void

AppendNodeToThisNodeL

(

CNode *

aNode

)

[inline]

Reimplemented from CNode::AppendNodeToThisNodeL(CNode *)

Adds an existing node as a child.

Parameters
aNode	Node to make a child

Attribute ( TAttributeType )

CBase *

Attribute

(

TAttributeType

aAttributeType

)

const [inline]

Gets an attribute value for a specified attribute type.

Parameters
aAttributeType	Attribute type

Return Value: Attribute value

AttributeByIndex ( TInt )

CBase *

AttributeByIndex

(

TInt

aIndex

)

const [inline]

Reimplemented from CNode::AttributeByIndex(TInt)const

Gets the attribute value of an attribute at a specified index

Parameters
aIndex	Attribute index

Return Value: Attribute value

AttributeByIndex ( TInt, TAttributeType & )

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

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

Parameters
aIndex	Attribute index
aType	On return, the attribute type

Return Value: Attribute value

AttributeCount ( )

TInt

AttributeCount

(

)

const [inline]

Reimplemented from CNode::AttributeCount()const

Gets the number of attributes of this node.

Return Value: Number of attributes of this node

AttributeExists ( TAttributeType )

TBool

AttributeExists

(

TAttributeType

aAttributeType

)

const [inline]

Tests if an attribute of a specified type exists.

Parameters
aAttributeType	Attribute type

Return Value: True if the attribute exists, otherwise false

AttributeTypeByIndex ( TInt )

TAttributeType

AttributeTypeByIndex

(

TInt

aIndex

)

const [inline]

Reimplemented from CNode::AttributeTypeByIndex(TInt)const

Gets the attribute value of an attribute at a specified index

Parameters
aIndex	Attribute index

Return Value: Attribute value

Child ( TInt )

CTypedNode *

Child

(

TInt

aByIndex

)

const [inline]

Reimplemented from CNode::Child(TInt)const

Gets a child node by index.

Parameters
aByIndex	Index of the child node

Return Value: Child node

ClearSetDataNoDeleteL ( )

void

ClearSetDataNoDeleteL

(

)

[inline]

Reimplemented from CNode::ClearSetDataNoDeleteL()

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.

Data ( )

HBufC16 *

Data

(

)

const [inline]

Reimplemented from CNode::Data()const

Gets the node data.

Return Value: Node data or NULL if no data is set

DeleteAllAttributes ( )

void

DeleteAllAttributes

(

)

[inline]

Reimplemented from CNode::DeleteAllAttributes()

Delete all node attributes.

Note that attribute values will be deleted.

DeleteAllChildNodes ( )

void

DeleteAllChildNodes

(

)

[inline]

Reimplemented from CNode::DeleteAllChildNodes()

Deletes all the child nodes of this node.

DeleteAttribute ( TAttributeType )

void

DeleteAttribute

(

TAttributeType

aAttributeType

)

[inline]

Deletes an attribute of a specified type.

Note that the attribute value will be deleted.

Parameters
aAttributeType	Attribute type

DeleteChildNode ( CNode * )

void

DeleteChildNode

(

CNode *

aNode

)

[inline]

Reimplemented from CNode::DeleteChildNode(CNode *)

Deletes a specified child node.

Parameters
aNode	Node to delete

NewL ( TNodeType, CNode * )

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

Allocates and constructs a new node.

Parameters
aType	The type of the node
aParent	The parent of this node

Return Value: New node

NextChild ( const CNode * )

CTypedNode *

NextChild

(

const CNode *

aNode = NULL

)

const [inline]

Reimplemented from CNode::NextChild(const CNode *)const

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

Parameters
aNode	Child node or NULL to get the first child

Return Value: First or next child node

NextSibling ( )

CTypedNode *

NextSibling

(

)

const [inline]

Reimplemented from CNode::NextSibling()const

Gets the next sibling node.

This asks for the next child of its parent.

Return Value: Next sibling node

NumberImmediateChildren ( )

TInt

NumberImmediateChildren

(

)

const [inline]

Reimplemented from CNode::NumberImmediateChildren()const

Gets the number of children of this node.

Return Value: Number of children of this node

Parent ( )

CTypedNode *

Parent

(

)

const [inline]

Reimplemented from CNode::Parent()const

Gets the parent of this node.

Return Value: Parent

PrevChild ( const CNode & )

CTypedNode *

PrevChild

(

const CNode &

aNode

)

const [inline]

Reimplemented from CNode::PrevChild(const CNode &)const

Gets the previous child before a specified child.

Parameters
aNode	Child node

Return Value: Previous child node

PrevSibling ( )

CTypedNode *

PrevSibling

(

)

const [inline]

Reimplemented from CNode::PrevSibling()const

Gets the previous sibling node.

This asks for the previous child of its parent.

Return Value: Previous sibling node

RemoveAttributeNoDelete ( TAttributeType )

void

RemoveAttributeNoDelete

(

TAttributeType

aAttributeType

)

[inline]

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
aAttributeType	Attribute type

ReparentL ( CNode * )

void

ReparentL

(

CNode *

aParent

)

[inline]

Reimplemented from CNode::ReparentL(CNode *)

Changes the parent of the node.

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

Parameters
aParent	New parent

ResetDataPointer ( HBufC16 * )

void

ResetDataPointer

(

HBufC16 *

aData

)

[inline]

Reimplemented from CNode::ResetDataPointer(HBufC16 *)

Resets the node data to a specified pointer.

Existing data owned by the node is deleted.

Parameters
aData	Root node

Root ( )

const CTypedNode &

Root

(

)

const [inline]

Reimplemented from CNode::Root()const

Gets the absolute root node of the tree.

Return Value: Root node

SetDataL ( HBufC16 * )

void

SetDataL

(

HBufC16 *

aDataNowNodeOwns

)

[inline]

Reimplemented from CNode::SetDataL(HBufC16 *)

Sets the node data.

The object will delete the data in its destructor.

Parameters
aDataNowNodeOwns	Node data

SetDataNoDeleteL ( )

void

SetDataNoDeleteL

(

)

[inline]

Reimplemented from CNode::SetDataNoDeleteL()

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.

SetFileDataL ( HBufC16 * )

void

SetFileDataL

(

HBufC16 *

aFileDataLocationNowNodeOwns

)

[inline]

Reimplemented from CNode::SetFileDataL(HBufC16 *)

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

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

Parameters
aFileDataLocationNowNodeOwns	Name of the file containing the data

SetType ( TNodeType )

void

SetType

(

TNodeType

aType

)

[inline]

Sets the node type.

Parameters
aType	Node type

Type ( )

TNodeType

Type

(

)

const [inline]

Reimplemented from CNode::Type()const

Gets the node type.

Return Value: Node type

CTypedNode Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

CTypedNode ( TNodeType, CNode * )

Member Function Documentation

AddAttributeL ( TAttributeType, CBase * )

AddDataAndAttributeL ( HBufC16 *, TAttributeType, CBase * )

AppendNodeL ( TNodeType )

AppendNodeToThisNodeL ( CNode * )

Attribute ( TAttributeType )

AttributeByIndex ( TInt )

AttributeByIndex ( TInt, TAttributeType & )

AttributeCount ( )

AttributeExists ( TAttributeType )

AttributeTypeByIndex ( TInt )

Child ( TInt )

ClearSetDataNoDeleteL ( )

Data ( )

DeleteAllAttributes ( )

DeleteAllChildNodes ( )

DeleteAttribute ( TAttributeType )

DeleteChildNode ( CNode * )

NewL ( TNodeType, CNode * )

NextChild ( const CNode * )

NextSibling ( )

NumberImmediateChildren ( )

Parent ( )

PrevChild ( const CNode & )

PrevSibling ( )

RemoveAttributeNoDelete ( TAttributeType )

ReparentL ( CNode * )

ResetDataPointer ( HBufC16 * )

Root ( )

SetDataL ( HBufC16 * )

SetDataNoDeleteL ( )

SetFileDataL ( HBufC16 * )

SetType ( TNodeType )

Type ( )

AddDataAndAttributeL ( HBufC16 , TAttributeType, CBase )