Struct FilterBar 

pub struct FilterBar { /* private fields */ }

A row of active conditions, a way to add one, a clear-all, and the count.

Implementations

impl FilterBar

pub fn new(ident: impl Into<Ident>) -> Self

pub fn condition(self, condition: FilterCondition) -> Self

pub fn conditions( self, conditions: impl IntoIterator<Item = FilterCondition>, ) -> Self

pub fn count(self, count: ResultCount) -> Self

The count the host established. The bar never counts anything itself.

pub fn noun(self, noun: impl Into<SharedString>) -> Self

What is being counted, for the sentence beside the number.

pub fn add_control(self, control: impl IntoElement) -> Self

The affordance that offers the fields a filter can be built on, usually a crate::overlay::Popover or a crate::overlay::Menu. It takes the place of the built-in button.

pub fn add_label(self, label: impl Into<SharedString>) -> Self

pub fn clear_label(self, label: impl Into<SharedString>) -> Self

pub fn on_add(self, handler: impl Fn(&mut Window, &mut App) + 'static) -> Self

Reports that the typist asked to add a condition. Ignored when the caller supplied their own affordance with FilterBar::add_control.

pub fn on_remove( self, handler: impl Fn(SharedString, &mut Window, &mut App) + 'static, ) -> Self

Reports the condition the typist took off. The bar removes nothing.

pub fn on_clear(self, handler: impl Fn(&mut Window, &mut App) + 'static) -> Self

Trait Implementations

impl Debug for FilterBar

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

Formats the value using the given formatter.

impl Disableable for FilterBar

fn disabled(self, disabled: bool) -> Self

impl IntoElement for FilterBar

type Element = ViewElement<FilterBar>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for FilterBar

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Sizable for FilterBar

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self