Struct rat_widget::menuline::MenuLineState

pub struct MenuLineState {
    pub focus: FocusFlag,
    pub area: Rect,
    pub item_areas: Vec<Rect>,
    pub navchar: Vec<Option<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

Area for the whole widget.

item_areas: Vec<Rect>

Areas for each item.

navchar: Vec<Option<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 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

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

Item at position.

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, MouseOnly, MenuOutcome> for MenuLineState

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

Handle an event.

impl HasFocusFlag for MenuLineState

fn focus(&self) -> &FocusFlag

Focus flag.

fn area(&self) -> Rect

Focus area.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn navigable(&self) -> bool

If the widget is focusable, but doesn’t want to partake in keyboard navigation it returns false here.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.