CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csTreeNode Class Reference

A generic tree class. More...

#include <csutil/tree.h>

List of all members.

Public Member Functions

bool IsLeaf ()
 Returns true if this node has no children.
void RemoveChild (csTreeNode *child)
 Remove a child node.
void AddChild (csTreeNode *child)
 Add a child node.
 csTreeNode (csTreeNode *theParent=0)
 Create node, optionally as a child of theParent.
csTreeNodeDSF (bool(*TreeFunc)(csTreeNode *node, void *param, bool stopOnSuccess), bool(*SelBranch)(csTreeNode *node), void *param, bool stopOnSuccess)
 Execute a function on this node and its children.
csTreeNodeBSF (bool(*TreeFunc)(csTreeNode *node, void *param, bool stopOnSuccess), bool(*SelBranch)(csTreeNode *node), void *param, bool stopOnSuccess)
 Execute a function on this node and its children.


Detailed Description

A generic tree class.

Definition at line 28 of file tree.h.


Constructor & Destructor Documentation

csTreeNode::csTreeNode csTreeNode theParent = 0  )  [inline]
 

Create node, optionally as a child of theParent.

Definition at line 47 of file tree.h.

References children, and csArray< T, ElementHandler, MemoryAllocator >::Push().


Member Function Documentation

void csTreeNode::AddChild csTreeNode child  )  [inline]
 

Add a child node.

Definition at line 43 of file tree.h.

References parent.

csTreeNode* csTreeNode::BSF bool(*)(csTreeNode *node, void *param, bool stopOnSuccess)  TreeFunc,
bool(*)(csTreeNode *node)  SelBranch,
void *  param,
bool  stopOnSuccess
[inline]
 

Execute a function on this node and its children.

Do this in "BreadthSearchFirst" order, that is check first all direct children before diving into subchildren. Returns the last node where TreeFunc resulted in TRUE. If stopOnSuccess is true, then execution is stoped after first successful execution of TreeFunc. SelBranch lets you decide which children to select for further investugation. 0 means all children.

Definition at line 100 of file tree.h.

References children, csArray< T, ElementHandler, MemoryAllocator >::DeleteAll(), csArray< T, ElementHandler, MemoryAllocator >::DeleteIndex(), IsLeaf(), csArray< T, ElementHandler, MemoryAllocator >::Length(), and csArray< T, ElementHandler, MemoryAllocator >::Push().

csTreeNode* csTreeNode::DSF bool(*)(csTreeNode *node, void *param, bool stopOnSuccess)  TreeFunc,
bool(*)(csTreeNode *node)  SelBranch,
void *  param,
bool  stopOnSuccess
[inline]
 

Execute a function on this node and its children.

Do this in "DepthSearchFirst" order, that is check a childs children before testing the next direct child. Returns the last node where TreeFunc resulted in TRUE. If stopOnSuccess is true, then execution is stoped after first successful execution of TreeFunc. SelBranch lets you decide which children to select for further investigation. 0 means all children.

Definition at line 69 of file tree.h.

bool csTreeNode::IsLeaf  )  [inline]
 

Returns true if this node has no children.

Definition at line 32 of file tree.h.

Referenced by BSF().

void csTreeNode::RemoveChild csTreeNode child  )  [inline]
 

Remove a child node.

Definition at line 36 of file tree.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1