newt 0.7.2

Rust bindings for the Newt console 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//
// Copyright (C) 2019 Robert Gill <rtgill82@gmail.com>
//
// This file is a part of newt-rs.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License version 2.1 as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//

use std::cell::Cell;
use std::ffi::{CString,c_void};
use std::os::raw::c_char;
use newt_sys::*;

use crate::component::Component;
use crate::grid::r#trait;
use crate::private::ComponentPtr;

#[doc(hidden)]
pub mod basic_window;
#[doc(hidden)]
pub mod button_bar;
#[doc(hidden)]
pub mod horizontal_grid;
#[doc(hidden)]
pub mod simple_window;
#[doc(hidden)]
pub mod vertical_grid;

#[doc(inline)]
pub use self::basic_window::BasicWindow;
#[doc(inline)]
pub use self::button_bar::ButtonBar;
#[doc(inline)]
pub use self::horizontal_grid::HorizontalGrid;
#[doc(inline)]
pub use self::simple_window::SimpleWindow;
#[doc(inline)]
pub use self::vertical_grid::VerticalGrid;

///
/// Arrange `Component`s and sub-grids within a two-dimensional grid.
///
/// Component screen positions will automatically be calculated based
/// on their position in the grid.
///
#[derive(Grid)]
pub struct Grid<'a> {
    co: Cell<newtGrid>,
    added_to_parent: Cell<bool>,
    children: Vec<&'a dyn Component>,
    cols: i32,
    rows: i32
}

impl<'a> Grid<'a> {
    ///
    /// Create a new Grid with the specified columns and rows.
    ///
    /// * `cols` - The number of columns the `Grid` should have.
    /// * `rows` - The number of rows the `Grid` should have.
    ///
    pub fn new(cols: i32, rows: i32) -> Grid<'a> {
        assert!(cols > 0, "`cols` must be greater than 0");
        assert!(rows > 0, "`rows` must be greater than 0");

        Grid {
            co: unsafe { Cell::new(newtCreateGrid(cols, rows)) },
            added_to_parent: Cell::new(false),
            children: Vec::new(),
            cols, rows
        }
    }

    ///
    /// Add a component or sub-grid to the positon (`col`, `row`) in the grid.
    ///
    /// * `col` - The column to position the component.
    /// * `row` - The row to position the component.
    /// * `val` - The `Component` to be added to the `Grid`.
    /// * `pad_left` - The amount of padding towards the left of the cell.
    /// * `pad_top` - The amount of padding towards the top of the cell.
    /// * `pad_right` - The amount of padding towards the right of the cell.
    /// * `pad_bottom` - The amount of padding towards the bottom of the cell.
    /// * `anchor` - Anchor the component towards the specified direction of
    ///   its cell compared to surrounding cells. See [anchor flags][anchors].
    /// * `flags` - [Flags][flags] modifying sub-Grid behavior.
    ///
    /// [flags]: crate::constants::grid
    /// [anchors]: crate::constants::grid
    ///
    pub fn set_field(&mut self, col: i32, row: i32, val: &'a dyn Component,
                     pad_left: i32, pad_top: i32, pad_right: i32,
                     pad_bottom: i32, anchor: i32, flags: i32) {

        if col >= self.cols || row >= self.rows {
            panic!("Attempting to set a field at an invalid position ({}, {})", col, row);
        }

        let r#type = val.grid_element_type();
        let co = val.co();
        self.children.push(val);

        unsafe {
            newtGridSetField(self.grid_ptr(), col, row, r#type,
                             co as *mut c_void, pad_left, pad_top, pad_right,
                             pad_bottom, anchor, flags);
        }
    }
}

///
/// Wrap a `Grid` in a centered window.
///
/// Wraps a `Grid` in a centered window and automatically displays it.
///
/// * `grid` - The `Grid` to be wrapped in the window.
/// * `title` - The title of the window to be displayed.
///
pub fn wrapped_window(grid: &dyn r#trait::Grid, title: &str) {
    let c_str = CString::new(title).unwrap();
    unsafe {
        newtGridWrappedWindow(grid.grid_ptr(), c_str.as_ptr() as *mut c_char);
    }
}

///
/// Wrap a `Grid` in a window at a specified location.
///
/// Wraps a `Grid` in a window and displays the window at the specified
/// location.
///
/// * `grid` - The `Grid` to be wrapped in the window.
/// * `title` - The title of the window to be displayed.
/// * `left` - The left-most position of the window.
/// * `top` - The top-most position of the window.
///
pub fn wrapped_window_at(grid: &dyn r#trait::Grid, title: &str,
                         left: i32, top: i32) {
    let c_str = CString::new(title).unwrap();
    unsafe {
        newtGridWrappedWindowAt(grid.grid_ptr(), c_str.as_ptr() as *mut c_char,
                                left, top);
    }
}