GI.Gtk.Structs.TreeIter

The TreeIter is the primary structure for accessing a TreeModel. Models are expected to put a unique integer in the stamp member, and put model-specific data in the three userData members.

Exported types

newtype TreeIter

Memory-managed wrapper type.

Constructors

TreeIter (ManagedPtr TreeIter)

Instances

BoxedObject TreeIter

Defined in GI.Gtk.Structs.TreeIter

Methods

boxedType :: TreeIter -> IO GType

tag ~ AttrSet => Constructible TreeIter tag

Defined in GI.Gtk.Structs.TreeIter

Methods

new :: MonadIO m => (ManagedPtr TreeIter -> TreeIter) -> [AttrOp TreeIter tag] -> m TreeIter

newZeroTreeIter :: MonadIO m => m TreeIter

Construct a TreeIter struct initialized to zero.

noTreeIter :: Maybe TreeIter

A convenience alias for Nothing :: Maybe TreeIter.

Methods

copy

treeIterCopy

Arguments

:: (HasCallStack, MonadIO m)

=> TreeIter

iter: a TreeIter-struct

-> m TreeIter

Returns: a newly-allocated copy of iter

Creates a dynamically allocated tree iterator as a copy of iter.

This function is not intended for use in applications, because you can just copy the structs by value (GtkTreeIter new_iter = iter;). You must free this iter with treeIterFree.

free

treeIterFree

Arguments

:: (HasCallStack, MonadIO m)

=> TreeIter

iter: a dynamically allocated tree iterator

-> m ()

Frees an iterator that has been allocated by treeIterCopy.

This function is mainly used for language bindings.

Properties

stamp

a unique stamp to catch invalid iterators

getTreeIterStamp :: MonadIO m => TreeIter -> m Int32

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

get treeIter #stamp

setTreeIterStamp :: MonadIO m => TreeIter -> Int32 -> m ()

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

set treeIter [ #stamp := value ]

userData

model-specific data

clearTreeIterUserData :: MonadIO m => TreeIter -> m ()

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

clear #userData

getTreeIterUserData :: MonadIO m => TreeIter -> m (Ptr ())

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

get treeIter #userData

setTreeIterUserData :: MonadIO m => TreeIter -> Ptr () -> m ()

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

set treeIter [ #userData := value ]

userData2

model-specific data

clearTreeIterUserData2 :: MonadIO m => TreeIter -> m ()

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

clear #userData2

getTreeIterUserData2 :: MonadIO m => TreeIter -> m (Ptr ())

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

get treeIter #userData2

setTreeIterUserData2 :: MonadIO m => TreeIter -> Ptr () -> m ()

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

set treeIter [ #userData2 := value ]

userData3

model-specific data

clearTreeIterUserData3 :: MonadIO m => TreeIter -> m ()

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

clear #userData3

getTreeIterUserData3 :: MonadIO m => TreeIter -> m (Ptr ())

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

get treeIter #userData3

setTreeIterUserData3 :: MonadIO m => TreeIter -> Ptr () -> m ()

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

set treeIter [ #userData3 := value ]