Struct gtk4::TreeRowReference

#[repr(transparent)]
pub struct TreeRowReference { /* private fields */ }

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 gtk_tree_row_reference_new().

Implementations

impl TreeRowReference

pub fn new( model: &impl IsA<TreeModel>, path: &TreePath ) -> Option<TreeRowReference>

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.

model

a TreeModel

path

a valid TreePath to monitor

Returns

a newly allocated TreeRowReference

pub fn new_proxy( proxy: &impl IsA<Object>, model: &impl IsA<TreeModel>, path: &TreePath ) -> Option<TreeRowReference>

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_tree_row_reference_new(), it does not listen to the model for changes. The creator of the row reference must do this explicitly using gtk_tree_row_reference_inserted(), gtk_tree_row_reference_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 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.

proxy

a proxy GObject

model

a TreeModel

path

a valid TreePath to monitor

Returns

a newly allocated TreeRowReference

pub fn model(&self) -> TreeModel

Returns the model that the row reference is monitoring.

Returns

the model

pub fn path(&self) -> Option<TreePath>

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

Returns

a current path

pub fn valid(&self) -> bool

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

Returns

true if @self points to a valid path

pub fn deleted(proxy: &impl IsA<Object>, path: &TreePath)

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

proxy

a GObject

path

the path position that was deleted

pub fn inserted(proxy: &impl IsA<Object>, path: &TreePath)

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

proxy

a GObject

path

the row position that was inserted

impl TreeRowReference

pub fn reordered( &self, proxy: &impl IsA<Object>, path: &TreePath, iter: &TreeIter, new_order: &[i32] )

Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the ::rows-reordered signal.

proxy

a GObject

path

the parent path of the reordered signal

iter

the iter pointing to the parent of the reordered

new_order

the new order of rows

Trait Implementations

impl Clone for TreeRowReference

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TreeRowReference

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for TreeRowReference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TreeRowReference

fn cmp(&self, other: &TreeRowReference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TreeRowReference> for TreeRowReference

fn eq(&self, other: &TreeRowReference) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<TreeRowReference> for TreeRowReference

fn partial_cmp(&self, other: &TreeRowReference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TreeRowReference

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeRowReference

impl StructuralEq for TreeRowReference

impl StructuralPartialEq for TreeRowReference