MXCFWTree Class Reference
XCFW Tree interface Provides access to tree functions
XCFW.lib
- Since
- Series 60 3.1
Member Functions Documentation
AddNodeL(CGECOObjectBase *, MXCFWNode *, MXCFWNode *)
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 * aData | The CXCFWObjectParser (derived) object to be added to tree |
MXCFWNode * aParent | Parent node for the added node |
MXCFWNode * aInsertBefore | Reference node - new node will be inserted before this node in the siblings of given parent. |
AddNodeL(CGECOObjectBase *, MXCFWNode *)
AddNodeL(CGECOObjectBase *)
DTDName()
const TDesC & | DTDName | ( | ) | [pure virtual] |
Returns name of localization DTD file (by default without path)
GetChildNodesL(MXCFWNode *, RNodeArray &)
Returns child nodes of the given parentm from tree
- Since
- Series60 3.1
Parameters
MXCFWNode * aParent | Parent node whose child nodes will be returned |
RNodeArray & aNodeList | Reference to array where child nodes are added |
GetNodesOfTypeL(const TDesC &, RNodeArray &, MXCFWNode *, TBool)
Returns nodes of certain type from tree
- Since
- Series60 3.1
Parameters
const TDesC & aType | Node type identifier that corresponds to a XML tag |
RNodeArray & aNodeList | Reference to array where found nodes are added |
MXCFWNode * aParent | Parent node where the search is started from |
TBool aRecursive | Determines if search is done recursively (finds also grandchildren) |
IsLocked()
TBool
| IsLocked | ( | ) | [pure virtual] |
MoveNodeL(MXCFWNode *, MXCFWNode *, MXCFWNode *)
Moves a node to another position in tree
- Since
- Series60 3.1
Parameters
MXCFWNode * aNodeToMove | Node that is to be repositioned |
MXCFWNode * aNewParent | New parent for node to be repositioned |
MXCFWNode * aInsertBefore | New node will be inserted before this node among the given parents children |
Nodes()
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 *)
void | RemoveNodeL | ( | MXCFWNode * | aNodeToRemove | ) | [pure virtual] |
Removes a node from the tree
- Since
- Series60 3.1
Parameters
MXCFWNode * aNodeToRemove | Node to be removed from tree |
Root()
Returns root node of the tree
- Since
- Series60 3.1
SetDTDNameL(const TDesC &)
void | SetDTDNameL | ( | 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 & aName | DTD file name (by default without path) |
SetLocked(TBool)
void | SetLocked | ( | TBool | aLockStatus | ) | [pure virtual] |
Sets tree lock status If tree is locked, nodes cannot be added/moved/removed
Parameters
TBool aLockStatus | sets the lock status |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.