gi-glib-2.0.27: GLib bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GLib.Structs.TreeNode

Description

An opaque type which identifies a specific node in a Tree.

Since: 2.68

Synopsis

Exported types

newtype TreeNode Source #

Memory-managed wrapper type.

Constructors

TreeNode (ManagedPtr TreeNode) 

Instances

Instances details
Eq TreeNode Source # 
Instance details

Defined in GI.GLib.Structs.TreeNode

BoxedPtr TreeNode Source # 
Instance details

Defined in GI.GLib.Structs.TreeNode

ManagedPtrNewtype TreeNode Source # 
Instance details

Defined in GI.GLib.Structs.TreeNode

Methods

toManagedPtr :: TreeNode -> ManagedPtr TreeNode

Methods

Click to display all available methods, including inherited ones

Expand

Methods

key, next, previous, value.

Getters

None.

Setters

None.

key

treeNodeKey Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TreeNode

node: a Tree node

-> m (Ptr ())

Returns: the key at the node.

Gets the key stored at a particular tree node.

Since: 2.68

next

treeNodeNext Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TreeNode

node: a Tree node

-> m (Maybe TreeNode)

Returns: the next node in the tree

Returns the next in-order node of the tree, or Nothing if the passed node was already the last one.

Since: 2.68

previous

treeNodePrevious Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TreeNode

node: a Tree node

-> m (Maybe TreeNode)

Returns: the previous node in the tree

Returns the previous in-order node of the tree, or Nothing if the passed node was already the first one.

Since: 2.68

value

treeNodeValue Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TreeNode

node: a Tree node

-> m (Ptr ())

Returns: the value at the node.

Gets the value stored at a particular tree node.

Since: 2.68