Struct gtk4::SingleSelection

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

SingleSelection is a SelectionModel that allows selecting a single item.

Note that the selection is persistent – if the selected item is removed and re-added in the same signal::gio::ListModel::items-changed emission, it stays selected. In particular, this means that changing the sort order of an underlying sort model will preserve the selection.

Implements

glib::ObjectExt, gio::prelude::ListModelExt, SelectionModelExt

Implementations

impl SingleSelection

pub fn new(model: Option<&impl IsA<ListModel>>) -> SingleSelection

Creates a new selection to handle @model.

model

the GListModel to manage

Returns

a new SingleSelection

pub fn builder() -> SingleSelectionBuilder

Creates a new builder-pattern struct instance to construct SingleSelection objects.

This method returns an instance of SingleSelectionBuilder which can be used to create SingleSelection objects.

pub fn is_autoselect(&self) -> bool

Checks if autoselect has been enabled or disabled via gtk_single_selection_set_autoselect().

Returns

true if autoselect is enabled

pub fn can_unselect(&self) -> bool

If true, gtk_selection_model_unselect_item() is supported and allows unselecting the selected item.

Returns

true to support unselecting

pub fn model(&self) -> Option<ListModel>

Gets the model that @self is wrapping.

Returns

The model being wrapped

pub fn selected(&self) -> u32

Gets the position of the selected item.

If no item is selected, GTK_INVALID_LIST_POSITION is returned.

Returns

The position of the selected item

pub fn selected_item(&self) -> Option<Object>

Gets the selected item.

If no item is selected, None is returned.

Returns

The selected item

pub fn set_autoselect(&self, autoselect: bool)

Enables or disables autoselect.

If @autoselect is true, @self will enforce that an item is always selected. It will select a new item when the currently selected item is deleted and it will disallow unselecting the current item.

autoselect

true to always select an item

pub fn set_can_unselect(&self, can_unselect: bool)

If true, unselecting the current item via gtk_selection_model_unselect_item() is supported.

Note that setting property::SingleSelection::autoselect will cause unselecting to not work, so it practically makes no sense to set both at the same time the same time.

can_unselect

true to allow unselecting

pub fn set_model(&self, model: Option<&impl IsA<ListModel>>)

Sets the model that @self should wrap.

If @model is None, @self will be empty.

model

A GListModel to wrap

pub fn set_selected(&self, position: u32)

Selects the item at the given position.

If the list does not have an item at @position or GTK_INVALID_LIST_POSITION is given, the behavior depends on the value of the property::SingleSelection::autoselect property: If it is set, no change will occur and the old item will stay selected. If it is unset, the selection will be unset and no item will be selected.

position

the item to select or GTK_INVALID_LIST_POSITION

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

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

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

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

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

Trait Implementations

impl Clone for SingleSelection

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 SingleSelection

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

Formats the value using the given formatter.

impl Default for SingleSelection

fn default() -> Self

Returns the “default value” for a type.

impl Display for SingleSelection

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

Formats the value using the given formatter.

impl Hash for SingleSelection

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 SingleSelection

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 SingleSelection

type Parent = Object

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

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 SingleSelection

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 SingleSelection

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SingleSelection

impl IsA<ListModel> for SingleSelection

impl IsA<SelectionModel> for SingleSelection