Node

class Node(val glibNodePointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

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

Constructors

Node

constructor()

Allocate a new Node.

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

Allocate a new Node using the provided AutofreeScope.

constructor(data: <Error class: unknown class>, next: Node?, prev: Node?, parent: Node?, children: Node?)

Allocate a new Node.

constructor(data: <Error class: unknown class>, next: Node?, prev: Node?, parent: Node?, children: Node?, scope: <Error class: unknown class>)

Allocate a new Node using the provided AutofreeScope.

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

Types

Companion

object Companion

Properties

children

var children: Node?

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

data

var data: <Error class: unknown class>

contains the actual data of the node.

glibNodePointer

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

handle

open override val handle: <Error class: unknown class>

var next: Node?

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

parent

var parent: Node?

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

var prev: Node?

points to the node's previous sibling.

Functions

addCleaner

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

childIndex

fun childIndex(data: <Error class: unknown class>? = null): <Error class: unknown class>

Gets the position of the first child of a #GNode which contains the given data.

childPosition

fun childPosition(child: Node): <Error class: unknown class>

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.

copy

fun copy(): Node

Recursively copies a #GNode (but does not deep-copy the data inside the nodes, see g_node_copy_deep() if you need that).

copyDeep

fun copyDeep(copyFunc: CopyFunc): Node

Recursively copies a #GNode and its data.

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.

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

find

fun find(order: TraverseType, flags: TraverseFlags, data: <Error class: unknown class>? = null): Node

Finds a #GNode in a tree.

findChild

fun findChild(flags: TraverseFlags, data: <Error class: unknown class>? = null): Node

Finds the first child of a #GNode with the given data.

firstSibling

fun firstSibling(): Node

Gets the first sibling of a #GNode. This could possibly be the node itself.

getRoot

fun getRoot(): Node

Gets the root of a tree.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

hashCode

open override fun hashCode(): Int

insert

fun insert(position: <Error class: unknown class>, node: Node): Node

Inserts a #GNode beneath the parent at the given position.

insertAfter

fun insertAfter(sibling: Node, node: Node): Node

Inserts a #GNode beneath the parent after the given sibling.

insertBefore

fun insertBefore(sibling: Node, node: Node): Node

Inserts a #GNode beneath the parent before the given sibling.

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.

lastChild

fun lastChild(): Node

Gets the last child of a #GNode.

lastSibling

fun lastSibling(): Node

Gets the last sibling of a #GNode. This could possibly be the node itself.

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.

nthChild

fun nthChild(n: <Error class: unknown class>): Node

Gets a child of a #GNode, using the given index. The first child is at index 0. If the index is too big, null is returned.

prepend

fun prepend(node: Node): Node

Inserts a #GNode as the first child of the given parent.

removeCleaner

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.

reverseChildren

fun reverseChildren()

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

toString

open override fun toString(): String

traverse

fun traverse(order: TraverseType, flags: TraverseFlags, maxDepth: <Error class: unknown class>, 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.