Struct kas_widgets::ComboBox

pub struct ComboBox<A, V: Clone + Debug + Eq + 'static> { /* private fields */ }

A pop-up multiple choice menu

Messages

A combobox presents a menu with a fixed set of choices when clicked. Each choice has an associated value of type V.

If no selection handler exists, then the choice’s message is emitted when selected. If a handler is specified via Self::with or Self::with_msg then this message is passed to the handler and not emitted.

Implementations

impl<A, V: Clone + Debug + Eq + 'static> ComboBox<A, V>

pub fn new<T, I>( iter: I, state_fn: impl Fn(&ConfigCx<'_>, &A) -> V + 'static ) -> Self

where T: Into<AccessString>, I: IntoIterator<Item = (T, V)>,

Construct a combobox

Constructs a combobox with labels derived from an iterator over string types. For example:

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Select { A, B, C }

let combobox = ComboBox::new(
    [("A", Select::A), ("B", Select::B), ("C", Select::C)],
    |_, selection| *selection,
);

The closure state_fn selects the active entry from input data.

pub fn new_vec( entries: Vec<MenuEntry<V>>, state_fn: impl Fn(&ConfigCx<'_>, &A) -> V + 'static ) -> Self

Construct a combobox with the given menu entries

A combobox presents a menu with a fixed set of choices when clicked.

The closure state_fn selects the active entry from input data.

pub fn with_msg<M: Debug + 'static>(self, f: impl Fn(V) -> M + 'static) -> Self

Send the message generated by f on selection

pub fn with<F>(self, f: F) -> ComboBox<A, V>

where F: Fn(&mut EventCx<'_>, V) + 'static,

Call the handler f on selection

On selection of a new choice the closure f is called with the choice’s message.

pub fn new_msg<T, I, M>( iter: I, state_fn: impl Fn(&ConfigCx<'_>, &A) -> V + 'static, msg_fn: impl Fn(V) -> M + 'static ) -> Self

where T: Into<AccessString>, I: IntoIterator<Item = (T, V)>, M: Debug + 'static,

Construct a combobox which sends a message on selection

See Self::new and Self::with_msg for documentation.

impl<A, V: Clone + Debug + Eq + 'static> ComboBox<A, V>

pub fn active(&self) -> usize

Get the index of the active choice

This index is normally less than the number of choices (self.len()), but may not be if set programmatically or there are no choices.

pub fn with_active(self, index: usize) -> Self

Set the active choice (inline style)

pub fn set_active(&mut self, index: usize) -> Action

Set the active choice

pub fn len(&self) -> usize

Get the number of entries

pub fn is_empty(&self) -> bool

True if the box contains no entries

pub fn clear(&mut self)

Remove all choices

pub fn push<T: Into<AccessString>>( &mut self, cx: &mut ConfigCx<'_>, label: T, msg: V ) -> usize

Add a choice to the combobox, in last position

Returns the index of the new choice

pub fn pop(&mut self, cx: &mut EventState) -> Option<()>

Pops the last choice from the combobox

pub fn insert<T: Into<AccessString>>( &mut self, cx: &mut ConfigCx<'_>, index: usize, label: T, msg: V )

Add a choice at position index

Panics if index > len.

pub fn remove(&mut self, cx: &mut EventState, index: usize)

Removes the choice at position index

Panics if index is out of bounds.

pub fn replace<T: Into<AccessString>>( &mut self, cx: &mut ConfigCx<'_>, index: usize, label: T, msg: V )

Replace the choice at index

Panics if index is out of bounds.

Trait Implementations

impl<A, V: Clone + Debug + Eq + 'static> AutoLayout for ComboBox<A, V>

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, V: Clone + Debug + Eq + 'static> Events for ComboBox<A, V>

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

Update self using input data

fn handle_event(&mut self, cx: &mut EventCx<'_>, _: &A, event: Event) -> IsUsed

Handle an Event

fn handle_messages(&mut self, cx: &mut EventCx<'_>, _: &Self::Data)

Handler for messages from children/descendants

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

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

Mouse focus handler

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

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_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

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

Handler for scrolling

impl<A, V: Clone + Debug + Eq + 'static> Layout for ComboBox<A, V>

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

Navigation in spatial order

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 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, V: Clone + Debug + Eq + 'static> Widget for ComboBox<A, V>

type Data = A

Input data type

fn as_node<'a>(&'a mut self, data: &'a Self::Data) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &Self::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

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