Struct reedline::ListMenu

pub struct ListMenu { /* private fields */ }

Struct to store the menu style Context menu definition

Implementations

impl ListMenu

pub fn with_name(self, name: &str) -> Self

Menu builder with new name

pub fn with_text_style(self, text_style: Style) -> Self

Menu builder with new value for text style

pub fn with_selected_text_style(self, selected_text_style: Style) -> Self

Menu builder with new value for text style

pub fn with_description_text_style(self, description_text_style: Style) -> Self

Menu builder with new value for description style

pub fn with_page_size(self, page_size: usize) -> Self

Menu builder with new page size

pub fn with_only_buffer_difference(self, only_buffer_difference: bool) -> Self

Menu builder with new only buffer difference

impl ListMenu

pub fn with_marker(self, marker: String) -> Self

Menu builder with menu marker

pub fn with_max_entry_lines(self, max_lines: u16) -> Self

Menu builder with max entry lines

Trait Implementations

impl Default for ListMenu

fn default() -> Self

Returns the “default value” for a type.

impl Menu for ListMenu

fn indicator(&self) -> &str

Menu indicator

fn is_active(&self) -> bool

Deactivates context menu

fn can_quick_complete(&self) -> bool

There is no use for quick complete for the menu

fn can_partially_complete(
    &mut self,
    _values_updated: bool,
    _line_buffer: &mut LineBuffer,
    _completer: &mut dyn Completer
) -> bool

The menu should not try to auto complete to avoid comparing all registered values

fn menu_event(&mut self, event: MenuEvent)

Selects what type of event happened with the menu

fn update_values(
    &mut self,
    line_buffer: &mut LineBuffer,
    completer: &mut dyn Completer
)

Collecting the value from the completer to be shown in the menu

fn get_values(&self) -> &[Suggestion]

Gets values from cached values that will be displayed in the menu

fn replace_in_buffer(&self, line_buffer: &mut LineBuffer)

The buffer gets cleared with the actual value

fn menu_required_lines(&self, terminal_columns: u16) -> u16

Calculates the real required lines for the menu considering how many lines wrap the terminal and if an entry is larger than the remaining lines

fn menu_string(&self, _available_lines: u16, use_ansi_coloring: bool) -> String

Creates the menu representation as a string which will be painted by the painter

fn min_rows(&self) -> u16

Minimum rows that should be displayed by the menu

fn name(&self) -> &str

Menu name

fn update_working_details(
    &mut self,
    line_buffer: &mut LineBuffer,
    completer: &mut dyn Completer,
    painter: &Painter
)

The working details of a menu are values that could change based on the menu conditions before it being printed, such as the number or size of columns, etc. In this function should be defined how the menu event is treated since it is called just before painting the menu