Struct MenuLineState 

pub struct MenuLineState {
    pub area: Rect,
    pub inner: Rect,
    pub item_areas: Vec<Rect>,
    pub navchar: Vec<Option<char>>,
    pub disabled: Vec<bool>,
    pub selected: Option<usize>,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

area: Rect

Area for the whole widget. readonly. renewed for each render.

inner: Rect

Area inside the block. read only. renewed for each render.

item_areas: Vec<Rect>

Areas for each item. readonly. renewed for each render.

navchar: Vec<Option<char>>

Hot keys readonly. renewed for each render.

disabled: Vec<bool>

Disable menu-items. readonly. renewed for each render.

selected: Option<usize>

Selected item. read+write

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Flags for mouse handling. used for mouse interaction

non_exhaustive: NonExhaustive

Implementations

impl MenuLineState

pub fn new() -> Self

pub fn named(name: &str) -> Self

New with a focus name.

pub fn len(&self) -> usize

Number of items.

pub fn is_empty(&self) -> bool

Any items.

pub fn select(&mut self, select: Option<usize>) -> bool

Select

pub fn selected(&self) -> Option<usize>

Selected index

pub fn prev_item(&mut self) -> bool

Previous item.

pub fn next_item(&mut self) -> bool

Next item.

pub fn navigate(&mut self, c: char) -> MenuOutcome

Select by hotkey

pub fn select_at(&mut self, pos: (u16, u16)) -> bool

Select item at position. Only reports a change if the selection actually changed. Reports no change before the first render and if no item was hit.

pub fn select_at_always(&mut self, pos: (u16, u16)) -> bool

Select item at position. Reports a change even if the same menu item has been selected. Reports no change before the first render and if no item was hit.

pub fn item_at(&self, pos: (u16, u16)) -> Option<usize>

Item at position.

Trait Implementations

impl Clone for MenuLineState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuLineState

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

Formats the value using the given formatter.

impl Default for MenuLineState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, MenuOutcome> for MenuLineState

fn handle(&mut self, event: &Event, _: MouseOnly) -> MenuOutcome

Handle an event.

impl HandleEvent<Event, Regular, MenuOutcome> for MenuLineState

fn handle(&mut self, event: &Event, _: Regular) -> MenuOutcome

Handle an event.

impl HasFocus for MenuLineState

fn focus(&self) -> FocusFlag

Focus flag.

fn area(&self) -> Rect

Focus area.

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl HasScreenCursor for MenuLineState

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl RelocatableState for MenuLineState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).