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

Constructors

TreeIter (ManagedPtr TreeIter)

Instances

BoxedObject TreeIter

Methods

boxedType :: TreeIter -> IO GType

(~) AttrOpTag tag AttrSet => Constructible TreeIter tag

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

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

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

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

userData

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

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

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

userData2

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

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

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

userData3

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

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

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