Trait reedline::Menu

source · 
pub trait Menu: Send {

Show 13 methods    fn name(&self) -> &str;
    fn indicator(&self) -> &str;
    fn is_active(&self) -> bool;
    fn menu_event(&mut self, event: MenuEvent);
    fn can_quick_complete(&self) -> bool;
    fn can_partially_complete(
        &mut self,
        values_updated: bool,
        editor: &mut Editor,
        completer: &mut dyn Completer
    ) -> bool;
    fn update_values(
        &mut self,
        editor: &mut Editor,
        completer: &mut dyn Completer
    );
    fn update_working_details(
        &mut self,
        editor: &mut Editor,
        completer: &mut dyn Completer,
        painter: &Painter
    );
    fn replace_in_buffer(&self, editor: &mut Editor);
    fn menu_required_lines(&self, terminal_columns: u16) -> u16;
    fn menu_string(&self, available_lines: u16, use_ansi_coloring: bool) -> String;
    fn min_rows(&self) -> u16;
    fn get_values(&self) -> &[Suggestion];

}
Expand description

Trait that defines how a menu will be printed by the painter

Required Methods

Menu name

Menu indicator

Checks if the menu is active

Selects what type of event happened with the menu

A menu may not be allowed to quick complete because it needs to stay active even with one element

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

Updates the values presented in the menu This function needs to be defined in the trait because when the menu is activated or the quick_completion option is true, the len of the values is calculated to know if there is only one value so it can be selected immediately

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

Indicates how to replace in the line buffer the selected value from the menu

Calculates the real required lines for the menu considering how many lines wrap the terminal or if entries have multiple lines

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

Minimum rows that should be displayed by the menu

Gets cached values from menu that will be displayed

Implementors