Struct gtk4::Filter

pub struct Filter { /* private fields */ }

A Filter object describes the filtering to be performed by a FilterListModel.

The model will use the filter to determine if it should include items or not by calling FilterExt::match_() for each item and only keeping the ones that the function returns true for.

Filters may change what items they match through their lifetime. In that case, they will emit the changed signal to notify that previous filter results are no longer valid and that items should be checked again via FilterExt::match_().

GTK provides various pre-made filter implementations for common filtering operations. These filters often include properties that can be linked to various widgets to easily allow searches.

However, in particular for large lists or complex search methods, it is also possible to subclass Filter and provide one’s own filter.

Signals

changed

Emitted whenever the filter changed.

Users of the filter should then check items again via FilterExt::match_().

FilterListModel handles this signal automatically.

Depending on the @change parameter, not all items need to be checked, but only some. Refer to the FilterChange documentation for details.

Implements

FilterExt, [trait@glib::ObjectExt]

Implementations

impl Filter

pub const NONE: Option<&'static Filter> = None

Trait Implementations

impl Clone for Filter

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 Filter

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

Formats the value using the given formatter.

impl HasParamSpec for Filter

type ParamSpec = ParamSpecObject

type SetValue = Filter

Preferred value to be used as setter for the associated ParamSpec.

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Filter

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<T: FilterImpl> IsSubclassable<T> for Filter

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Filter

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Filter

type Parent = Object

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

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 Filter

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 Filter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Filter

impl IsA<Filter> for AnyFilter

impl IsA<Filter> for BoolFilter

impl IsA<Filter> for CustomFilter

impl IsA<Filter> for EveryFilter

impl IsA<Filter> for FileFilter

impl IsA<Filter> for MultiFilter

impl IsA<Filter> for StringFilter