bernardo-tui 0.2.7

A keyboard-only, distraction-free TUI widget library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use crate::primitives::rect::Rect;
use crate::primitives::xy::XY;

/*
Screenspace represents a combined information about output size:
- each output starts in (0,0) and is of output_size (exclusive)
- visible rect is a non-deformed, strictly contained piece of screen that will be visible to the
    user. The reason this information is passed is:
    1) to facilitate meaningful PageUp/PageDown operations
    2) to optimise rendering
 */
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub struct Screenspace {
    output_size: XY,
    visible_rect: Rect,
}

impl Screenspace {
    pub fn new(output_size: XY, visible_rect: Rect) -> Self {
        debug_assert!(output_size.has_non_zero_area());
        debug_assert!(
            visible_rect.size <= output_size,
            "visible_rect = {}, output_size = {}",
            visible_rect,
            output_size
        );
        debug_assert!(visible_rect.size.has_non_zero_area());

        Self { output_size, visible_rect }
    }

    pub fn full_output(output_size: XY) -> Self {
        debug_assert!(output_size.has_non_zero_area());

        Self {
            output_size,
            visible_rect: Rect::new(XY::ZERO, output_size),
        }
    }

    pub fn output_size(&self) -> XY {
        self.output_size
    }

    pub fn visible_rect(&self) -> Rect {
        self.visible_rect
    }

    pub fn page_height(&self) -> u16 {
        self.visible_rect.size.y
    }
}