rustty-oxide 0.1.0

An easy-to-use and extensible GUI library for Rust terminal applications using rustty
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

use rustty::{CellAccessor, Size, HasSize};
use core::attributes::{HorizontalAlign, VerticalAlign};
use core::frame::Frame;

/// Widgets are the foundation of UI, all frontend objects inherit the widget
/// type and are generalized through either the widget itself or a specialized
/// widget (e.g. *Button*, *Layout*). 
pub trait Widget {
    /// Draws the widget to the valid `CellAccessor` passed
    fn draw(&mut self, parent: &mut CellAccessor);

    /// Aligns the widget with the `parent` as reference
    fn pack(&mut self, parent: &HasSize, halign: HorizontalAlign, valign: VerticalAlign,
                margin: (usize, usize));

    /// Expose the painter trait `draw_box` for all widgets, which outlines
    /// the space enclosed within the widget
    fn draw_box(&mut self);

    /// Resize the given widget to new dimensions given by `Size`
    fn resize(&mut self, new_size: Size);

    /// Return a reference the renderer, `Base` in general cases
    fn frame(&self) -> &Frame;

    /// Return a mutable reference to the renderer, `Base` in general cases
    fn frame_mut(&mut self) -> &mut Frame;
}