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

//
// 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;
use std::os::raw::c_char;

use newt_sys::*;
use crate::component::Component;
use crate::private::funcs::*;

///
/// A widget that can display multiple lines of text.
///
#[derive(Component)]
pub struct Textbox {
    co: Cell<newtComponent>,
    added_to_parent: Cell<bool>
}

impl Textbox {
    ///
    /// Create a new `Textbox`.
    ///
    /// * `left` - The left-most postion of the `Textbox`.
    /// * `top` - The top-most position of the `Textbox`.
    /// * `width` - The width of the `Textbox`.
    /// * `height` - The height of the `Textbox`.
    /// * `flags` - The [flags][textbox] specifying `Textbox` behavior.
    ///   See also [general flags][flags].
    ///
    /// [textbox]: crate::constants::textbox
    /// [flags]: crate::constants::flags
    ///
    pub fn new(left: i32, top: i32, width: i32, height: i32, flags: i32)
        -> Textbox
    {
        unsafe {
            let co = newtTextbox(left, top, width, height, flags);
            if co.is_null() {
                malloc_failure();
            }

            Textbox {
                co: Cell::new(co),
                added_to_parent: Cell::new(false)
            }
        }
    }

    ///
    /// Create a new `Textbox` in which text is automatically reflowed.
    ///
    /// A `Textbox` in which the text is automatically reflowed on whitespace
    /// boundaries, rather than splitting words when word wrapping. Height is
    /// automatically calculated and word wrap is automatically enabled.
    ///
    /// * `left` - The left-most position of the `Textbox`.
    /// * `top` - The top-most position of the `Textbox`.
    /// * `text` - The text for the `Textbox` to display.
    /// * `width` - The width of the `Textbox`.
    /// * `flex_down` - The minimum difference from target width for word
    ///   wrapping.
    /// * `flex_up` - The maximum difference from target width for word
    ///   wrapping.
    /// * `flags` - The [flags][textbox] specifying widget behavior.
    ///   See also [general flags][flags].
    ///
    /// [textbox]: crate::constants::textbox
    /// [flags]: crate::constants::flags
    ///
    pub fn new_reflowed(left: i32, top: i32, text: &str, width: i32,
                        flex_down: i32, flex_up: i32, flags: i32)
        -> Textbox
    {
        let c_text = CString::new(text).unwrap();
        unsafe {
            let co = newtTextboxReflowed(
                left,
                top,
                c_text.as_ptr() as *mut c_char,
                width,
                flex_down,
                flex_up,
                flags
            );

            if co.is_null() {
                malloc_failure();
            }

            Textbox {
                co: Cell::new(co),
                added_to_parent: Cell::new(false)
            }
        }
    }

    ///
    /// Set the text displayed in the `Textbox`.
    ///
    /// * `text` - The text for the `Textbox` to display.
    ///
    pub fn set_text(&self, text: &str) {
        let c_text = CString::new(text).unwrap();
        unsafe { newtTextboxSetText(self.co(), c_text.as_ptr()); }
    }

    ///
    /// Set the height of the `Textbox`.
    ///
    /// * `height` - The height to set the `Textbox`.
    ///
    pub fn set_height(&self, height: i32) {
        unsafe { newtTextboxSetHeight(self.co(), height); }
    }

    ///
    /// `Returns` the number of lines of text displayed in the `Textbox`.
    ///
    pub fn get_num_lines(&self) -> i32 {
        unsafe { newtTextboxGetNumLines(self.co()) }
    }

    ///
    /// Set the colors of the `Textbox`.
    ///
    /// See [COLORSET_CUSTOM][colorset_custom] for defining new color sets.
    ///
    /// * `normal` - The color set to use when in a normal state.
    /// * `active` - The color set to use when activated or selected.
    ///
    /// [colorset_custom]: crate::constants::COLORSET_CUSTOM
    ///
    pub fn set_colors(&self, normal: i32, active: i32) {
        unsafe { newtTextboxSetColors(self.co(), normal, active); }
    }
}