Node

class Node(pointer: <Error class: unknown class><<Error class: unknown class>>) : Record

The #GNode struct represents one node in a glib-N-ary-Trees.

Skipped during bindings generation

parameter data: gpointer
parameter allocator: Allocator
field data: gpointer

Constructors

Node

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion : RecordCompanion<Node, <Error class: unknown class>>

Properties

children

val children: Node?

points to the first child of the #GNode. The other children are accessed by using the @next pointer of each child.

glibNodePointer

val glibNodePointer: <Error class: unknown class><<Error class: unknown class>>

val next: Node?

points to the node's next sibling (a sibling is another #GNode with the same parent).

parent

val parent: Node?

points to the parent of the #GNode, or is null if the #GNode is the root of the tree.

val prev: Node?

points to the node's previous sibling.

Functions

childPosition

fun childPosition(child: Node): Int

Gets the position of a #GNode with respect to its siblings.

childrenForeach

fun childrenForeach(flags: TraverseFlags, func: NodeForeachFunc)

Calls a function for each of the children of a #GNode. Note that it doesn't descend beneath the child nodes. @func must not do anything that would modify the structure of the tree.

depth

fun depth(): <Error class: unknown class>

Gets the depth of a #GNode.

destroy

fun destroy()

Removes @root and its children from the tree, freeing any memory allocated.

isAncestor

fun isAncestor(descendant: Node): Boolean

Returns true if @node is an ancestor of @descendant. This is true if node is the parent of @descendant, or if node is the grandparent of @descendant etc.

maxHeight

fun maxHeight(): <Error class: unknown class>

Gets the maximum height of all branches beneath a #GNode. This is the maximum distance from the #GNode to all leaf nodes.

nChildren

fun nChildren(): <Error class: unknown class>

Gets the number of children of a #GNode.

nNodes

fun nNodes(flags: TraverseFlags): <Error class: unknown class>

Gets the number of nodes in a tree.

reverseChildren

fun reverseChildren()

Reverses the order of the children of a #GNode. (It doesn't change the order of the grandchildren.)

traverse

fun traverse(order: TraverseType, flags: TraverseFlags, maxDepth: Int, func: NodeTraverseFunc)

Traverses a tree starting at the given root #GNode. It calls the given function for each node visited. The traversal can be halted at any point by returning true from @func.

unlink

fun unlink()

Unlinks a #GNode from a tree, resulting in two separate trees.