gi-gtk-3.0.32: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Structs.TreeIter

Description

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.

Synopsis

Exported types

newtype TreeIter Source #

Memory-managed wrapper type.

Constructors

TreeIter (ManagedPtr TreeIter) 

Instances

Instances details
Eq TreeIter Source # 
Instance details

Defined in GI.Gtk.Structs.TreeIter

IsGValue TreeIter Source #

Convert TreeIter to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Structs.TreeIter

BoxedObject TreeIter Source # 
Instance details

Defined in GI.Gtk.Structs.TreeIter

Methods

boxedType :: TreeIter -> IO GType #

tag ~ 'AttrSet => Constructible TreeIter tag Source # 
Instance details

Defined in GI.Gtk.Structs.TreeIter

Methods

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

newZeroTreeIter :: MonadIO m => m TreeIter Source #

Construct a TreeIter struct initialized to zero.

noTreeIter :: Maybe TreeIter Source #

A convenience alias for Nothing :: Maybe TreeIter.

Methods

Overloaded methods

copy

treeIterCopy Source #

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 Source #

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 Source #

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

get treeIter #stamp

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

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 () Source #

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 ()) Source #

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 () Source #

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 () Source #

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 ()) Source #

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 () Source #

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 () Source #

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 ()) Source #

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 () Source #

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

set treeIter [ #userData3 := value ]