Struct gtk4::TreeSelection

source ·

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

👎Deprecated: Since 4.10

Expand description

Use SelectionModel instead 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).

Properties

`mode`

Selection mode. See gtk_tree_selection_set_mode() for more information on this property.

Readable | Writeable

Signals

`changed`

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.

Struct gtk4::TreeSelection

Implementations§

impl TreeSelection

pub fn count_selected_rows(&self) -> i32

pub fn mode(&self) -> SelectionMode

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

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

pub fn tree_view(&self) -> TreeView

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

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

pub fn select_all(&self)

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

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

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

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

pub fn set_mode(&self, type_: SelectionMode)

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

pub fn unselect_all(&self)

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

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

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

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

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

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

impl Debug for TreeSelection

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

impl Display for TreeSelection

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

impl HasParamSpec for TreeSelection

type ParamSpec = ParamSpecObject

type SetValue = TreeSelection

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, TreeSelection>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TreeSelection

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

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

impl Ord for TreeSelection

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

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

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

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

impl ParentClassIs for TreeSelection

type Parent = Object

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

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

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

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

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

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

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

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

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

impl StaticType for TreeSelection

fn static_type() -> Type

impl Eq for TreeSelection

Auto Trait Implementations§

impl RefUnwindSafe for TreeSelection

impl !Send for TreeSelection

impl !Sync for TreeSelection

impl Unpin for TreeSelection

impl UnwindSafe for TreeSelection

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Cast for Twhere T: ObjectType,

fn upcast<T>(self) -> Twhere T: ObjectType, Self: IsA<T>,

fn upcast_ref<T>(&self) -> &Twhere T: ObjectType, Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self>where T: ObjectType, Self: MayDowncastTo<T>,

fn downcast_ref<T>(&self) -> Option<&T>where T: ObjectType, Self: MayDowncastTo<T>,

fn dynamic_cast<T>(self) -> Result<T, Self>where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T>where T: ObjectType,