Struct Window 

pub struct Window {
    pub buffer_index: usize,
    pub position: Point,
    pub size: (usize, usize),
    pub vtop: usize,
    pub vleft: usize,
    pub cursor_x: usize,
    pub cursor_y: usize,
    pub active: bool,
    pub vx: usize,
}

Fields

buffer_index: usize

position: Point

size: (usize, usize)

vtop: usize

vleft: usize

cursor_x: usize

cursor_y: usize

active: bool

vx: usize

Implementations

impl Window

pub fn new(buffer_index: usize, position: Point, size: (usize, usize)) -> Self

Constructs a new window with a buffer index, a position, and a size

Arguments

• buffer_index: The index of the buffer that the window will encapsulate
• position: The position of the window
• size: The size of the window

Returns

• A newly constructed window

pub fn inner_width(&self) -> usize

Retrieves the interior width of the window

Returns

• The interior width of the window

pub fn inner_height(&self) -> usize

Retrieves the interior height of the window

Returns

• The interior height of the window

pub fn contains_position(&self, x: usize, y: usize) -> bool

Checks if the provided position is within the current window

Arguments

• x: The x coordinate of the position
• y: The y coordinate of the position

Returns

• true if the position is within the window, false otherwise

pub fn terminal_to_local_transform( &self, terminal_x: usize, terminal_y: usize, ) -> Option<(usize, usize)>

Transforms terminal coordinates to local coordinates, i.e., position relative to the window

Arguments

• terminal_x: The x coordinate relative to the terminal
• terminal_y: The y coordinate relative to the terminal

Returns

• Local coordinates if the terminal coordinates provided are contained within the window

pub fn local_to_terminal_transform( &self, local_x: usize, local_y: usize, ) -> (usize, usize)

Transforms local coordinates to terminal coordinates, i.e., position relative to the terminal

Arguments

• local_x: The x coordinate relative to the window
• local_y: The y coordinate relative to the window

Returns

• A tuple of terminal coordinates in the format (x, y)

Trait Implementations

impl Clone for Window

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.