| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.Node
Description
The Node struct represents one node in a n-ary tree.
Synopsis
- newtype Node = Node (ManagedPtr Node)
- newZeroNode :: MonadIO m => m Node
- type family ResolveNodeMethod (t :: Symbol) o where ...
- data NodeChildIndexMethodInfo
- nodeChildIndex :: (HasCallStack, MonadIO m) => Node -> Ptr () -> m Int32
- data NodeChildPositionMethodInfo
- nodeChildPosition :: (HasCallStack, MonadIO m) => Node -> Node -> m Int32
- data NodeChildrenForeachMethodInfo
- nodeChildrenForeach :: (HasCallStack, MonadIO m) => Node -> [TraverseFlags] -> NodeForeachFunc -> m ()
- data NodeDepthMethodInfo
- nodeDepth :: (HasCallStack, MonadIO m) => Node -> m Word32
- data NodeDestroyMethodInfo
- nodeDestroy :: (HasCallStack, MonadIO m) => Node -> m ()
- data NodeIsAncestorMethodInfo
- nodeIsAncestor :: (HasCallStack, MonadIO m) => Node -> Node -> m Bool
- data NodeMaxHeightMethodInfo
- nodeMaxHeight :: (HasCallStack, MonadIO m) => Node -> m Word32
- data NodeNChildrenMethodInfo
- nodeNChildren :: (HasCallStack, MonadIO m) => Node -> m Word32
- data NodeNNodesMethodInfo
- nodeNNodes :: (HasCallStack, MonadIO m) => Node -> [TraverseFlags] -> m Word32
- nodePopAllocator :: (HasCallStack, MonadIO m) => m ()
- nodePushAllocator :: (HasCallStack, MonadIO m) => Allocator -> m ()
- data NodeReverseChildrenMethodInfo
- nodeReverseChildren :: (HasCallStack, MonadIO m) => Node -> m ()
- data NodeTraverseMethodInfo
- nodeTraverse :: (HasCallStack, MonadIO m) => Node -> TraverseType -> [TraverseFlags] -> Int32 -> NodeTraverseFunc -> m ()
- data NodeUnlinkMethodInfo
- nodeUnlink :: (HasCallStack, MonadIO m) => Node -> m ()
- clearNodeChildren :: MonadIO m => Node -> m ()
- getNodeChildren :: MonadIO m => Node -> m (Maybe Node)
- node_children :: AttrLabelProxy "children"
- setNodeChildren :: MonadIO m => Node -> Ptr Node -> m ()
- clearNodeData :: MonadIO m => Node -> m ()
- getNodeData :: MonadIO m => Node -> m (Ptr ())
- node_data :: AttrLabelProxy "data"
- setNodeData :: MonadIO m => Node -> Ptr () -> m ()
- clearNodeNext :: MonadIO m => Node -> m ()
- getNodeNext :: MonadIO m => Node -> m (Maybe Node)
- node_next :: AttrLabelProxy "next"
- setNodeNext :: MonadIO m => Node -> Ptr Node -> m ()
- clearNodeParent :: MonadIO m => Node -> m ()
- getNodeParent :: MonadIO m => Node -> m (Maybe Node)
- node_parent :: AttrLabelProxy "parent"
- setNodeParent :: MonadIO m => Node -> Ptr Node -> m ()
- clearNodePrev :: MonadIO m => Node -> m ()
- getNodePrev :: MonadIO m => Node -> m (Maybe Node)
- node_prev :: AttrLabelProxy "prev"
- setNodePrev :: MonadIO m => Node -> Ptr Node -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Node (ManagedPtr Node) |
Instances
Methods
Click to display all available methods, including inherited ones
Methods
childIndex, childPosition, childrenForeach, depth, destroy, isAncestor, maxHeight, nChildren, nNodes, reverseChildren, traverse, unlink.
Getters
None.
Setters
None.
type family ResolveNodeMethod (t :: Symbol) o where ... Source #
Equations
| ResolveNodeMethod "childIndex" o = NodeChildIndexMethodInfo | |
| ResolveNodeMethod "childPosition" o = NodeChildPositionMethodInfo | |
| ResolveNodeMethod "childrenForeach" o = NodeChildrenForeachMethodInfo | |
| ResolveNodeMethod "depth" o = NodeDepthMethodInfo | |
| ResolveNodeMethod "destroy" o = NodeDestroyMethodInfo | |
| ResolveNodeMethod "isAncestor" o = NodeIsAncestorMethodInfo | |
| ResolveNodeMethod "maxHeight" o = NodeMaxHeightMethodInfo | |
| ResolveNodeMethod "nChildren" o = NodeNChildrenMethodInfo | |
| ResolveNodeMethod "nNodes" o = NodeNNodesMethodInfo | |
| ResolveNodeMethod "reverseChildren" o = NodeReverseChildrenMethodInfo | |
| ResolveNodeMethod "traverse" o = NodeTraverseMethodInfo | |
| ResolveNodeMethod "unlink" o = NodeUnlinkMethodInfo | |
| ResolveNodeMethod l o = MethodResolutionFailed l o :: Type |
childIndex
data NodeChildIndexMethodInfo Source #
Instances
| (signature ~ (Ptr () -> m Int32), MonadIO m) => OverloadedMethod NodeChildIndexMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeChildIndexMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> Ptr () |
|
| -> m Int32 | Returns: the index of the child of |
Gets the position of the first child of a Node
which contains the given data.
childPosition
data NodeChildPositionMethodInfo Source #
Instances
| (signature ~ (Node -> m Int32), MonadIO m) => OverloadedMethod NodeChildPositionMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeChildPositionMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> Node |
|
| -> m Int32 | Returns: the position of |
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.
childrenForeach
data NodeChildrenForeachMethodInfo Source #
Instances
| (signature ~ ([TraverseFlags] -> NodeForeachFunc -> m ()), MonadIO m) => OverloadedMethod NodeChildrenForeachMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeChildrenForeachMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> [TraverseFlags] |
|
| -> NodeForeachFunc |
|
| -> m () |
Calls a function for each of the children of a Node. Note that it
doesn't descend beneath the child nodes. func must not do anything
that would modify the structure of the tree.
depth
data NodeDepthMethodInfo Source #
Instances
| (signature ~ m Word32, MonadIO m) => OverloadedMethod NodeDepthMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeDepthMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
destroy
data NodeDestroyMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod NodeDestroyMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeDestroyMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> m () |
Removes root and its children from the tree, freeing any memory
allocated.
isAncestor
data NodeIsAncestorMethodInfo Source #
Instances
| (signature ~ (Node -> m Bool), MonadIO m) => OverloadedMethod NodeIsAncestorMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeIsAncestorMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> Node |
|
| -> m Bool | Returns: |
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
data NodeMaxHeightMethodInfo Source #
Instances
| (signature ~ m Word32, MonadIO m) => OverloadedMethod NodeMaxHeightMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeMaxHeightMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> m Word32 | Returns: the maximum height of the tree beneath |
nChildren
data NodeNChildrenMethodInfo Source #
Instances
| (signature ~ m Word32, MonadIO m) => OverloadedMethod NodeNChildrenMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeNChildrenMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> m Word32 | Returns: the number of children of |
Gets the number of children of a Node.
nNodes
data NodeNNodesMethodInfo Source #
Instances
| (signature ~ ([TraverseFlags] -> m Word32), MonadIO m) => OverloadedMethod NodeNNodesMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeNNodesMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> [TraverseFlags] |
|
| -> m Word32 | Returns: the number of nodes in the tree |
Gets the number of nodes in a tree.
popAllocator
nodePopAllocator :: (HasCallStack, MonadIO m) => m () Source #
Deprecated: (Since version 2.10)
No description available in the introspection data.
pushAllocator
nodePushAllocator :: (HasCallStack, MonadIO m) => Allocator -> m () Source #
Deprecated: (Since version 2.10)
No description available in the introspection data.
reverseChildren
data NodeReverseChildrenMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod NodeReverseChildrenMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeReverseChildrenMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> m () |
Reverses the order of the children of a Node.
(It doesn't change the order of the grandchildren.)
traverse
data NodeTraverseMethodInfo Source #
Instances
| (signature ~ (TraverseType -> [TraverseFlags] -> Int32 -> NodeTraverseFunc -> m ()), MonadIO m) => OverloadedMethod NodeTraverseMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeTraverseMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> TraverseType |
|
| -> [TraverseFlags] |
|
| -> Int32 |
|
| -> NodeTraverseFunc |
|
| -> m () |
unlink
data NodeUnlinkMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod NodeUnlinkMethodInfo Node signature Source # | |
Defined in GI.GLib.Structs.Node Methods overloadedMethod :: Node -> signature # | |
| OverloadedMethodInfo NodeUnlinkMethodInfo Node Source # | |
Defined in GI.GLib.Structs.Node Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Node |
|
| -> 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
node_children :: AttrLabelProxy "children" Source #
setNodeChildren :: MonadIO m => Node -> Ptr Node -> m () Source #
Set the value of the “children” field.
When overloading is enabled, this is equivalent to
setnode [ #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
node_data :: AttrLabelProxy "data" Source #
setNodeData :: MonadIO m => Node -> Ptr () -> m () Source #
Set the value of the “data” field.
When overloading is enabled, this is equivalent to
setnode [ #data:=value ]
next
points to the node's next sibling (a sibling is another
Node with the same parent).
clearNodeNext :: MonadIO m => Node -> m () Source #
Set the value of the “next” field to Nothing.
When overloading is enabled, this is equivalent to
clear #next
getNodeNext :: MonadIO m => Node -> m (Maybe Node) Source #
Get the value of the “next” field.
When overloading is enabled, this is equivalent to
get node #next
node_next :: AttrLabelProxy "next" Source #
setNodeNext :: MonadIO m => Node -> Ptr Node -> m () Source #
Set the value of the “next” field.
When overloading is enabled, this is equivalent to
setnode [ #next:=value ]
parent
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
node_parent :: AttrLabelProxy "parent" Source #
setNodeParent :: MonadIO m => Node -> Ptr Node -> m () Source #
Set the value of the “parent” field.
When overloading is enabled, this is equivalent to
setnode [ #parent:=value ]
prev
points to the node's previous sibling.
clearNodePrev :: MonadIO m => Node -> m () Source #
Set the value of the “prev” field to Nothing.
When overloading is enabled, this is equivalent to
clear #prev
getNodePrev :: MonadIO m => Node -> m (Maybe Node) Source #
Get the value of the “prev” field.
When overloading is enabled, this is equivalent to
get node #prev
node_prev :: AttrLabelProxy "prev" Source #
setNodePrev :: MonadIO m => Node -> Ptr Node -> m () Source #
Set the value of the “prev” field.
When overloading is enabled, this is equivalent to
setnode [ #prev:=value ]