GLib-2.0 ▶ GLib ▶ Node

constructor

• new Node(): GLib.Node

  Returns GLib.Node

data

Static$gtype

child_index

• child_index(data?: any): number

  Gets the position of the first child of a GLib.Node which contains the given data.

  Parameters

  • Optionaldata: any

    the data to find

  Returns number

  the index of the child of node which contains data, or -1 if the data is not found

child_position

• child_position(child: GLib.Node): number

  Gets the position of a GLib.Node 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: GLib.Node

    a child of node

  Returns number

  the position of child with respect to its siblings

children_foreach

• children_foreach(flags: TraverseFlags, func: NodeForeachFunc): void

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

  Parameters

  • flags: TraverseFlags

    which types of children are to be visited, one of GLib.TraverseFlags.ALL, GLib.TraverseFlags.LEAVES and GLib.TraverseFlags.NON_LEAVES

  • func: NodeForeachFunc

    the function to call for each visited node

  Returns void

depth

• depth(): number

  Gets the depth of a GLib.Node.

  If node is null 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.

  Returns number

  the depth of the GLib.Node

destroy

• destroy(): void

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

  Returns void

is_ancestor

• is_ancestor(descendant: GLib.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.

  Parameters

  • descendant: GLib.Node

    a GLib.Node

  Returns boolean

  true if node is an ancestor of descendant

max_height

• max_height(): number

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

  If root is null, 0 is returned. If root has no children, 1 is returned. If root has children, 2 is returned. And so on.

  Returns number

  the maximum height of the tree beneath root

n_children

• n_children(): number

  Gets the number of children of a GLib.Node.

  Returns number

  the number of children of node

n_nodes

• n_nodes(flags: TraverseFlags): number

  Gets the number of nodes in a tree.

  Parameters

  • flags: TraverseFlags

    which types of children are to be counted, one of GLib.TraverseFlags.ALL, GLib.TraverseFlags.LEAVES and GLib.TraverseFlags.NON_LEAVES

  Returns number

  the number of nodes in the tree

reverse_children

• reverse_children(): void

  Reverses the order of the children of a GLib.Node. (It doesn't change the order of the grandchildren.)

  Returns void

traverse

• traverse(
      order: TraverseType,
      flags: TraverseFlags,
      max_depth: number,
      func: NodeTraverseFunc,
  ): void

  Traverses a tree starting at the given root GLib.Node. It calls the given function for each node visited. The traversal can be halted at any point by returning true from func. func must not do anything that would modify the structure of the tree.

  Parameters

  • order: TraverseType

    the order in which nodes are visited - GLib.TraverseType.IN_ORDER, GLib.TraverseType.PRE_ORDER, GLib.TraverseType.POST_ORDER, or GLib.TraverseType.LEVEL_ORDER.

  • flags: TraverseFlags

    which types of children are to be visited, one of GLib.TraverseFlags.ALL, GLib.TraverseFlags.LEAVES and GLib.TraverseFlags.NON_LEAVES

  • max_depth: number

    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 depth is 1, only the root is visited. If depth is 2, the root and its children are visited. And so on.

  • func: NodeTraverseFunc

    the function to call for each visited GLib.Node

  Returns void

unlink

• unlink(): void

  Unlinks a GLib.Node from a tree, resulting in two separate trees.

  Returns void

Staticpop_allocator

• pop_allocator(): void

  Returns void

Staticpush_allocator

• push_allocator(allocator: GLib.Allocator): void

  Parameters

  • allocator: GLib.Allocator

  Returns void