Struct CommandBarState 

pub struct CommandBarState<I: ApplicationInfo> { /* private fields */ }

Persistent state for rendering CommandBar.

Implementations

impl<I> CommandBarState<I>

where I: ApplicationInfo,

pub fn new(store: &mut Store<I>) -> Self

Create state for a CommandBar widget.

pub fn get_completions(&self) -> Option<CompletionList>

Get completion candidates from the command bar to show the user.

pub fn set_type( &mut self, prompt: &str, ct: CommandType, act: &Action<I>, ctx: &EditContext, )

Set the type of command that the bar is being used for.

pub fn reset(&mut self) -> EditRope

Reset the contents of the bar, and return the contents as an EditRope.

pub fn reset_text(&mut self) -> String

Reset the contents of the bar, and return the contents as a String.

Methods from Deref<Target = TextBoxState<I>>

pub fn buffer(&self) -> SharedBuffer<I>

Get a reference to the shared buffer used by this text box.

pub fn is_readonly(&self) -> bool

Indicates whether the buffer contents are readonly.

pub fn set_readonly(&mut self, readonly: bool)

Set whether the buffer contents are modifiable through the Editable trait.

pub fn get(&self) -> EditRope

Get the contents of the underlying buffer as an EditRope.

pub fn get_text(&self) -> String

Get the contents of the underlying buffer as a String.

pub fn set_text<T: Into<EditRope>>(&mut self, t: T)

Replace the contents of the text box’s underlying buffer.

pub fn reset(&mut self) -> EditRope

Clear the text box’s underlying buffer of its content, and return it.

pub fn reset_text(&mut self) -> String

Clear the text box’s underlying buffer of its content, and return it as a String.

pub fn set_left_gutter(&mut self, line: usize, s: String, style: Option<Style>)

Create or update a line annotation for the left gutter.

pub fn set_right_gutter(&mut self, line: usize, s: String, style: Option<Style>)

Create or update a line annotation for the right gutter.

pub fn set_wrap(&mut self, wrap: bool)

Control whether the text box should wrap long lines when displaying them.

pub fn set_term_info(&mut self, area: Rect)

Inform the text box what its dimensions and placement on the terminal window is.

pub fn get_cursor(&mut self) -> Cursor

Get the leader cursor for this text box’s cursor group.

pub fn get_lines(&self) -> usize

Calculate how many lines are in this text box.

pub fn has_lines(&self, max: usize) -> usize

Check whether this text box is capable of displaying max lines.

If there are fewer lines available than max, this returns the same value as get_lines(). Otherwise, this returns max.

This method is useful for building additional widgets that want to create a TextBox with a flexible height up to max lines.

Trait Implementations

impl<I> Deref for CommandBarState<I>

where I: ApplicationInfo,

type Target = TextBoxState<I>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I> DerefMut for CommandBarState<I>

where I: ApplicationInfo,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<I> PromptActions<EditContext, Store<I>, I> for CommandBarState<I>

where I: ApplicationInfo,

fn submit( &mut self, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<Vec<(Action<I>, EditContext)>, I>

Submit the currently entered text.

fn abort( &mut self, _empty: bool, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<Vec<(Action<I>, EditContext)>, I>

Abort command entry and reset the current contents.

fn recall( &mut self, filter: &RecallFilter, dir: &MoveDir1D, count: &Count, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<Vec<(Action<I>, EditContext)>, I>

Recall previously entered text.

impl<I> Promptable<EditContext, Store<I>, I> for CommandBarState<I>

where I: ApplicationInfo,

fn prompt( &mut self, act: &PromptAction, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<Vec<(Action<I>, EditContext)>, I>

Execute a prompt action.