termint 0.8.1

Library for colored printing and Terminal User Interfaces
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

use crate::geometry::{Rect, Vec2};

/// Contains details about currently rendering frame.
///
/// The [`Frame`] is passed to [`crate::term::Application::view`] and to the
/// closure given to [`crate::term::Term::draw`] to provide context about the
/// current frame. This ensures that the UI can adapt to the size of the
/// terminal, such as hide menu.
#[derive(Debug, Default)]
pub struct Frame {
    area: Rect,
}

impl Frame {
    /// Creates a new frame with given area.
    pub(crate) fn new(area: Rect) -> Self {
        Self { area }
    }

    /// Gets the available rendering area of the terminal.
    ///
    /// This [`crate::geometry::Rect`] accounts for the
    /// [`crate::geometry::Padding`] set in the [`crate::term::Term`].
    pub fn area(&self) -> &Rect {
        &self.area
    }

    /// Gets the size of the available rendering area of the terminal.
    pub fn size(&self) -> &Vec2 {
        self.area.size()
    }

    /// Gets the top-left position of the available rendering area of the
    /// terminal.
    pub fn pos(&self) -> &Vec2 {
        self.area.pos()
    }
}