textual 1.0.0-dev

A reactive TUI framework inspired by the Python Textual 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use crate::style::{Dock, Split, Style};
use crate::widget_tree::Rect;

/// Extract border spacing (top, bottom, left, right) from a style.
pub(crate) fn border_spacing(style: &Style) -> (u16, u16, u16, u16) {
    let top = if style.border_top.is_set() { 1 } else { 0 };
    let right = if style.border_right.is_set() { 1 } else { 0 };
    let bottom = if style.border_bottom.is_set() { 1 } else { 0 };
    let left = if style.border_left.is_set() { 1 } else { 0 };
    (top, bottom, left, right)
}

// ---------------------------------------------------------------------------
// Region
// ---------------------------------------------------------------------------

/// A positioned rectangle in terminal cells (x, y, width, height form).
///
/// Complements [`Rect`] (x0/y0/x1/y1 form) used by `WidgetTree` for storage.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Region {
    pub x: u16,
    pub y: u16,
    pub width: u16,
    pub height: u16,
}

impl Region {
    pub const ZERO: Self = Self {
        x: 0,
        y: 0,
        width: 0,
        height: 0,
    };

    pub fn new(x: u16, y: u16, width: u16, height: u16) -> Self {
        Self {
            x,
            y,
            width,
            height,
        }
    }

    /// Convert to the x0/y0/x1/y1 [`Rect`] used by `WidgetTree`.
    pub(crate) fn to_rect(self) -> Rect {
        Rect {
            x0: self.x,
            y0: self.y,
            x1: self.x.saturating_add(self.width),
            y1: self.y.saturating_add(self.height),
        }
    }
}

// ---------------------------------------------------------------------------
// CarveDir: shared direction for dock and split edge-carving
// ---------------------------------------------------------------------------

/// Direction for edge-carving layout (shared by dock and split).
#[derive(Clone, Copy)]
pub(crate) enum CarveDir {
    Top,
    Right,
    Bottom,
    Left,
}

impl From<Dock> for CarveDir {
    fn from(d: Dock) -> Self {
        match d {
            Dock::Top => CarveDir::Top,
            Dock::Right => CarveDir::Right,
            Dock::Bottom => CarveDir::Bottom,
            Dock::Left => CarveDir::Left,
        }
    }
}

impl From<Split> for CarveDir {
    fn from(s: Split) -> Self {
        match s {
            Split::Top => CarveDir::Top,
            Split::Right => CarveDir::Right,
            Split::Bottom => CarveDir::Bottom,
            Split::Left => CarveDir::Left,
        }
    }
}