Struct MenuItem

pub struct MenuItem<'a> {
    pub item: Cow<'a, str>,
    pub highlight: Option<Range<usize>>,
    pub navchar: Option<char>,
    pub right: Cow<'a, str>,
    pub disabled: bool,
    pub separator: Option<Separator>,
    pub non_exhaustive: NonExhaustive,
}

A menu item.

Fields

item: Cow<'a, str>

Menuitem text

highlight: Option<Range<usize>>

Text range to highlight. This is a byte-range into item.

navchar: Option<char>

Navigation key char.

right: Cow<'a, str>

Right aligned text. To show the hotkey, or whatever. Hotkey handling is not included in this crate.

disabled: bool

Disabled item.

separator: Option<Separator>

Separator after the item.

non_exhaustive: NonExhaustive

Implementations

impl<'a> MenuItem<'a>

pub fn new() -> Self

pub fn new_parsed(s: &'a str) -> Self

Uses ‘_’ as special character.

Item

The first ‘_’ marks the navigation-char. Pipe ‘|’ separates the item text and the right text.

Separator

\\ (underscore) is used as prefix and then a fixed string to identify the separator:

• \\ - three blanks -> empty separator
• \\___ - three underscores -> plain line
• \\______ - six underscore -> thick line
• \\=== - three equals -> double line
• \\--- - three hyphen -> dashed line
• \\... - three dots -> dotted line

pub fn new_str(text: &'a str) -> Self

New borrowed string as item text.

pub fn new_string(text: String) -> Self

New with owned string as item text.

pub fn new_nav_str( text: &'a str, highlight: Range<usize>, navchar: char, ) -> Self

New with navigation char and highlight. Highlight here is a byte range into the text.

pub fn new_nav_string( text: String, highlight: Range<usize>, navchar: char, ) -> Self

New with navigation char and highlight. Highlight here is a byte range into the text.

pub fn new_sep(separator: Separator) -> Self

New separator.

Such a menu item will be merged with the one before, unless you set some item-text later.

pub fn right(self, right: &'a str) -> Self

Set the right text.

pub fn disabled(self) -> Self

Set disabled.

pub fn separator(self, separator: Separator) -> Self

Adds a separator after the menuitem.

pub fn item_width(&self) -> u16

Text-width in graphemes for item.

pub fn right_width(&self) -> u16

Text-width in graphemes for right.

pub fn height(&self) -> u16

Text-height.

Trait Implementations

impl<'a> Clone for MenuItem<'a>

fn clone(&self) -> MenuItem<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MenuItem<'a>

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

Formats the value using the given formatter.

impl Default for MenuItem<'_>

fn default() -> Self

Returns the “default value” for a type.