Struct TextBoxState 

pub struct TextBoxState<I: ApplicationInfo = EmptyInfo> { /* private fields */ }

Persistent state for TextBox.

Implementations

impl<I> TextBoxState<I>

where I: ApplicationInfo,

pub fn new(buffer: SharedBuffer<I>) -> Self

Create state for a new text box.

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> Editable<EditContext, Store<I>, I> for TextBoxState<I>

where I: ApplicationInfo,

fn editor_command( &mut self, act: &EditorAction, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Execute an editor action.

impl<I> Jumpable<EditContext, I> for TextBoxState<I>

where I: ApplicationInfo,

fn jump( &mut self, list: PositionList, dir: MoveDir1D, count: usize, ctx: &EditContext, ) -> UIResult<usize, I>

Move through a PositionList in MoveDir1D direction count times.

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

where I: ApplicationInfo,

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

Execute a prompt action.

impl<I> ScrollActions<EditContext, Store<I>, I> for TextBoxState<I>

where I: ApplicationInfo,

fn dirscroll( &mut self, dir: MoveDir2D, size: ScrollSize, count: &Count, ctx: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Pan the viewport.

fn cursorpos( &mut self, pos: MovePosition, axis: Axis, _: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll so that the cursor is placed along a viewport boundary.

fn linepos( &mut self, pos: MovePosition, count: &Count, ctx: &EditContext, _: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll so that a specific line is placed at a given place in the viewport.

impl<I> Scrollable<EditContext, Store<I>, I> for TextBoxState<I>

where I: ApplicationInfo,

fn scroll( &mut self, style: &ScrollStyle, ctx: &EditContext, store: &mut Store<I>, ) -> EditResult<EditInfo, I>

Scroll the viewable content in this object.

impl<I> Searchable<EditContext, Store<I>, I> for TextBoxState<I>

where I: ApplicationInfo,

fn search( &mut self, dir: MoveDirMod, count: Count, ctx: &EditContext, store: &mut Store<I>, ) -> UIResult<EditInfo, I>

Search for the n^th result in MoveDirMod direction.

impl<I> TerminalCursor for TextBoxState<I>

where I: ApplicationInfo,

fn get_term_cursor(&self) -> Option<(u16, u16)>

Returns the current offset of the cursor, relative to the upper left corner of the terminal.

impl<I> WindowOps<I> for TextBoxState<I>

where I: ApplicationInfo,

fn dup(&self, _: &mut Store<I>) -> Self

Create a copy of this window during a window split.

fn close(&mut self, _: CloseFlags, _: &mut Store<I>) -> bool

Perform any necessary cleanup for this window and close it.

fn write( &mut self, _: Option<&str>, _: WriteFlags, _: &mut Store<I>, ) -> UIResult<EditInfo, I>

Write the contents of the window.

fn draw(&mut self, area: Rect, buf: &mut Buffer, _: bool, _: &mut Store<I>)

Draw this window into the buffer for the prescribed area.

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

Get completion candidates to show the user.

fn get_cursor_word(&self, style: &WordStyle) -> Option<String>

Returns the word following the current cursor position in this window.

fn get_selected_word(&self) -> Option<String>

Returns the currently selected text in this window.