Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature toolbar only.

The entries, their on and off states, the overflow menu and the keyboard highlight.

Implementations

impl<Id: Copy + PartialEq> State<Id>

pub fn new(entries: impl IntoIterator<Item = Entry<Id>>) -> Self

A toolbar of small buttons. Item ids must be unique.

pub fn with_size(self, size: Size) -> Self

Sets the button size. Toolbars default to Size::Sm.

pub fn entries(&self) -> &[Entry<Id>]

pub fn size(&self) -> Size

pub fn item(&self, id: Id) -> Option<&Item<Id>>

pub fn is_on(&self, id: Id) -> bool

Whether a toggle or choice is on.

pub fn visible(&self) -> usize

How many entries show in the strip at the last measured width. The rest are in the overflow menu. All of them until the strip is measured.

pub fn overflow(&self) -> &State<Id>

The overflow menu, open or closed.

pub fn highlighted(&self) -> Option<Highlight<Id>>

Where the keyboard highlight is, while the toolbar has focus.

pub fn is_focused(&self) -> bool

pub fn set_on(&mut self, id: Id, on: bool)

Turns a toggle or choice on or off. Turning a choice on turns the other choices in its group off.

pub fn set_disabled(&mut self, id: Id, disabled: bool)

Enables or disables a button. A disabled button loses the highlight.

pub fn update(&mut self, event: Event<Id>) -> Option<Output<Id>>

Applies an event and returns what a press did, if anything.

pub fn key_event( &self, keymap: &Keymap<Action>, key: &Event, ) -> Option<Event<Id>>

Turns a key press into an event: Action::Focus at any time, the other actions only while the toolbar has focus. The open overflow menu resolves its own keys before any of these.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for State<Id>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<Id: PartialEq> StructuralPartialEq for State<Id>