Struct rat_input::menuline::MenuLineState

pub struct MenuLineState {
    pub focus: FocusFlag,
    pub area: Rect,
    pub areas: Vec<Rect>,
    pub key: Vec<char>,
    pub selected: Option<usize>,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State for the menu widget

Fields

focus: FocusFlag

Current focus state.

area: Rect

Focus

areas: Vec<Rect>

Areas for each item.

key: Vec<char>

Hot keys

selected: Option<usize>

Selected item.

mouse: MouseFlags

Flags for mouse handling.

non_exhaustive: NonExhaustive

Implementations

impl MenuLineState

pub fn new() -> Self

pub fn set_focused(&mut self, focus: bool)

Renders the widget in focused style.

This flag is not used for event-handling.

pub fn is_focused(&mut self) -> bool

Renders the widget in focused style.

This flag is not used for event-handling.

pub fn len(&self) -> usize

Number of items.

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

Selected index

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

Select

pub fn select_by_key(&mut self, cc: char) -> bool

Select by hotkey

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

Item at position.

pub fn next(&mut self) -> bool

Next item.

pub fn prev(&mut self) -> bool

Previous item.

Trait Implementations

impl Clone for MenuLineState

fn clone(&self) -> MenuLineState

Returns a copy 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, FocusKeys, MenuOutcome> for MenuLineState

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

Handle an event.

impl HandleEvent<Event, HotKeyAlt, MenuOutcome> for MenuLineState

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

Handle an event.

impl HandleEvent<Event, HotKeyCtrl, MenuOutcome> for MenuLineState

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

Handle an event.

impl HandleEvent<Event, MouseOnly, MenuOutcome> for MenuLineState

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

Handle an event.