MXCFWTree Class Reference

class MXCFWTree

XCFW Tree interface Provides access to tree functions

XCFW.lib
Since
Series 60 3.1

Member Functions Documentation

AddNodeL(CGECOObjectBase *, MXCFWNode *, MXCFWNode *)

MXCFWNode *AddNodeL(CGECOObjectBase *aData,
MXCFWNode *aParent,
MXCFWNode *aInsertBefore
)[pure virtual]
Adds new node to content tree. Returns reference to added node. Three overloads are provided to allow use without parent when creating root, or use without insertbefore reference to allow adding nodes as last child of the given parent. aData ownership is transferred at the beginning of the method!
Since
Series60 3.1

Parameters

CGECOObjectBase * aDataThe CXCFWObjectParser (derived) object to be added to tree
MXCFWNode * aParentParent node for the added node
MXCFWNode * aInsertBeforeReference node - new node will be inserted before this node in the siblings of given parent.

AddNodeL(CGECOObjectBase *, MXCFWNode *)

MXCFWNode *AddNodeL(CGECOObjectBase *aData,
MXCFWNode *aParent
)[pure virtual]

Parameters

CGECOObjectBase * aData
MXCFWNode * aParent

AddNodeL(CGECOObjectBase *)

MXCFWNode *AddNodeL(CGECOObjectBase *aData)[pure virtual]

Parameters

CGECOObjectBase * aData

DTDName()

const TDesC &DTDName()[pure virtual]

Returns name of localization DTD file (by default without path)

GetChildNodesL(MXCFWNode *, RNodeArray &)

voidGetChildNodesL(MXCFWNode *aParent,
RNodeArray &aNodeList
)[pure virtual]
Returns child nodes of the given parentm from tree
Since
Series60 3.1

Parameters

MXCFWNode * aParentParent node whose child nodes will be returned
RNodeArray & aNodeListReference to array where child nodes are added

GetNodesOfTypeL(const TDesC &, RNodeArray &, MXCFWNode *, TBool)

voidGetNodesOfTypeL(const TDesC &aType,
RNodeArray &aNodeList,
MXCFWNode *aParent,
TBoolaRecursive
)[pure virtual]
Returns nodes of certain type from tree
Since
Series60 3.1

Parameters

const TDesC & aTypeNode type identifier that corresponds to a XML tag
RNodeArray & aNodeListReference to array where found nodes are added
MXCFWNode * aParentParent node where the search is started from
TBool aRecursiveDetermines if search is done recursively (finds also grandchildren)

IsLocked()

TBool IsLocked()[pure virtual]

Returns tree lock status

MoveNodeL(MXCFWNode *, MXCFWNode *, MXCFWNode *)

voidMoveNodeL(MXCFWNode *aNodeToMove,
MXCFWNode *aNewParent,
MXCFWNode *aInsertBefore
)[pure virtual]
Moves a node to another position in tree
Since
Series60 3.1

Parameters

MXCFWNode * aNodeToMoveNode that is to be repositioned
MXCFWNode * aNewParentNew parent for node to be repositioned
MXCFWNode * aInsertBeforeNew node will be inserted before this node among the given parents children

Nodes()

RNodeArray &Nodes()[pure virtual]
Returns all tree nodes in an array of MXCFWNode pointers NOTE: node order does not necessarily reflect the current order in tree, as nodes may have been moved.
Since
Series60 3.1

RemoveNodeL(MXCFWNode *)

voidRemoveNodeL(MXCFWNode *aNodeToRemove)[pure virtual]
Removes a node from the tree
Since
Series60 3.1

Parameters

MXCFWNode * aNodeToRemoveNode to be removed from tree

Root()

MXCFWNode *Root()[pure virtual]
Returns root node of the tree
Since
Series60 3.1

SetDTDNameL(const TDesC &)

voidSetDTDNameL(const TDesC &aName)[pure virtual]

Sets localization dtd name for this content tree This information is used when saving the tree if no DTD is specified in SaveL command

Parameters

const TDesC & aNameDTD file name (by default without path)

SetLocked(TBool)

voidSetLocked(TBoolaLockStatus)[pure virtual]

Sets tree lock status If tree is locked, nodes cannot be added/moved/removed

Parameters

TBool aLockStatussets the lock status