Gtk.TreeRowReference¶

Fields¶

None

Methods¶

class	`deleted` (proxy, path)
class	`inserted` (proxy, path)
class	`new` (model, path)
class	`new_proxy` (proxy, model, path)
	`copy` ()
	`free` ()
	`get_model` ()
	`get_path` ()
	`valid` ()

Details¶

class Gtk.TreeRowReference¶

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

Deprecated since version 4.10: Use [iface`Gio`.ListModel] instead

classmethod deleted(proxy, path)[source]¶

Parameters:

proxy (GObject.Object) – a GObject
path (Gtk.TreePath) – the path position that was deleted

Lets a set of row reference created by Gtk.TreeRowReference.new_proxy() know that the model emitted the ::row-deleted signal.

Deprecated since version 4.10.

classmethod inserted(proxy, path)[source]¶

Parameters:

proxy (GObject.Object) – a GObject
path (Gtk.TreePath) – the row position that was inserted

Lets a set of row reference created by Gtk.TreeRowReference.new_proxy() know that the model emitted the ::row-inserted signal.

Deprecated since version 4.10.

classmethod new(model, path)[source]¶

Parameters:

model (Gtk.TreeModel) – a GtkTreeModel
path (Gtk.TreePath) – a valid GtkTreePath to monitor

Returns:

a newly allocated GtkTreeRowReference

Return type:

Gtk.TreeRowReference or None

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 None is returned.

Deprecated since version 4.10.

classmethod new_proxy(proxy, model, path)[source]¶

Parameters:

proxy (GObject.Object) – a proxy GObject
model (Gtk.TreeModel) – a GtkTreeModel
path (Gtk.TreePath) – a valid GtkTreePath to monitor

Returns:

a newly allocated GtkTreeRowReference

Return type:

Gtk.TreeRowReference or None

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 None is returned. However, unlike references created with Gtk.TreeRowReference.new(), it does not listen to the model for changes. The creator of the row reference must do this explicitly using Gtk.TreeRowReference.inserted(), Gtk.TreeRowReference.deleted(), 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 GtkTreeView 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.

Deprecated since version 4.10.

copy()[source]¶

Returns:: a copy of self
Return type:: Gtk.TreeRowReference

Copies a GtkTreeRowReference.

Deprecated since version 4.10.

free()[source]¶: Free’s self. self may be None

Deprecated since version 4.10.

get_model()[source]¶

Returns:: the model
Return type:: Gtk.TreeModel

Returns the model that the row reference is monitoring.

Deprecated since version 4.10.

get_path()[source]¶

Returns:: a current path
Return type:: Gtk.TreePath or None

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

Deprecated since version 4.10.

valid()[source]¶

Returns:: True if self points to a valid path
Return type:: bool

Returns True if the self is non-None and refers to a current valid path.

Deprecated since version 4.10.