Struct andiskaz::ui::menu::Menu

pub struct Menu<O>where
    O: MenuOption,{
    pub title: TermString,
    pub options: Vec<O>,
    pub cancel_label: TermString,
    pub title_colors: Color2,
    pub arrow_colors: Color2,
    pub selected_colors: Color2,
    pub unselected_colors: Color2,
    pub bg: Color,
    pub title_y: Coord,
    pub pad_after_title: Coord,
    pub pad_after_option: Coord,
}

A menu, with a list of options and potentially a cancel option.

Fields

title: TermString

The title shown above the menu.

options: Vec<O>

A list of options.

cancel_label: TermString

Label showed by the “CANCEL” button (default “CANCEL”).

title_colors: Color2

Colors for the title.

arrow_colors: Color2

Colors for the arrows.

selected_colors: Color2

Colors for selected options.

unselected_colors: Color2

Colors for unselected options.

bg: Color

Color of the background of no text.

title_y: Coord

Number of lines padded before the title.

pad_after_title: Coord

Number of lines padded after the title.

pad_after_option: Coord

Number of lines padded after an option.

Implementations

impl<O> Menu<O>where O: MenuOption,

pub fn new(title: TermString, options: Vec<O>) -> Self

Creates a new menu with default styles.

pub async fn select(&self, term: &mut Terminal) -> Result<usize, Error>

Asks for the user to select an item of the menu without cancel option.

pub async fn select_with_initial( &self, term: &mut Terminal, initial: usize ) -> Result<usize, Error>

Asks for the user to select an item of the menu without cancel option, but with a given initial chosen option.

pub async fn select_with_cancel( &self, term: &mut Terminal ) -> Result<Option<usize>, Error>

Asks for the user to select an item of the menu with a cancel option.

pub async fn select_cancel_initial( &self, term: &mut Terminal, initial: usize, cancel: bool ) -> Result<Option<usize>, Error>

Asks for the user to select an item of the menu with a cancel option, and sets the initial chosen option to the given one, together with a paramter stating whether cancel option is currently chosen.

Trait Implementations

impl<O> Clone for Menu<O>where O: MenuOption + Clone,

fn clone(&self) -> Menu<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Debug for Menu<O>where O: MenuOption + Debug,

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

Formats the value using the given formatter.

impl<O> Hash for Menu<O>where O: MenuOption + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<O> PartialEq<Menu<O>> for Menu<O>where O: MenuOption + PartialEq,

fn eq(&self, other: &Menu<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<O> Eq for Menu<O>where O: MenuOption + Eq,

impl<O> StructuralEq for Menu<O>where O: MenuOption,

impl<O> StructuralPartialEq for Menu<O>where O: MenuOption,