Struct kas::widget::ComboBox

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

A pop-up multiple choice menu

Implementations

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

pub fn new<T, I: IntoIterator<Item = T>>(iter: I) -> Self where
    ComboBox<M>: FromIterator<T>, 

Construct a combobox

A combobox presents a menu with a fixed set of choices when clicked. Each choice has some corresponding message of type M which is emitted by the event handler when this choice is selected.

This constructor may be used with an iterator compatible with any FromIterator for ComboBox, for example:

let combobox = ComboBox::<i32>::new([("one", 1), ("two", 2), ("three", 3)].iter());

pub fn active(&self) -> usize

Get the index of the active choice

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

Set the active choice

Panics if index >= self.len().

pub fn msg(&self) -> M

Get the message associated with the active choice

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

pub fn len(&self) -> usize

Get the number of entries

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

Add a choice to the combobox, in last position

Triggers a reconfigure action.

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

Add a choice at position index

Panics if index > len.

Triggers a reconfigure action.

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

Removes the choice at position index and returns its message

Panics if index is out of bounds or if the removal would leave the ComboBox empty (which is not allowed).

Triggers a reconfigure action.

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

Replace the choice at index

Panics if index is out of bounds.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<'a, M: Clone + Debug + 'static> FromIterator<&'a (&'static str, M)> for ComboBox<M>

pub fn from_iter<I: IntoIterator<Item = &'a (&'static str, M)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Into<AccelString>, M: Clone + Debug> FromIterator<(T, M)> for ComboBox<M>

pub fn from_iter<I: IntoIterator<Item = (T, M)>>(iter: I) -> Self

Creates a value from an iterator.

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

type Msg = M

Type of message returned by this widget

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

Handle an event and return a user-defined message

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

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

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

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

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

Draw a widget and its children

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

Get translation of a child

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

Find a widget by coordinate

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

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

Send an event

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

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

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

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

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

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

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

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

Check whether id is a descendant

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

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

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

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

Configure widget

pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

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

pub fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Set the disabled state of a widget

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

Set disabled state (chaining)

pub fn rect(&self) -> Rect

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

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

Construct InputState