semtext 0.1.0

Terminal UI 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

// spacer.rs
//
// Copyright (c) 2020-2021  Douglas P Lau
//
use crate::layout::{Cells, LengthBound, Pos};
use crate::text::{Glyph, IntoGlyph, Theme};
use crate::{Result, Widget};
use std::ops::RangeBounds;

/// Spacer widget
///
/// A spacer can be used for fixed or variable width spacing between other
/// widgets.  By default it draws nothing, but a fill glyph may be provided
/// using [with_fill].
///
/// [with_fill]: struct.Spacer.html#method.with_fill
#[derive(Default)]
pub struct Spacer {
    /// Width bounds
    width_bounds: LengthBound,
    /// Height bounds
    height_bounds: LengthBound,
    /// Fill character
    fill: Option<Glyph>,
}

impl Spacer {
    /// Adjust column spacing (bounds)
    ///
    /// ```rust
    /// use semtext::widget::Spacer;
    ///
    /// let s0 = Spacer::default().with_columns(..10);
    /// let s1 = Spacer::default().with_columns(2..);
    /// ```
    pub fn with_columns<R>(mut self, col: R) -> Self
    where
        R: RangeBounds<u16>,
    {
        self.width_bounds = LengthBound::new(col);
        self
    }

    /// Adjust row spacing (bounds)
    ///
    /// ```rust
    /// use semtext::widget::Spacer;
    ///
    /// let s0 = Spacer::default().with_rows(1..8);
    /// let s1 = Spacer::default().with_rows(2..=4);
    /// ```
    pub fn with_rows<R>(mut self, row: R) -> Self
    where
        R: RangeBounds<u16>,
    {
        self.height_bounds = LengthBound::new(row);
        self
    }

    /// Set a fill glyph
    pub fn with_fill<G: IntoGlyph>(mut self, fill: G) -> Result<Self> {
        self.fill = Some(fill.into_glyph()?);
        Ok(self)
    }
}

impl Widget for Spacer {
    /// Get the width bounds
    fn width_bounds(&self, _theme: &Theme) -> LengthBound {
        self.width_bounds
    }

    /// Get the height bounds
    fn height_bounds(&self, _theme: &Theme, _width: u16) -> LengthBound {
        self.height_bounds
    }

    /// Draw the widget
    fn draw(&self, cells: &mut Cells, _offset: Pos) -> Result<()> {
        if let Some(fill) = &self.fill {
            cells.fill(fill)?;
        }
        Ok(())
    }
}