Struct gtk4::StringFilter

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

StringFilter determines whether to include items by comparing strings to a fixed search term.

The strings are obtained from the items by evaluating a Expression set with set_expression(), and they are compared against a search term set with set_search().

StringFilter has several different modes of comparison - it can match the whole string, just a prefix, or any substring. Use set_match_mode() choose a mode.

It is also possible to make case-insensitive comparisons, with set_ignore_case().

Implements

FilterExt, glib::ObjectExt

Implementations

impl StringFilter

pub fn new(expression: Option<impl AsRef<Expression>>) -> StringFilter

Creates a new string filter.

You will want to set up the filter by providing a string to search for and by providing a property to look up on the item.

expression

The expression to evaluate

Returns

a new StringFilter

pub fn builder() -> StringFilterBuilder

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

This method returns an instance of StringFilterBuilder which can be used to create StringFilter objects.

pub fn expression(&self) -> Option<Expression>

Gets the expression that the string filter uses to obtain strings from items.

Returns

a Expression

pub fn ignores_case(&self) -> bool

Returns whether the filter ignores case differences.

Returns

true if the filter ignores case

pub fn match_mode(&self) -> StringFilterMatchMode

Returns the match mode that the filter is using.

Returns

the match mode of the filter

pub fn search(&self) -> Option<GString>

Gets the search term.

Returns

The search term

pub fn set_expression(&self, expression: Option<impl AsRef<Expression>>)

Sets the expression that the string filter uses to obtain strings from items.

The expression must have a value type of G_TYPE_STRING.

expression

a Expression

pub fn set_ignore_case(&self, ignore_case: bool)

Sets whether the filter ignores case differences.

ignore_case

true to ignore case

pub fn set_match_mode(&self, mode: StringFilterMatchMode)

Sets the match mode for the filter.

mode

the new match mode

pub fn set_search(&self, search: Option<&str>)

Sets the string to search for.

search

The string to search for or None to clear the search

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

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

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

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

Trait Implementations

impl Clone for StringFilter

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 StringFilter

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

Formats the value using the given formatter.

impl Default for StringFilter

fn default() -> Self

Returns the “default value” for a type.

impl Display for StringFilter

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

Formats the value using the given formatter.

impl Hash for StringFilter

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 StringFilter

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 StringFilter

type Parent = Filter

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

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 StringFilter

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 StringFilter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StringFilter

impl IsA<Filter> for StringFilter