Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GLib.Structs.Node

Contents

Exported types
Methods
Properties

Description

The Node struct represents one node in a [n-ary tree][glib-N-ary-Trees].

Synopsis

newtype Node = Node (ManagedPtr Node)
newZeroNode :: MonadIO m => m Node
noNode :: Maybe Node
nodeChildIndex :: (HasCallStack, MonadIO m) => Node -> Ptr () -> m Int32
nodeChildPosition :: (HasCallStack, MonadIO m) => Node -> Node -> m Int32
nodeDepth :: (HasCallStack, MonadIO m) => Node -> m Word32
nodeDestroy :: (HasCallStack, MonadIO m) => Node -> m ()
nodeIsAncestor :: (HasCallStack, MonadIO m) => Node -> Node -> m Bool
nodeMaxHeight :: (HasCallStack, MonadIO m) => Node -> m Word32
nodeNChildren :: (HasCallStack, MonadIO m) => Node -> m Word32
nodeNNodes :: (HasCallStack, MonadIO m) => Node -> [TraverseFlags] -> m Word32
nodeReverseChildren :: (HasCallStack, MonadIO m) => Node -> m ()
nodeUnlink :: (HasCallStack, MonadIO m) => Node -> m ()
clearNodeChildren :: MonadIO m => Node -> m ()
getNodeChildren :: MonadIO m => Node -> m (Maybe Node)
setNodeChildren :: MonadIO m => Node -> Ptr Node -> m ()
clearNodeData :: MonadIO m => Node -> m ()
getNodeData :: MonadIO m => Node -> m (Ptr ())
setNodeData :: MonadIO m => Node -> Ptr () -> m ()
clearNodeNext :: MonadIO m => Node -> m ()
getNodeNext :: MonadIO m => Node -> m (Maybe Node)
setNodeNext :: MonadIO m => Node -> Ptr Node -> m ()
clearNodeParent :: MonadIO m => Node -> m ()
getNodeParent :: MonadIO m => Node -> m (Maybe Node)
setNodeParent :: MonadIO m => Node -> Ptr Node -> m ()
clearNodePrev :: MonadIO m => Node -> m ()
getNodePrev :: MonadIO m => Node -> m (Maybe Node)
setNodePrev :: MonadIO m => Node -> Ptr Node -> m ()

Exported types

newtype Node Source #

Memory-managed wrapper type.

Constructors

Node (ManagedPtr Node)

Instances

WrappedPtr Node Source #
Instance details Defined in GI.GLib.Structs.Node Methods wrappedPtrCalloc :: IO (Ptr Node) # wrappedPtrCopy :: Node -> IO Node # wrappedPtrFree :: Maybe (FunPtr (Ptr Node -> IO ())) #
tag ~ AttrSet => Constructible Node tag Source #
Instance details Defined in GI.GLib.Structs.Node Methods new :: MonadIO m => (ManagedPtr Node -> Node) -> [AttrOp Node tag] -> m Node #

newZeroNode :: MonadIO m => m Node Source #

Construct a Node struct initialized to zero.

noNode :: Maybe Node Source #

A convenience alias for Nothing :: Maybe Node.

Methods

childIndex

nodeChildIndex Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`
-> Ptr ()	`data`: the data to find
-> m Int32	Returns: the index of the child of `node` which contains `data`, or -1 if the data is not found

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

childPosition

nodeChildPosition Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`
-> Node	`child`: a child of `node`
-> m Int32	Returns: the position of `child` with respect to its siblings

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

depth

nodeDepth Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`
-> m Word32	Returns: the depth of the `Node`

Gets the depth of a Node.

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

destroy

nodeDestroy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`root`: the root of the tree/subtree to destroy
-> m ()

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

isAncestor

nodeIsAncestor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`
-> Node	`descendant`: a `Node`
-> m Bool	Returns: `True` if `node` is an ancestor of `descendant`

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

nodeMaxHeight Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`root`: a `Node`
-> m Word32	Returns: the maximum height of the tree beneath `root`

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

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

nChildren

nodeNChildren Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`
-> m Word32	Returns: the number of children of `node`

Gets the number of children of a Node.

nNodes

nodeNNodes Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`root`: a `Node`
-> [TraverseFlags]	`flags`: which types of children are to be counted, one of `TraverseFlagsAll`, `TraverseFlagsLeaves` and `TraverseFlagsNonLeaves`
-> m Word32	Returns: the number of nodes in the tree

Gets the number of nodes in a tree.

reverseChildren

nodeReverseChildren Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: a `Node`.
-> m ()

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

unlink

nodeUnlink Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Node	`node`: the `Node` to unlink, which becomes the root of a new tree
-> m ()

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

Properties

children

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

clearNodeChildren :: MonadIO m => Node -> m () Source #

Set the value of the “children” field to Nothing. When overloading is enabled, this is equivalent to

clear #children

getNodeChildren :: MonadIO m => Node -> m (Maybe Node) Source #

Get the value of the “children” field. When overloading is enabled, this is equivalent to

get node #children

setNodeChildren :: MonadIO m => Node -> Ptr Node -> m () Source #

Set the value of the “children” field. When overloading is enabled, this is equivalent to

set node [ #children := value ]

data

contains the actual data of the node.

clearNodeData :: MonadIO m => Node -> m () Source #

Set the value of the “data” field to Nothing. When overloading is enabled, this is equivalent to

clear #data

getNodeData :: MonadIO m => Node -> m (Ptr ()) Source #

Get the value of the “data” field. When overloading is enabled, this is equivalent to

get node #data

setNodeData :: MonadIO m => Node -> Ptr () -> m () Source #

Set the value of the “data” field. When overloading is enabled, this is equivalent to

set node [ #data := value ]

parent

points to the parent of the Node, or is Nothing if the Node is the root of the tree.

clearNodeParent :: MonadIO m => Node -> m () Source #

Set the value of the “parent” field to Nothing. When overloading is enabled, this is equivalent to

clear #parent

getNodeParent :: MonadIO m => Node -> m (Maybe Node) Source #

Get the value of the “parent” field. When overloading is enabled, this is equivalent to

get node #parent

setNodeParent :: MonadIO m => Node -> Ptr Node -> m () Source #

Set the value of the “parent” field. When overloading is enabled, this is equivalent to

set node [ #parent := value ]