GI.Gtk.Structs.TreeRowReference

A GtkTreeRowReference tracks model changes so that it always refers to the same row (a TreePath refers to a position, not a fixed row). Create a new GtkTreeRowReference with treeRowReferenceNew.

Exported types

newtype TreeRowReference

Memory-managed wrapper type.

Constructors

TreeRowReference (ManagedPtr TreeRowReference)

Instances

Eq TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

Methods

(==) :: TreeRowReference -> TreeRowReference -> Bool

(/=) :: TreeRowReference -> TreeRowReference -> Bool

GBoxed TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

ManagedPtrNewtype TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

Methods

toManagedPtr :: TreeRowReference -> ManagedPtr TreeRowReference

TypedObject TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

Methods

glibType :: IO GType

HasParentTypes TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

IsGValue (Maybe TreeRowReference)

Convert TreeRowReference to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Structs.TreeRowReference

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TreeRowReference -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TreeRowReference)

type ParentTypes TreeRowReference

Defined in GI.Gtk.Structs.TreeRowReference

type ParentTypes TreeRowReference = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

copy, free, valid.

Getters

getModel, getPath.

Setters

None.

copy

treeRowReferenceCopy

Arguments

:: (HasCallStack, MonadIO m)

=> TreeRowReference

reference: a TreeRowReference

-> m TreeRowReference

Returns: a copy of reference

Copies a TreeRowReference.

Since: 2.2

deleted

treeRowReferenceDeleted

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

proxy: a Object

-> TreePath

path: the path position that was deleted

-> m ()

Lets a set of row reference created by treeRowReferenceNewProxy know that the model emitted the rowDeleted signal.

free

treeRowReferenceFree

Arguments

:: (HasCallStack, MonadIO m)

=> TreeRowReference

reference: a TreeRowReference, or Nothing

-> m ()

Free’s reference. reference may be Nothing

getModel

treeRowReferenceGetModel

Arguments

:: (HasCallStack, MonadIO m)

=> TreeRowReference

reference: a TreeRowReference

-> m TreeModel

Returns: the model

Returns the model that the row reference is monitoring.

Since: 2.8

getPath

treeRowReferenceGetPath

Arguments

:: (HasCallStack, MonadIO m)

=> TreeRowReference

reference: a TreeRowReference

-> m (Maybe TreePath)

Returns: a current path, or Nothing

Returns a path that the row reference currently points to, or Nothing if the path pointed to is no longer valid.

inserted

treeRowReferenceInserted

Arguments

:: (HasCallStack, MonadIO m, IsObject a)

=> a

proxy: a Object

-> TreePath

path: the row position that was inserted

-> m ()

Lets a set of row reference created by treeRowReferenceNewProxy know that the model emitted the rowInserted signal.

new

treeRowReferenceNew

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a)

=> a

model: a TreeModel

-> TreePath

path: a valid TreePath-struct to monitor

-> m TreeRowReference

Returns: a newly allocated TreeRowReference, or Nothing

Creates a row reference based on path.

This reference will keep pointing to the node pointed to by path, so long as it exists. Any changes that occur on model are propagated, and the path is updated appropriately. If path isn’t a valid path in model, then Nothing is returned.

newProxy

treeRowReferenceNewProxy

Arguments

:: (HasCallStack, MonadIO m, IsObject a, IsTreeModel b)

=> a

proxy: a proxy Object

-> b

model: a TreeModel

-> TreePath

path: a valid TreePath-struct to monitor

-> m TreeRowReference

Returns: a newly allocated TreeRowReference, or Nothing

You do not need to use this function.

Creates a row reference based on path.

This reference will keep pointing to the node pointed to by path, so long as it exists. If path isn’t a valid path in model, then Nothing is returned. However, unlike references created with treeRowReferenceNew, it does not listen to the model for changes. The creator of the row reference must do this explicitly using treeRowReferenceInserted, treeRowReferenceDeleted, gtk_tree_row_reference_reordered().

These functions must be called exactly once per proxy when the corresponding signal on the model is emitted. This single call updates all row references for that proxy. Since built-in GTK+ objects like TreeView already use this mechanism internally, using them as the proxy object will produce unpredictable results. Further more, passing the same object as model and proxy doesn’t work for reasons of internal implementation.

This type of row reference is primarily meant by structures that need to carefully monitor exactly when a row reference updates itself, and is not generally needed by most applications.

valid

treeRowReferenceValid

Arguments

:: (HasCallStack, MonadIO m)

=> TreeRowReference

reference: a TreeRowReference, or Nothing

-> m Bool

Returns: True if reference points to a valid path

Returns True if the reference is non-Nothing and refers to a current valid path.