Struct TextBox

pub struct TextBox { /* private fields */ }

TextBox struct definition.

Implementations

impl TextBox

pub fn new( x: u8, y: u8, width: u8, height: u8, border: u8, title: &str, text: &str, ) -> Option<TextBox>

Creates a new TextBox with the specified params.

Example

let textbox = TextBox::new(
  1, 1,                                                 // (x, y) coordinates.
  15, 6,                                                // (width, height) box size.
  2,                                                    // border type.
  "DANGER",                                             // Box title.
  "Some children are playing with dangerous weapons."   // Box text.
).unwrap();

This will print out:

╔DANGER═════════╗
║Some children  ║
║are playing    ║
║with dangerous ║
║weapons.       ║
║               ║
║               ║
╚═══════════════╝

Note: Termion use one-based coordinates, this means that the first point is (1, 1) at upside left corner.

Examples found in repository

examples/box_styles.rs (lines 9-15)

fn main() {
	clear_screen();

	let box1 = TextBox::new(
        30, 10,
        15, 6,
        2,
        "Box 1",
        "This box have a border type 2. A first level message, must be checked quickly."
    ).unwrap();
    let box2 = TextBox::new(
        10, 10,
        15, 6,
        0,
        "Box 2",
        "This box have a border type 0. Normal boxed text for alingment."
    ).unwrap();
    let box3 = TextBox::new(
        10, 2,
        35, 6,
        1,
        "Box 3",
        "This box have a border type 1. A second level message. \n You can create multiple boxes, just be careful with console window size."
    ).unwrap();
    let box4 = TextBox::new(
        47, 2,
        15, 14,
        2,
        "Box 4",
        "If you want a new line inside a box you need to put it between spaces like \n this: ' \\n '. Formatter identifies this as a new line word, so it can be printed. \n \n Right?"
    ).unwrap();

	println!("{}{}{}{}", box1, box2, box3, box4);
	
	goto(1, 40);
}

Trait Implementations

impl Default for TextBox

fn default() -> TextBox

Returns the “default value” for a type.

impl Display for TextBox

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

Added easy fmt::Display to print a TextBox just with print! println!