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

//
// 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 crate::component::Component;
use crate::error::Result;
use crate::widgets::{Form,WidgetFns};

use crate::private::{Child,ComponentPtr,Nullify};
use crate::asm::*;
use newt_sys::*;

///
/// Trait implemented by `Grid` type `Component`s.
///
pub trait Grid: Component + GridFns { }

impl <T: Grid> WidgetFns for T {
    fn takes_focus(&self, _value: bool) {
        panic!("`Grid` is not a `Widget`");
    }

    fn get_position(&self) -> (i32, i32) {
        panic!("`Grid` is not a `Widget`");
    }

    fn get_size(&self) -> (i32, i32) {
        panic!("`Grid` is not a `Widget`");
    }
}

impl <T: Grid> Nullify for T {
    fn nullify(&self) { }
}

///
/// Trait implemented by `Grid`s that returns all child components from
/// themselves and sub-Grids.
///
pub trait Parent {
    /// Get all child components from `Grid` and sub-Grids.
    fn children(&self) -> Vec<&dyn Component>;
}

///
/// Implements functions shared by `Grid`s.
///
pub trait GridFns: AsComponent + Child + ComponentPtr + Parent {
    ///
    /// Add `Grid` to a `Form`.
    ///
    /// * `form` - The form to add the `Grid` to.
    ///
    fn add_to_form<'a>(&'a self, form: &mut Form<'a>)
        -> Result<()>
    {
        self.add_to_parent()?;
        unsafe { newtGridAddComponentsToForm(self.grid_ptr(), form.co(), 1); }
        form.add_refs(self.children());
        Ok(())
    }

    ///
    /// Get the size of the `Grid`.
    ///
    /// `Returns` the width and height as a tuple (`width`, `height`).
    ///
    fn get_size(&self) -> (i32, i32) {
        let mut width: i32 = 0;
        let mut height: i32 = 0;
        unsafe {
            newtGridGetSize(self.grid_ptr(), &mut width, &mut height);
        }
        (width, height)
    }

    ///
    /// Move the `Grid` to a specified location.
    ///
    /// * `left` - The left-most position of the `Grid`.
    /// * `top` - The top-most position of the `Grid`.
    ///
    fn place(&self, left: i32, top: i32) {
        unsafe {
            newtGridPlace(self.grid_ptr(), left, top);
        }
    }
}