Struct re_ui::filter_widget::FilterState

pub struct FilterState {
    inner_state: Option<InnerState>,
    request_focus: bool,
}

State and UI for the filter widget.

The filter widget is designed as a toggle between a title widget and the filter text field. Self is responsible for storing the widget state as well as the query text typed by the user. FilterMatcher performs the actual filtering.

Fields

inner_state: Option<InnerState>

The current state of the filter widget.

This is None when the filter is not active.

request_focus: bool

Should the text field be focused?

Set to true upon clicking on the search button.

Implementations

impl FilterState

pub fn activate(&mut self, query: &str)

Activate the filter.

This is the same as clicking the “loupe” icon button.

pub fn is_active(&self) -> bool

Is the filter currently active?

pub fn query(&self) -> Option<&str>

Return the filter if any.

Returns None if the filter is disabled. Returns Some(query) if the filter is enabled (even if the query string is empty, in which case it should match nothing).

pub fn session_id(&self) -> Option<Id>

Return the current session ID of the filter widget, if active.

pub fn filter(&self) -> FilterMatcher

Return a filter matcher for the current query.

pub fn ui( &mut self, ui: &mut Ui, section_title: impl Into<WidgetText>, ) -> Option<Response>

Display the filter widget.

Note: this uses [egui::Ui::available_width] to determine the location of the right-aligned search button, as usual for list_item::ListItem-based widgets.

Trait Implementations

impl Clone for FilterState

fn clone(&self) -> FilterState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterState

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

Formats the value using the given formatter.

impl Default for FilterState

fn default() -> FilterState

Returns the “default value” for a type.