GLib.Node¶
Fields¶
Name |
Type |
Access |
Description |
---|---|---|---|
children |
r/w |
points to the first child of the |
|
data |
r/w |
contains the actual data of the node. |
|
next |
r/w |
points to the node’s next sibling (a sibling is another |
|
parent |
r/w |
points to the parent of the |
|
prev |
r/w |
points to the node’s previous sibling. |
Methods¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Details¶
- class GLib.Node¶
The
GLib.Node
struct represents one node in a n-ary tree.- child_index(data)[source]¶
- Parameters:
- Returns:
the index of the child of self which contains data, or -1 if the data is not found
- Return type:
Gets the position of the first child of a
GLib.Node
which contains the given data.
- child_position(child)[source]¶
- Parameters:
child (
GLib.Node
) – a child of self- Returns:
the position of child with respect to its siblings
- Return type:
Gets the position of a
GLib.Node
with respect to its siblings. child must be a child of self. The first child is numbered 0, the second 1, and so on.
- depth()[source]¶
-
Gets the depth of a
GLib.Node
.If self is
None
the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on.
- is_ancestor(descendant)[source]¶
- Parameters:
- Returns:
True
if self is an ancestor of descendant- Return type:
Returns
True
if self is an ancestor of descendant. This is true if node is the parent of descendant, or if node is the grandparent of descendant etc.
- max_height()[source]¶
- Returns:
the maximum height of the tree beneath self
- Return type:
Gets the maximum height of all branches beneath a
GLib.Node
. This is the maximum distance from theGLib.Node
to all leaf nodes.If self is
None
, 0 is returned. If self has no children, 1 is returned. If self has children, 2 is returned. And so on.
- n_children()[source]¶
- Returns:
the number of children of self
- Return type:
Gets the number of children of a
GLib.Node
.
- n_nodes(flags)[source]¶
- Parameters:
flags (
GLib.TraverseFlags
) – which types of children are to be counted, one ofGLib.TraverseFlags.ALL
,GLib.TraverseFlags.LEAVES
andGLib.TraverseFlags.NON_LEAVES
- Returns:
the number of nodes in the tree
- Return type:
Gets the number of nodes in a tree.