Struct tuikit::canvas::BoundedCanvas

pub struct BoundedCanvas<'a> { /* fields omitted */ }

A sub-area of a canvas. It will handle the adjustments of cursor movement, so that you could write to for example (0, 0) and BoundedCanvas will adjust it to real position.

Methods

impl<'a> BoundedCanvas<'a>

pub fn new(
    top: usize,
    left: usize,
    width: usize,
    height: usize,
    canvas: &'a mut dyn Canvas
) -> Self

Trait Implementations

impl<'a> Canvas for BoundedCanvas<'a>

fn size(&self) -> Result<(usize, usize)>

Get the canvas size (width, height)

fn clear(&mut self) -> Result<()>

clear the canvas

fn put_cell(&mut self, row: usize, col: usize, cell: Cell) -> Result<usize>

change a cell of position (row, col) to cell if (row, col) is out of boundary, Ok is returned, but no operation is taken return the width of the character/cell

fn set_cursor(&mut self, row: usize, col: usize) -> Result<()>

move cursor position (row, col) and show cursor

fn show_cursor(&mut self, show: bool) -> Result<()>

show/hide cursor, set show to false to hide the cursor

fn put_char_with_attr(
    &mut self,
    row: usize,
    col: usize,
    ch: char,
    attr: Attr
) -> Result<usize>

just like put_cell, except it accept (char & attr) return the width of the character/cell

fn print_with_attr(
    &mut self,
    row: usize,
    col: usize,
    content: &str,
    attr: Attr
) -> Result<usize>

print content starting with position (row, col) with attr - canvas should NOT wrap to y+1 if the content is too long - canvas should handle wide characters return the printed width of the content

fn print(&mut self, row: usize, col: usize, content: &str) -> Result<usize>

print content starting with position (row, col) with default attribute