Struct termimad::Area

pub struct Area {
    pub left: u16,
    pub top: u16,
    pub width: u16,
    pub height: u16,
}

A rectangular part of the screen

Fields

left: u16

top: u16

width: u16

height: u16

Implementations

impl Area

pub const fn uninitialized() -> Area

build a new area. You’ll need to set the position and size before you can use it

pub const fn new(left: u16, top: u16, width: u16, height: u16) -> Area

build a new area.

pub fn full_screen() -> Area

build an area covering the whole terminal

pub const fn right(&self) -> u16

pub const fn bottom(&self) -> u16

pub const fn contains(&self, x: u16, y: u16) -> bool

tell whether the char at (x,y) is in the area

pub fn pad(&mut self, dx: u16, dy: u16)

shrink the area

pub fn pad_for_max_width(&mut self, max_width: u16)

symmetrically shrink the area if its width is bigger than max_width

pub fn scrollbar<U>(&self, scroll: U, content_height: U) -> Option<(u16, u16)>where
    U: Into<usize>,

Return an option which when filled contains a tupple with the top and bottom of the vertical scrollbar. Return none when the content fits the available space.

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Area

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

Formats the value using the given formatter.

impl Default for Area

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Area> for Area

fn eq(&self, other: &Area) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Area

impl StructuralEq for Area

impl StructuralPartialEq for Area