Struct libera::all::NotcursesTextGrid

pub struct NotcursesTextGrid { /* private fields */ }

Available on crate feature revela only.

revela notcurses TextGrid layer.

Implementations

impl NotcursesTextGrid

pub fn new( nc: &mut NotcursesBackend, zone: impl Into<Zone32> ) -> Result<NotcursesTextGrid, RevelaError>

Creates a new standalone text grid.

pub fn new_child( &mut self, zone: impl Into<Zone32> ) -> Result<NotcursesTextGrid, RevelaError>

Creates a new text grid that has the current text grid as a parent.

pub fn is_scrolling(&self) -> bool

Returns true if the text grid is set to scroll.

pub fn set_scrolling(&mut self, scroll: bool) -> bool

Sets the text grid to scroll, or not.

impl NotcursesTextGrid

pub fn from_plane(plane: Plane) -> NotcursesTextGrid

pub fn into_inner(self) -> Plane

pub fn ref_inner(&self) -> &Plane

pub fn mut_inner(&mut self) -> &mut Plane

Trait Implementations

impl Debug for NotcursesTextGrid

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl TextGrid for NotcursesTextGrid

fn cursor(&self) -> Position32

Returns the current cursor position.

fn cursor_home(&mut self)

Moves the cursor to the home position (0, 0).

fn cursor_to( &mut self, position: impl Into<Position32> ) -> Result<(), RevelaError>

Moves the cursor to the specified position.

Errors

If the coordinates exceed the inner plane’s dimensions. The cursor will remain unchanged in that case.

fn cursor_to_row(&mut self, row: i32) -> Result<(), RevelaError>

Moves the cursor to the specified row.

Errors

If the row number exceed the inner plane’s rows. The cursor will remain unchanged in that case.

fn cursor_to_col(&mut self, col: i32) -> Result<(), RevelaError>

Moves the cursor to the specified column.

Errors

If the row number exceed the inner plane’s columns. The cursor will remain unchanged in that case.

fn cursor_offset( &mut self, offset: impl Into<Position32> ) -> Result<(), RevelaError>

Moves the cursor

Errors

If the coordinates exceed the inner plane’s dimensions. The cursor will remain unchanged in that case.

fn print(&mut self, string: &str) -> Result<u32, RevelaError>

Prints a string to the current cursor position.

Errors

• if the position falls outside the plane’s area.
• if a glyph can’t fit in the current line, unless scrolling is enabled.

fn contents(&mut self) -> Result<String, RevelaError>

Available on crate feature alloc only.

Returns a string with the full contents.

fn erase(&mut self)

Erases the full contents.

fn raster(&mut self) -> Result<(), RevelaError>

fn render(&mut self) -> Result<(), RevelaError>

impl Visual for NotcursesTextGrid

fn zone(&self) -> Zone32

fn size(&self) -> Size32

fn position(&self) -> Position32

fn offset(&mut self, offset: impl Into<Position32>) -> Result<(), RevelaError>

Moves the visual an offset relative to its current position.

fn move_to( &mut self, position: impl Into<Position32> ) -> Result<(), RevelaError>

Moves the visual to a new position, relative to its parent.