Struct kas::view::filter::FilterBoxList

pub struct FilterBoxList<A, F, W, G = KeystrokeGuard>
where
    A: ListData + 'static,
    F: Filter<<A as SharedData>::Item, Value = String>,
    W: Widget<Data = UnsafeFilteredList<A>>,
    G: EditGuard<Data = ()>,
{ /* private fields */ }

Available on crate feature view only.

An EditBox above a FilterList

This is essentially just two widgets with “glue” to handle a SetFilter message from the EditBox.

Implementations

impl<A, F, W, G> FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

pub fn new(list: W, filter: F, guard: G) -> FilterBoxList<A, F, W, G>

Construct

Parameters list and filter are passed to FilterList::new.

Parameter guard may be KeystrokeGuard, AflGuard or a custom implementation.

Methods from Deref<Target = FilterList<A, F, W>>

pub fn set_filter( &mut self, cx: &mut ConfigCx<'_>, data: &A, filter: <F as FilterValue>::Value )

Set filter value

Trait Implementations

impl<A, F, W, G> AutoLayout for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<Id>

Translate a coordinate to an Id

fn draw(&mut self, draw: DrawCx<'_>)

Draw a widget and its children

impl<A, F, W, G> Deref for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

type Target = FilterList<A, F, W>

The resulting type after dereferencing.

fn deref(&self) -> &<FilterBoxList<A, F, W, G> as Deref>::Target

Dereferences the value.

impl<A, F, W, G> DerefMut for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

fn deref_mut(&mut self) -> &mut <FilterBoxList<A, F, W, G> as Deref>::Target

Mutably dereferences the value.

impl<A, F, W, G> Events for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &A)

Handler for messages from children/descendants

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<FilterBoxList<A, F, W, G> as Widget>::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &<FilterBoxList<A, F, W, G> as Widget>::Data, _: Event ) -> IsUsed

Handle an Event

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, state: bool) -> IsUsed

Mouse focus handler

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll )

Handler for scrolling

impl<A, F, W, G> Layout for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn Layout>

Access a child as a dyn Layout

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn find_id(&mut self, coord: Coord) -> Option<Id>

Translate a coordinate to an Id

fn draw(&mut self, draw: DrawCx<'_>)

Draw a widget and its children

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self) -> Offset

Get translation of children relative to this widget

impl<A, F, W, G> Scrollable for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>> + Scrollable, G: EditGuard<Data = ()>,

fn scroll_axes(&self, size: Size) -> (bool, bool)

Given size size, returns whether (horiz, vert) scrolling is required

fn max_scroll_offset(&self) -> Offset

Get the maximum scroll offset

fn scroll_offset(&self) -> Offset

Get the current scroll offset

fn set_scroll_offset(&mut self, cx: &mut EventCx<'_>, offset: Offset) -> Offset

Set the scroll offset

impl<A, F, W, G> Widget for FilterBoxList<A, F, W, G>

where A: ListData + 'static, F: Filter<<A as SharedData>::Item, Value = String>, W: Widget<Data = UnsafeFilteredList<A>>, G: EditGuard<Data = ()>,

type Data = A

Input data type

fn as_node<'a>( &'a mut self, data: &'a <FilterBoxList<A, F, W, G> as Widget>::Data ) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &<FilterBoxList<A, F, W, G> as Widget>::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

Call closure on child with given index, if index < self.num_children().