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

//
// 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 std::ptr;

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

///
/// A widget displaying a box which can be cycled through various
/// checked states.
///
#[derive(Component)]
pub struct Checkbox {
    co: Cell<newtComponent>,
    added_to_parent: Cell<bool>
}

impl Checkbox {
    ///
    /// Create a new `Checkbox` widget.
    ///
    /// * `left` - The left-most position of the `Checkbox`.
    /// * `top` - The top-most position of the `Checkbox`.
    /// * `text` - The label to be displayed with the `Checkbox`.
    /// * `default` - The optional default state of the `Checkbox`.
    ///   (The default value to be held from the sequence of possible values).
    /// * `sequence` - The optional sequence of values possible in the
    ///   `Checkbox`. (Defaults to ` ` and `*` if not provided).
    ///
    pub fn new(left: i32, top: i32, text: &str, default: Option<char>,
               sequence: Option<&[char]>)
      -> Checkbox {
        let c_text = CString::new(text).unwrap();
        let default: c_char = match default {
            Some(value) => char_to_c_char(value),
            None        => 0
        };

        let cstr: CString;
        let c_seq = match sequence {
            Some(seq) => {
                cstr = char_slice_to_cstring(seq);
                cstr.as_ptr()
            },
            None => ptr::null()
        };

        unsafe {
            let co = newtCheckbox(left,
                top,
                c_text.as_ptr(),
                default,
                c_seq,
                ptr::null_mut()
            );

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

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

    ///
    /// Get the current value of the `Checkbox`.
    ///
    pub fn get_value(&self) -> char {
        unsafe { newtCheckboxGetValue(self.co()) as u8 as char }
    }

    ///
    /// Set the current value of the `Checkbox`.
    ///
    /// * `value` - The value to set the `Checkbox` to. It does not necessarily
    ///   need to be one specified in `sequence` during the `Checkbox`
    ///   creation.
    ///
    pub fn set_value(&self, value: char) {
        unsafe { newtCheckboxSetValue(self.co(), char_to_c_char(value)); }
    }

    ///
    /// Set flags modifying the `Checkbox` behavior.
    ///
    /// See [flags][flags] for possible flags.
    ///
    /// * `flags` - A logical `or`ed list of flags.
    /// * `sense` - The operation used to set the flags
    ///   (`Set`, `Reset`, or `Toggle`).
    ///
    /// [flags]: crate::constants::flags
    ///
    pub fn set_flags(&self, flags: i32, sense: FlagsSense) {
        unsafe { newtCheckboxSetFlags(self.co(), flags, sense as u32); }
    }
}