ColumnarMenu

Struct ColumnarMenu 

Source
pub struct ColumnarMenu { /* private fields */ }
Expand description

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

Implementations§

Source§

impl ColumnarMenu

Source

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

Menu builder with new name

Source

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

Menu builder with new value for text style

Source

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

Menu builder with new value for text style

Source

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

Menu builder with new value for text style

Source

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

Menu builder with new columns value

Source

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

Menu builder with new column width value

Source

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

Menu builder with new column width value

Source

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

Menu builder with marker

Source

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

Menu builder with new only buffer difference

Trait Implementations§

Source§

impl Default for ColumnarMenu

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Menu for ColumnarMenu

Source§

fn name(&self) -> &str

Menu name

Source§

fn indicator(&self) -> &str

Menu indicator

Source§

fn is_active(&self) -> bool

Deactivates context menu

Source§

fn can_quick_complete(&self) -> bool

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

Source§

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

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

Source§

fn menu_event(&mut self, event: MenuEvent)

Selects what type of event happened with the menu

Source§

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

Updates menu values

Source§

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

Source§

fn replace_in_buffer(&self, editor: &mut Editor)

The buffer gets replaced in the Span location

Source§

fn min_rows(&self) -> u16

Minimum rows that should be displayed by the menu

Source§

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

Gets values from filler that will be displayed in the menu

Source§

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
Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.