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

//
// 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
//

//!
//! newt UI widgets.
//!
use std::os::raw::c_int;

use crate::private::ComponentPtr;
use newt_sys::*;

pub mod form;
#[doc(no_inline)]
pub use self::form::Form;

mod vertical_scrollbar;
pub use self::vertical_scrollbar::VerticalScrollbar;

mod button;
pub use self::button::Button;
mod checkbox;
pub use self::checkbox::Checkbox;
mod checkbox_tree;
pub use self::checkbox_tree::CheckboxTree;
mod compact_button;
pub use self::compact_button::CompactButton;
mod entry;
pub use self::entry::Entry;
mod label;
pub use self::label::Label;
mod listbox;
pub use self::listbox::Listbox;
mod radiobutton;
pub use self::radiobutton::Radiobutton;
mod radiobutton_set;
pub use self::radiobutton_set::RadiobuttonSet;
mod scale;
pub use self::scale::Scale;
mod textbox;
pub use self::textbox::Textbox;

///
/// Implement shared functions for newt component widgets.
///
pub trait WidgetFns: ComponentPtr {
    ///
    /// Allow the widget to be focused when its parent [`Form`] is run.
    ///
    fn takes_focus(&self, value: bool) {
        unsafe { newtComponentTakesFocus(self.co_ptr(), value as c_int); }
    }

    ///
    /// Get the position of the widget's top left corner.
    ///
    /// `Returns` a tuple in the form of `(left, top)`.
    ///
    fn get_position(&self) -> (i32, i32) {
        let mut left: i32 = 0;
        let mut top:  i32 = 0;

        unsafe {
            newtComponentGetPosition(self.co_ptr(), &mut left, &mut top)
        };
        (left, top)
    }

    ///
    /// Get the widget's width and height.
    ///
    /// `Returns` a tuple in the form of `(width, height)`.
    ///
    fn get_size(&self) -> (i32, i32) {
        let mut width:  i32 = 0;
        let mut height: i32 = 0;

        unsafe {
            newtComponentGetSize(self.co_ptr(), &mut width, &mut height)
        };
        (width, height)
    }
}