fp_tui 0.2.2

A very basic tui 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

use std::rc::Rc;
use std::cell::RefCell;

use super::{PositioningAlgorithm, DisplayBuffer};
use crate::common::BoundingBox;

/// #### Description
/// Base interface for every element in the tui
/// 
/// Note that most concrete widgets are stored as [Rc]<[RefCell]<dyn [Widget]> 
/// so it can be helpful to have their constructors return such a value
/// 
pub trait Widget {
    /// #### Description
    /// Draws the widget to the display buffer
    /// 
    /// #### Arguments
    /// * `positioning_algorithm`: &[Box]<dyn [PositioningAlgorithm]> - The 
    /// positioning algorithm for the widget
    /// * `display_buffer`: &mut [DisplayBuffer] - The display buffer
    /// 
    fn draw(
        &mut self,
        positioning_algorithm: &Box<dyn PositioningAlgorithm>,
        display_buffer: &mut DisplayBuffer
    );

    /// #### Description
    /// Retrieves the bounding box of the widget
    /// 
    /// #### Returns
    /// [BoundingBox] - The bounding box of the widget
    /// 
    fn get_bounding_box(&self) -> BoundingBox;
}

/// #### Description
/// An interface for widgets that contain other widgets
/// 
pub trait ContainerWidget: Widget {
    /// #### Description
    /// Add a widget to the container
    ///
    /// #### Arguments
    /// * `positioning_algorithm`: &[Box]<dyn [PositioningAlgorithm]> - The 
    /// positioning algorithm for the widget
    /// * `widget`: [Rc]<[RefCell]<dyn [Widget]>> - The widget to add
    /// 
    fn add_child(
        &mut self,
        positioning_algorithm: Box<dyn PositioningAlgorithm>,
        widget: Rc<RefCell<dyn Widget>>
    );
}