Struct IdeMenu 

pub struct IdeMenu { /* private fields */ }

Menu to present suggestions like similar to Ide completion menus

Implementations

impl IdeMenu

pub fn with_min_completion_width(self, width: u16) -> Self

Menu builder with new value for min completion width

pub fn with_max_completion_width(self, width: u16) -> Self

Menu builder with new value for max completion width

pub fn with_max_completion_height(self, height: u16) -> Self

Menu builder with new value for max completion height

pub fn with_padding(self, padding: u16) -> Self

Menu builder with new value for padding

pub fn with_default_border(self) -> Self

Menu builder with the default border

pub fn with_border( self, top_right: char, top_left: char, bottom_right: char, bottom_left: char, horizontal: char, vertical: char, ) -> Self

Menu builder with new value for border

pub fn with_cursor_offset(self, cursor_offset: i16) -> Self

Menu builder with new value for cursor offset

pub fn with_description_mode(self, description_mode: DescriptionMode) -> Self

Menu builder with new description mode

pub fn with_min_description_width(self, min_description_width: u16) -> Self

Menu builder with new min description width

pub fn with_max_description_width(self, max_description_width: u16) -> Self

Menu builder with new max description width

pub fn with_max_description_height(self, max_description_height: u16) -> Self

Menu builder with new max description height

pub fn with_description_offset(self, description_offset: u16) -> Self

Menu builder with new description offset

pub fn with_correct_cursor_pos(self, correct_cursor_pos: bool) -> Self

Menu builder with new correct cursor pos

impl IdeMenu

pub fn recompute_layout(&mut self, painter: &Painter)

Recompute the completion box geometry from the current suggestions, selection, cursor, and terminal size. Runs on every repaint.

Trait Implementations

impl Default for IdeMenu

fn default() -> Self

Returns the “default value” for a type.

impl Menu for IdeMenu

fn settings(&self) -> &MenuSettings

Menu settings

fn is_active(&self) -> bool

Active status

fn can_quick_complete(&self) -> bool

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

fn menu_event(&mut self, event: MenuEvent)

Queue menu event

fn reset_position(&mut self)

Update menu values

fn update_working_details( &mut self, editor: &mut Editor, 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, editor: &mut Editor)

Apply via CompletionDisplay::accept (guards against stale spans)

fn min_rows(&self) -> u16

Minimum rows that should be displayed by the menu

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

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

fn set_active(&mut self, active: bool)

Set active state

fn clear_input(&mut self)

Clear input

fn on_activate(&mut self)

Called after Activate event.

fn update_values(&mut self, editor: &mut Editor, completer: &mut dyn Completer)

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

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

Gets cached values from menu that will be displayed

fn results_are_provisional(&self) -> bool

Whether the values currently held may still be superseded, because the last request came back Pending or Stale.

fn is_awaiting_first_answer(&self) -> bool

Whether the menu is activated but not yet drawn, having heard no answer about the line on screen. It claims no prompt indicator and reserves no rows, so a menu about to be closed by a lone suggestion never appears.

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

fn set_cursor_pos(&mut self, pos: (u16, u16))

Sets the position of the cursor (currently only required by the IDE menu)

fn name(&self) -> &str

Menu name

fn indicator(&self) -> &str

Menu indicator

fn on_deactivate(&mut self)

Called after Deactivate event.

fn handle_menu_event(&mut self, event: &MenuEvent)

Handle Activate/Deactivate events.

fn reload( &mut self, updated: bool, editor: &mut Editor, completer: &mut dyn Completer, )

Handles a menu event that reloads the menu’s contents

fn is_visible(&self) -> bool

Whether the menu is on screen. An active menu still awaiting its first answer is not: it takes input, but claims no indicator and reserves no rows.

impl MenuBuilder for IdeMenu

fn settings_mut(&mut self) -> &mut MenuSettings

Get mutable MenuSettings required for the builder functions

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

Menu builder with new name

fn with_text_style(self, color: Style) -> Self

Menu builder with new value for text style

fn with_selected_text_style(self, color: Style) -> Self

Menu builder with new value for selected text style

fn with_description_text_style(self, color: Style) -> Self

Menu builder with new value for description style

fn with_match_text_style(self, color: Style) -> Self

Menu builder with new value for match style This is the style of the part of the input text, the suggestions are based on

fn with_selected_match_text_style(self, color: Style) -> Self

Menu builder with new value for selected match style This is the style of the part of the input text, the suggestions are based on

fn with_marker(self, marker: &str) -> Self

Menu builder with new value for marker

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

Set only_buffer_difference. Ignored when input_mode set.

fn with_input_mode(self, mode: InputMode) -> Self

Menu builder with new value for input_mode. Overrides only_buffer_difference when set.

fn with_output_mode(self, mode: OutputMode) -> Self

Menu builder with new value for output_mode. Defaults to OutputMode::SuggestedSpan when unset.