Struct reedline::ColumnarMenu

pub struct ColumnarMenu { /* private fields */ }

Menu to present suggestions in a columnar fashion It presents a description of the suggestion if available

Implementations

impl ColumnarMenu

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 text style

pub fn with_columns(self, columns: u16) -> Self

Menu builder with new columns value

pub fn with_column_width(self, col_width: Option<usize>) -> Self

Menu builder with new column width value

pub fn with_column_padding(self, col_padding: usize) -> Self

Menu builder with new column width value

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

Menu builder with marker

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

Menu builder with new only buffer difference

Trait Implementations

impl Default for ColumnarMenu

fn default() -> Self

Returns the “default value” for a type.

impl Menu for ColumnarMenu

fn name(&self) -> &str

Menu name

fn indicator(&self) -> &str

Menu indicator

fn is_active(&self) -> bool

Deactivates context menu

fn can_quick_complete(&self) -> bool

The columnar menu can to quick complete if there is only one element

fn can_partially_complete(
    &mut self,
    values_updated: bool,
    line_buffer: &mut LineBuffer,
    completer: &mut dyn Completer
) -> bool

The columnar menu can try to find the common string and replace it in the given line buffer

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
)

Updates menu values

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

The working details for the menu changes based on the size of the lines collected from the completer

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

The buffer gets replaced in the Span location

fn min_rows(&self) -> u16

Minimum rows that should be displayed by the menu

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

Gets values from filler that will be displayed in the menu

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

Calculates the real required lines for the menu considering how many lines wrap the terminal or if entries have multiple 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