Struct gtk4::FilterListModel

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

FilterListModel is a list model that filters the elements of the underlying model according to a Filter.

It hides some elements from the other model according to criteria given by a Filter.

The model can be set up to do incremental searching, so that filtering long lists doesn’t block the UI. See set_incremental() for details.

Implements

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

Implementations

impl FilterListModel

pub fn new(
    model: Option<&impl IsA<ListModel>>,
    filter: Option<&impl IsA<Filter>>
) -> FilterListModel

Creates a new FilterListModel that will filter @model using the given @filter.

model

the model to sort

filter

filter

Returns

a new FilterListModel

pub fn builder() -> FilterListModelBuilder

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

This method returns an instance of FilterListModelBuilder which can be used to create FilterListModel objects.

pub fn filter(&self) -> Option<Filter>

Gets the Filter currently set on @self.

Returns

The filter currently in use

pub fn is_incremental(&self) -> bool

Returns whether incremental filtering is enabled.

See set_incremental().

Returns

true if incremental filtering is enabled

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

Gets the model currently filtered or None if none.

Returns

The model that gets filtered

pub fn pending(&self) -> u32

Returns the number of items that have not been filtered yet.

You can use this value to check if @self is busy filtering by comparing the return value to 0 or you can compute the percentage of the filter remaining by dividing the return value by the total number of items in the underlying model:

⚠️ The following code is in c ⚠️

pending = gtk_filter_list_model_get_pending (self);
model = gtk_filter_list_model_get_model (self);
percentage = pending / (double) g_list_model_get_n_items (model);

If no filter operation is ongoing - in particular when property::FilterListModel::incremental is false - this function returns 0.

Returns

The number of items not yet filtered

pub fn set_filter(&self, filter: Option<&impl IsA<Filter>>)

Sets the filter used to filter items.

filter

filter to use

pub fn set_incremental(&self, incremental: bool)

Sets the filter model to do an incremental sort.

When incremental filtering is enabled, the FilterListModel will not run filters immediately, but will instead queue an idle handler that incrementally filters the items and adds them to the list. This of course means that items are not instantly added to the list, but only appear incrementally.

When your filter blocks the UI while filtering, you might consider turning this on. Depending on your model and filters, this may become interesting around 10,000 to 100,000 items.

By default, incremental filtering is disabled.

See pending() for progress information about an ongoing incremental filtering operation.

incremental

true to enable incremental filtering

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

Sets the model to be filtered.

Note that GTK makes no effort to ensure that @model conforms to the item type of @self. It assumes that the caller knows what they are doing and have set up an appropriate filter to ensure that item types match.

model

The model to be filtered

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

pub fn connect_incremental_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_pending_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for FilterListModel

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 FilterListModel

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

Formats the value using the given formatter.

impl Default for FilterListModel

fn default() -> Self

Returns the “default value” for a type.

impl Display for FilterListModel

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

Formats the value using the given formatter.

impl Hash for FilterListModel

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 FilterListModel

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 FilterListModel

type Parent = Object

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

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 FilterListModel

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 FilterListModel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FilterListModel

impl IsA<ListModel> for FilterListModel