Struct gtk4::TreeSelection

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

The selection object for GtkTreeView

The TreeSelection object is a helper object to manage the selection for a TreeView widget. The TreeSelection object is automatically created when a new TreeView widget is created, and cannot exist independently of this widget. The primary reason the TreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the TreeView widget instead of a separate function.

The TreeSelection object is gotten from a TreeView by calling gtk_tree_view_get_selection(). It can be manipulated to check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely view side. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row on the model that is not currently displayed by the view without expanding its parents first.

One of the important things to remember when monitoring the selection of a view is that the TreeSelection::changed signal is mostly a hint. That is, it may only emit one signal when a range of rows is selected. Additionally, it may on occasion emit a TreeSelection::changed signal when nothing has happened (mostly as a result of programmers calling select_row on an already selected row).

Implements

glib::ObjectExt

Implementations

impl TreeSelection

pub fn count_selected_rows(&self) -> i32

Returns the number of rows that have been selected in @tree.

Returns

The number of rows selected.

pub fn mode(&self) -> SelectionMode

Gets the selection mode for @self. See gtk_tree_selection_set_mode().

Returns

the current selection mode

pub fn selected(&self) -> Option<(TreeModel, TreeIter)>

Sets @iter to the currently selected node if @self is set to SelectionMode::Single or SelectionMode::Browse. @iter may be NULL if you just want to test if @self has any selected nodes. @model is filled with the current model as a convenience. This function will not work if you use @self is SelectionMode::Multiple.

Returns

TRUE, if there is a selected node.

model

A pointer to set to the TreeModel

iter

The TreeIter

pub fn selected_rows(&self) -> (Vec<TreePath>, TreeModel)

Creates a list of path of all selected rows. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of TreeRowReferences. To do this, you can use gtk_tree_row_reference_new().

To free the return value, use:

⚠️ The following code is in C ⚠️

g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);

Returns

A GList containing a TreePath for each selected row.

model

A pointer to set to the TreeModel

pub fn tree_view(&self) -> TreeView

Returns the tree view associated with @self.

Returns

A TreeView

pub fn iter_is_selected(&self, iter: &TreeIter) -> bool

Returns true if the row at @iter is currently selected.

iter

A valid TreeIter

Returns

true, if @iter is selected

pub fn path_is_selected(&self, path: &TreePath) -> bool

Returns true if the row pointed to by @path is currently selected. If @path does not point to a valid location, false is returned

path

A TreePath to check selection on.

Returns

true if @path is selected.

pub fn select_all(&self)

Selects all the nodes. @self must be set to SelectionMode::Multiple mode.

pub fn select_iter(&self, iter: &TreeIter)

Selects the specified iterator.

iter

The TreeIter to be selected.

pub fn select_path(&self, path: &TreePath)

Select the row at @path.

path

The TreePath to be selected.

pub fn select_range(&self, start_path: &TreePath, end_path: &TreePath)

Selects a range of nodes, determined by @start_path and @end_path inclusive. @self must be set to SelectionMode::Multiple mode.

start_path

The initial node of the range.

end_path

The final node of the range.

pub fn selected_foreach<P: FnMut(&TreeModel, &TreePath, &TreeIter)>( &self, func: P )

Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, gtk_tree_selection_get_selected_rows() might be more useful.

func

The function to call for each selected node.

pub fn set_mode(&self, type_: SelectionMode)

Sets the selection mode of the @self. If the previous type was SelectionMode::Multiple, then the anchor is kept selected, if it was previously selected.

type_

The selection mode

pub fn set_select_function<P: Fn(&TreeSelection, &TreeModel, &TreePath, bool) -> bool + 'static>( &self, func: P )

Sets the selection function.

If set, this function is called before any node is selected or unselected, giving some control over which nodes are selected. The select function should return true if the state of the node may be toggled, and false if the state of the node should be left unchanged.

func

The selection function. May be None

pub fn unselect_all(&self)

Unselects all the nodes.

pub fn unselect_iter(&self, iter: &TreeIter)

Unselects the specified iterator.

iter

The TreeIter to be unselected.

pub fn unselect_path(&self, path: &TreePath)

Unselects the row at @path.

path

The TreePath to be unselected.

pub fn unselect_range(&self, start_path: &TreePath, end_path: &TreePath)

Unselects a range of nodes, determined by @start_path and @end_path inclusive.

start_path

The initial node of the range.

end_path

The initial node of the range.

pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted whenever the selection has (possibly) changed. Please note that this signal is mostly a hint. It may only be emitted once when a range of rows are selected, and it may occasionally be emitted when nothing has happened.

pub fn connect_mode_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl TreeSelection

pub fn unset_select_function(&self)

Trait Implementations

impl Clone for TreeSelection

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 TreeSelection

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

Formats the value using the given formatter.

impl Display for TreeSelection

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

Formats the value using the given formatter.

impl Hash for TreeSelection

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

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 TreeSelection

fn cmp(&self, other: &Self) -> 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 ParentClassIs for TreeSelection

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for TreeSelection

fn eq(&self, other: &OT) -> 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<OT: ObjectType> PartialOrd<OT> for TreeSelection

fn partial_cmp(&self, other: &OT) -> 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 TreeSelection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeSelection