glibmm: Glib::NodeTree< T > Class Template Reference
N-ary Trees - trees of data with any number of branches The NodeTree class and its associated functions provide an N-ary tree data structure, in which nodes in the tree can contain arbitrary data. More...
#include <glibmm/nodetree.h>
Public Types | |
using | TraverseFunc = sigc::slot< bool(NodeTree< T >&)> |
using | ForeachFunc = sigc::slot< void(NodeTree< T >&)> |
Public Member Functions | |
NodeTree () | |
NodeTree (const T& the_data) | |
NodeTree (const NodeTree< T >& node) | |
~NodeTree () | |
Removes the instance and its children from the tree, freeing any memory allocated. More... | |
NodeTree< T >& | operator= (const NodeTree< T >& node) |
GNode* | gobj () |
Provides access to the underlying C GObject. More... | |
const GNode* | gobj () const |
Provides access to the underlying C GObject. More... | |
NodeTree< T >& | insert (int position, NodeTree< T >& node) |
Inserts a NodeTree beneath the parent at the given position. More... | |
NodeTree< T >& | insert_before (NodeTree< T >& sibling, NodeTree< T >& node) |
Inserts a NodeTree beneath the parent before the given sibling. More... | |
NodeTree< T >& | insert_after (NodeTree< T >& sibling, NodeTree< T >& node) |
Inserts a NodeTree beneath the parent after the given sibling. More... | |
NodeTree< T >& | append (NodeTree< T >& node) |
Inserts a NodeTree as the last child. More... | |
NodeTree< T >& | prepend (NodeTree< T >& node) |
Inserts a NodeTree as the first child. More... | |
NodeTree< T >* | insert_data (int position, const T& the_data) |
Inserts a new NodeTree at the given position. More... | |
NodeTree< T >* | insert_data_before (NodeTree< T >& sibling, const T& the_data) |
Inserts a new NodeTree before the given sibling. More... | |
NodeTree< T >* | append_data (const T& the_data) |
Inserts a new NodeTree as the last child. More... | |
NodeTree< T >* | prepend_data (const T& the_data) |
Inserts a new NodeTree as the first child. More... | |
void | reverse_children () |
Reverses the order of the children. More... | |
NodeTree< T >* | get_root () |
Returns a pointer to the root of the tree. More... | |
const NodeTree< T >* | get_root () const |
void | traverse (const TraverseFunc& func, TraverseType order=TraverseType::IN_ORDER, TraverseFlags flags=TraverseFlags::ALL, int max_depth=-1) |
Traverses a tree starting at the current node. More... | |
void | foreach (const ForeachFunc& func, TraverseFlags flags=TraverseFlags::ALL) |
Calls a function for each of the children of a NodeTree. More... | |
NodeTree< T >* | find_child (const T& the_data, TraverseFlags flags=TraverseFlags::ALL) |
Finds the first child of a NodeTree with the given data. More... | |
const NodeTree< T >* | find_child (const T& the_data, TraverseFlags flags=TraverseFlags::ALL) const |
Finds the first child of a NodeTree with the given data. More... | |
NodeTree< T >* | find (const T& the_data, TraverseType order=TraverseType::IN_ORDER, TraverseFlags flags=TraverseFlags::ALL) |
Finds a node in a tree. More... | |
const NodeTree< T >* | find (const T& the_data, TraverseType order=TraverseType::IN_ORDER, TraverseFlags flags=TraverseFlags::ALL) const |
Finds a node in a tree. More... | |
int | child_index (const T& the_data) const |
Gets the position of the first child which contains the given data. More... | |
int | child_position (const NodeTree< T >& child) const |
Gets the position with respect to its siblings. More... | |
NodeTree< T >* | first_child () |
Gets the first child. More... | |
const NodeTree< T >* | first_child () const |
Gets the first child. More... | |
NodeTree< T >* | last_child () |
Gets the last child. More... | |
const NodeTree< T >* | last_child () const |
Gets the last child. More... | |
NodeTree< T >* | nth_child (int n) |
Gets the nth child. More... | |
const NodeTree< T >* | nth_child (int n) const |
Gets the nth child. More... | |
NodeTree< T >* | first_sibling () |
Gets the first sibling. More... | |
const NodeTree< T >* | first_sibling () const |
Gets the first sibling. More... | |
NodeTree< T >* | prev_sibling () |
Gets the previous sibling. More... | |
const NodeTree< T >* | prev_sibling () const |
Gets the previous sibling. More... | |
NodeTree< T >* | next_sibling () |
Gets the next sibling. More... | |
const NodeTree< T >* | next_sibling () const |
Gets the next sibling. More... | |
NodeTree< T >* | last_sibling () |
Gets the last sibling. More... | |
const NodeTree< T >* | last_sibling () const |
Gets the last sibling. More... | |
bool | is_leaf () const |
Returns true if this is a leaf node. More... | |
bool | is_root () const |
Returns true if this is the root node. More... | |
guint | depth () const |
Gets the depth of this node. More... | |
guint | node_count (TraverseFlags flags=TraverseFlags::ALL) const |
Gets the number of nodes in a tree. More... | |
guint | child_count () const |
Gets the number children. More... | |
bool | is_ancestor (const NodeTree< T >& descendant) const |
Returns true if this is an ancestor of descendant. More... | |
guint | get_max_height () const |
Gets the maximum height of all branches beneath this node. More... | |
void | unlink () |
Unlinks a node from a tree, resulting in two separate trees. More... | |
T& | data () |
Accessor for this node's data. More... | |
const T& | data () const |
Accessor for this node's data. More... | |
const NodeTree< T >* | parent () const |
Accessor for this node's parent. More... | |
Detailed Description
template<typename T>
class Glib::NodeTree< T >
N-ary Trees - trees of data with any number of branches The NodeTree class and its associated functions provide an N-ary tree data structure, in which nodes in the tree can contain arbitrary data.
To insert a node into a tree use insert(), insert_before(), append() or prepend().
To create a new node and insert it into a tree use insert_data(), insert_data_before(), append_data() and prepend_data().
To reverse the children of a node use reverse_children().
To find a node use root(), find(), find_child(), index_of(), child_index(), first_child(), last_child(), nth_child(), first_sibling(), prev_sibling(), next_sibling() or last_sibling().
To get information about a node or tree use is_leaf(), is_root(), depth(), node_count(), child_count(), is_ancestor() or max_height().
To traverse a tree, calling a function for each node visited in the traversal, use traverse() or foreach().
To remove a node or subtree from a tree use unlink().
Member Typedef Documentation
using Glib::NodeTree< T >::ForeachFunc = sigc::slot<void(NodeTree<T>&)> |
using Glib::NodeTree< T >::TraverseFunc = sigc::slot<bool(NodeTree<T>&)> |
Constructor & Destructor Documentation
|
inline |
|
inlineexplicit |
|
inline |
|
inline |
Removes the instance and its children from the tree, freeing any memory allocated.
Member Function Documentation
|
inline |
|
inline |
|
inline |
Gets the number children.
- Returns
- The number of children.
|
inline |
Gets the position of the first child which contains the given data.
- Parameters
-
the_data The data to find.
- Returns
- The index of the child which contains data, or -1 if the data is not found.
|
inline |
Gets the position with respect to its siblings.
child must be a child of node. The first child is numbered 0, the second 1, and so on.
- Parameters
-
child A child
- Returns
- The position of child with respect to its siblings.
|
inline |
Accessor for this node's data.
|
inline |
Accessor for this node's data.
|
inline |
Gets the depth of this node.
The root node has a depth of 1. For the children of the root node the depth is 2. And so on.
- Returns
- the depth of this node
|
inline |
Finds a node in a tree.
- Parameters
-
order The order in which nodes are visited: TraverseType::IN_ORDER, TraverseType::PRE_ORDER, TraverseType::POST_ORDER, or TraverseType::LEVEL_ORDER flags Which types of children are to be visited: one of TraverseFlags::ALL, TraverseFlags::LEAVES or TraverseFlags::NON_LEAVES. the_data The data for which to search.
- Returns
- The found node, or
nullptr
if the data is not found.
|
inline |
Finds a node in a tree.
- Parameters
-
order The order in which nodes are visited. flags Which types of children are to be visited. the_data The data for which to search.
- Returns
- The found node, or
nullptr
if the data is not found.
|
inline |
Finds the first child of a NodeTree with the given data.
- Parameters
-
flags Which types of children are to be visited, one of TraverseFlags::ALL, TraverseFlags::LEAVES or TraverseFlags::NON_LEAVES. the_data The data for which to search.
- Returns
- the found child, or
nullptr
if the data is not found
|
inline |
Finds the first child of a NodeTree with the given data.
- Parameters
-
flags Which types of children are to be visited, one of TraverseFlags::ALL, TraverseFlags::LEAVES or TraverseFlags::NON_LEAVES. the_data The data for which to search.
- Returns
- the found child, or
nullptr
if the data is not found
|
inline |
Gets the first child.
- Returns
- The first child, or
nullptr
if the node has no children.
|
inline |
Gets the first child.
- Returns
- The first child, or
nullptr
if the node has no children.
|
inline |
Gets the first sibling.
- Returns
- The first sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the first sibling.
- Returns
- The first sibling, or
nullptr
if the node has no siblings.
|
inline |
Calls a function for each of the children of a NodeTree.
Note that it doesn't descend beneath the child nodes.
- Parameters
-
flags Wwhich types of children are to be visited. func The slot to invoke for each visited node.
|
inline |
Gets the maximum height of all branches beneath this node.
This is the maximum distance from the node to all leaf nodes. If root has no children, 1 is returned. If root has children, 2 is returned. And so on.
- Returns
- The maximum height of all branches.
|
inline |
Returns a pointer to the root of the tree.
- Returns
- A pointer to the root of the tree.
|
inline |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Returns true if this is an ancestor of descendant.
This is true if this is the parent of descendant, or if this is the grandparent of descendant etc.
- Parameters
-
descendant A node.
- Returns
- true if this is an ancestor of descendant.
|
inline |
Returns true if this is a leaf node.
- Returns
- true if this is a leaf node.
|
inline |
Returns true if this is the root node.
- Returns
- true if this is the root node.
|
inline |
Gets the last child.
- Returns
- The last child, or
nullptr
if the node has no children.
|
inline |
Gets the last child.
- Returns
- The last child, or
nullptr
if the node has no children.
|
inline |
Gets the last sibling.
- Returns
- The last sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the last sibling.
- Returns
- The last sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the next sibling.
- Returns
- The next sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the next sibling.
- Returns
- The next sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the number of nodes in a tree.
- Parameters
-
flags Which types of children are to be counted: one of TraverseFlags::ALL, TraverseFlags::LEAVES or TraverseFlags::NON_LEAVES
- Returns
- The number of nodes in the tree.
|
inline |
Gets the nth child.
- Returns
- The nth child, or
nullptr
if n is too large.
|
inline |
Gets the nth child.
- Returns
- The nth child, or
nullptr
if n is too large.
|
inline |
|
inline |
Accessor for this node's parent.
- Returns
- The node's parent.
|
inline |
|
inline |
|
inline |
Gets the previous sibling.
- Returns
- The previous sibling, or
nullptr
if the node has no siblings.
|
inline |
Gets the previous sibling.
- Returns
- The previous sibling, or
nullptr
if the node has no siblings.
|
inline |
Reverses the order of the children.
|
inline |
Traverses a tree starting at the current node.
It calls the given function for each node visited. The traversal can be halted at any point by returning true from func.
- Parameters
-
order The order in which nodes are visited. flags Which types of children are to be visited. max_depth The maximum depth of the traversal. Nodes below this depth will not be visited. If max_depth is -1 all nodes in the tree are visited. If max_depth is 1, only the root is visited. If max_depth is 2, the root and its children are visited. And so on. func the slot to invoke for each visited child
|
inline |
Unlinks a node from a tree, resulting in two separate trees.