Struct 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.

Messages

kas::messages::SetIndex may be used to set the selected entry.

kas::messages::Expand and kas::messages::Collapse may be used to open and close the menu.

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 set_active(&mut self, cx: &mut EventState, index: usize)

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> Events for ComboBox<A, V>

const REDRAW_ON_MOUSE_OVER: bool = true

Does this widget have a different appearance on mouse over?

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 mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

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 rect(&self) -> Rect

Get the widget’s region

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, hints: AlignHints)

Set size and position

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

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

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

fn rect(&self) -> Rect

Get the widget’s region

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, hints: AlignHints)

Set size and position

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

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

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

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

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

Navigation in spatial order

fn probe(&self, _: Coord) -> Id

Probe a coordinate for a widget’s Id

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

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

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

fn id(&self) -> Id

Get the widget’s identifier

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

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

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

fn translation(&self, index: usize) -> Offset

Get translation of child index 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 child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available