Struct reedline::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
sourceimpl ColumnarMenu
impl ColumnarMenu
sourcepub fn with_text_style(self, text_style: Style) -> Self
pub fn with_text_style(self, text_style: Style) -> Self
Menu builder with new value for text style
sourcepub fn with_selected_text_style(self, selected_text_style: Style) -> Self
pub fn with_selected_text_style(self, selected_text_style: Style) -> Self
Menu builder with new value for text style
sourcepub fn with_description_text_style(self, description_text_style: Style) -> Self
pub fn with_description_text_style(self, description_text_style: Style) -> Self
Menu builder with new value for text style
sourcepub fn with_columns(self, columns: u16) -> Self
pub fn with_columns(self, columns: u16) -> Self
Menu builder with new columns value
sourcepub fn with_column_width(self, col_width: Option<usize>) -> Self
pub fn with_column_width(self, col_width: Option<usize>) -> Self
Menu builder with new column width value
sourcepub fn with_column_padding(self, col_padding: usize) -> Self
pub fn with_column_padding(self, col_padding: usize) -> Self
Menu builder with new column width value
sourcepub fn with_marker(self, marker: String) -> Self
pub fn with_marker(self, marker: String) -> Self
Menu builder with marker
sourcepub fn with_only_buffer_difference(self, only_buffer_difference: bool) -> Self
pub fn with_only_buffer_difference(self, only_buffer_difference: bool) -> Self
Menu builder with new only buffer difference
Trait Implementations
sourceimpl Default for ColumnarMenu
impl Default for ColumnarMenu
sourceimpl Menu for ColumnarMenu
impl Menu for ColumnarMenu
sourcefn can_quick_complete(&self) -> bool
fn can_quick_complete(&self) -> bool
The columnar menu can to quick complete if there is only one element
sourcefn can_partially_complete(
&mut self,
values_updated: bool,
line_buffer: &mut LineBuffer,
completer: &mut dyn Completer
) -> bool
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
Selects what type of event happened with the menu
sourcefn update_values(
&mut self,
line_buffer: &mut LineBuffer,
completer: &mut dyn Completer
)
fn update_values(
&mut self,
line_buffer: &mut LineBuffer,
completer: &mut dyn Completer
)
Updates menu values
sourcefn update_working_details(
&mut self,
line_buffer: &mut LineBuffer,
completer: &mut dyn Completer,
painter: &Painter
)
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
sourcefn replace_in_buffer(&self, line_buffer: &mut LineBuffer)
fn replace_in_buffer(&self, line_buffer: &mut LineBuffer)
The buffer gets replaced in the Span location
sourcefn get_values(&self) -> &[Suggestion]
fn get_values(&self) -> &[Suggestion]
Gets values from filler that will be displayed in the menu
Calculates the real required lines for the menu considering how many lines wrap the terminal or if entries have multiple lines Read more
Creates the menu representation as a string which will be painted by the painter
Auto Trait Implementations
impl RefUnwindSafe for ColumnarMenu
impl Send for ColumnarMenu
impl Sync for ColumnarMenu
impl Unpin for ColumnarMenu
impl UnwindSafe for ColumnarMenu
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more