Struct text_display::TextDisplay

pub struct TextDisplay { /* private fields */ }

A text displayable profiles the size and color of a block of text. It can display in a framebuffer.

Implementations

impl TextDisplay

pub fn new( width: usize, height: usize, fg_color: Color, bg_color: Color ) -> Result<TextDisplay, &'static str>

Creates a new text displayable.

Arguments

• width, height: the dimensions of the text area, in number of characters.
• fg_color, bg_color: the color of the text and the background behind the text, respectively.

pub fn get_bg_color(&self) -> Color

Gets the background color of the text area

pub fn reset_cache(&mut self)

Clear the cache of the text displayable.

pub fn get_location(&self, index: usize) -> (usize, usize)

Translate the index of a character in the text to the location of the text displayable. Return (column, line).

pub fn get_index(&self, column: usize, line: usize) -> usize

Translate the location of a character to its index in the text.

pub fn get_dimensions(&self) -> (usize, usize)

Gets the size of a text displayable in number of characters.

pub fn get_next_index(&self) -> usize

Gets the index of next character to be displayabled. It is the position next to existing printed characters in the text displayable.

pub fn set_text(&mut self, text: &str)

Sets the text of the text displayable

Trait Implementations

impl Debug for TextDisplay

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

Formats the value using the given formatter.

impl Displayable for TextDisplay

fn display<P: Pixel + From<Color>>( &mut self, coordinate: Coord, framebuffer: &mut Framebuffer<P> ) -> Result<Rectangle, &'static str>

Displays this Displayable’s content in the given framebuffer.

fn set_size(&mut self, width: usize, height: usize)

Resizes the displayable area, but does not automatically refresh its display.

fn get_size(&self) -> (usize, usize)

Gets the size of the area occupied by the displayable.