itui 0.7.0

A library to build rich terminal user interfaces or dashboards
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
90
91
92
93
94
95
96
97
98
99

use bitflags::bitflags;
use std::borrow::Cow;

mod block;
mod list;
mod paragraph;
mod reflow;
mod table;
mod tabs;
mod button;

pub use self::{
    block::Block,
    button::Button,
    list::{List, SelectableList},
    paragraph::Paragraph,
    table::{Row, Table},
    tabs::Tabs,
};

use crate::{
    backend::Backend,
    buffer::Buffer,
    layout::Rect,
    style::{Color, Style},
    terminal::Frame,
};

bitflags! {
    /// Bitflags that can be composed to set the visible borders essentially on the block widget.
    pub struct Borders: u32 {
        /// Show no border (default)
        const NONE  = 0b0000_0001;
        /// Show the top border
        const TOP   = 0b0000_0010;
        /// Show the right border
        const RIGHT = 0b0000_0100;
        /// Show the bottom border
        const BOTTOM = 0b000_1000;
        /// Show the left border
        const LEFT = 0b0001_0000;
        /// Show all borders
        const ALL = Self::TOP.bits | Self::RIGHT.bits | Self::BOTTOM.bits | Self::LEFT.bits;
    }
}

#[derive(Clone, Debug, PartialEq)]
pub enum Text<'b> {
    Raw(Cow<'b, str>),
    Styled(Cow<'b, str>, Style),
}

impl<'b> Text<'b> {
    pub fn raw<D: Into<Cow<'b, str>>>(data: D) -> Text<'b> {
        Text::Raw(data.into())
    }

    pub fn styled<D: Into<Cow<'b, str>>>(data: D, style: Style) -> Text<'b> {
        Text::Styled(data.into(), style)
    }
}

/// Base requirements for a Widget
pub trait Widget {
    /// Draws the current state of the widget in the given buffer. That the only method required to
    /// implement a custom widget.
    fn draw(&mut self, buf: &mut Buffer);
    /// Helper method to quickly set the background of all cells inside the specified area.
    fn background(&self, buf: &mut Buffer, color: Color) {
        for y in self.top()..self.bottom() {
            for x in self.left()..self.right() {
                buf.get_mut(x, y).set_bg(color);
            }
        }
    }
    /// Helper method that can be chained with a widget's builder methods to render it.
    fn render<B>(&mut self, f: &mut Frame<B>)
    where
        Self: Sized,
        B: Backend,
    {
        f.render(self);
    }

    fn get_area(&self) -> Rect;

    fn top(&self) -> u16 {
        self.get_area().top()
    }
    fn bottom(&self) -> u16 {
        self.get_area().bottom()
    }
    fn left(&self) -> u16 {
        self.get_area().left()
    }
    fn right(&self) -> u16 {
        self.get_area().right()
    }
}