Struct kas_widgets::ComboBox

pub struct ComboBox<M: 'static> { /* fields omitted */ }

A pop-up multiple choice menu

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

Implementations

impl ComboBox<VoidMsg>

pub fn new<T: Into<AccelString>, I: IntoIterator<Item = T>>(
    iter: I,
    active: usize
) -> Self

Construct a combobox

Constructs a combobox with labels derived from an iterator over string types, and the chosen active entry. For example:

let combobox = ComboBox::new(&["zero", "one", "two"], 0);

pub fn new_entries(entries: Vec<MenuEntry<()>>, active: usize) -> Self

Construct a combobox with the given menu entries

A combobox presents a menu with a fixed set of choices when clicked, with the active choice selected (0-based index).

pub fn on_select<M, F>(self, f: F) -> ComboBox<M> where
    F: Fn(&mut Manager<'_>, usize) -> Option<M> + 'static, 

Set the selection handler f

On selection of a new choice the closure f is called with the choice’s index. The result of f is converted to Response::Msg or Response::Update and returned to the parent.

impl<M: 'static> ComboBox<M>

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, index: usize) -> TkAction

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) -> TkAction

Remove all choices

Triggers a reconfigure action.

pub fn push<T: Into<AccelString>>(&mut self, label: T) -> TkAction

Add a choice to the combobox, in last position

Triggers a reconfigure action.

pub fn pop(&mut self) -> (Option<()>, TkAction)

Pops the last choice from the combobox

Triggers a reconfigure action.

pub fn insert<T: Into<AccelString>>(
    &mut self,
    index: usize,
    label: T
) -> TkAction

Add a choice at position index

Panics if index > len.

Triggers a reconfigure action.

pub fn remove(&mut self, index: usize) -> TkAction

Removes the choice at position index

Panics if index is out of bounds.

Triggers a reconfigure action.

pub fn replace<T: Into<AccelString>>(
    &mut self,
    index: usize,
    label: T
) -> TkAction

Replace the choice at index

Panics if index is out of bounds.

Trait Implementations

impl<M: Clone + 'static> Clone for ComboBox<M>

fn clone(&self) -> ComboBox<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: 'static> Debug for ComboBox<M>

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

Formats the value using the given formatter.

impl<M: 'static> Handler for ComboBox<M>

type Msg = M

Type of message returned by this widget

fn handle(&mut self, mgr: &mut Manager<'_>, event: Event) -> Response<M>

Handle an event and return a user-defined message

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn focus_on_key_nav(&self) -> bool

Generic handler: focus rect on key navigation

impl<M: 'static> Layout for ComboBox<M>

fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, _: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

fn spatial_nav(
    &mut self,
    _: &mut Manager<'_>,
    _: bool,
    _: Option<usize>
) -> Option<usize>

Navigation in spatial order

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

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

Get translation of a child

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

Find a widget by coordinate

impl<M: 'static> SendEvent for ComboBox<M>

fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<M: 'static> WidgetChildren for ComboBox<M>

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn WidgetConfig>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

fn find_child(&self, id: WidgetId) -> Option<usize>

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

fn find_leaf(&self, id: WidgetId) -> Option<&(dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn find_leaf_mut(
    &mut self,
    id: WidgetId
) -> Option<&mut (dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn walk_children<F>(&self, f: F) where
    F: FnMut(&(dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

fn walk_children_mut<F>(&mut self, f: F) where
    F: FnMut(&mut (dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

impl<M: 'static> WidgetConfig for ComboBox<M>

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

fn configure(&mut self, &mut Manager<'_>)

Configure widget

fn configure_recurse(&mut self, cmgr: ConfigureManager<'_, '_>)

Configure self and children

impl<M: 'static> WidgetCore for ComboBox<M>

fn as_any(&self) -> &dyn Any

Get self as type Any

fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

fn core_data_mut(&mut self) -> &mut CoreData

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

fn id(&self) -> WidgetId

Get the widget’s numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

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

Set disabled state (chaining)

fn rect(&self) -> Rect

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

fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState

impl<M: 'static> Widget for ComboBox<M>