newt 0.6.4

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

//
// Copyright (C) 2019 Robert Gill <locke@sdf.org>
//
// 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::intern::funcs::*;
use newt_sys::*;

///
/// A callback called when a newt `Component` is activated.
///
/// ## Example
/// ```rust no_run
/// extern crate newt;
/// use newt::Callback;
/// use newt::prelude::*;
///
/// pub fn main() {
///     newt::init().unwrap();
///     newt::cls();
///     newt::centered_window(20, 6, Some("Callback Test")).unwrap();
///
///     let cb1 = Checkbox::new(3, 1, "Check 1", None, None);
///     let cb2 = Checkbox::new(3, 2, "Check 2", None, None);
///     let ok = CompactButton::new(7, 4, "Ok");
///
///     let mut form = Form::new(None, 0);
///     form.add_components(&[&cb1, &cb2, &ok]).unwrap();
///
///     let mut value: i32 = 0;
///     // Closure `f` borrows `value` as mutable so create a new subscope here
///     // allowing `value` to be borrowed immutably when printing the result later.
///     {
///         // Create closure to be called by Callback
///         let mut f = |_c: &dyn Component, data: Option<&i32>| {
///             value = *data.unwrap();
///         };
///
///         // Create Callback with first Checkbox using `5` as data.
///         let mut callback = Callback::new(&cb1, &mut f, Some(5));
///         // Add second Checkbox using `10` as data.
///         callback.add_component(&cb2, Some(10));
///
///         form.run().unwrap();
///         newt::finished();
///     }
///
///     // `value` will be 0, 5, or 10 depending on the last Checkbox "clicked".
///     println!("value = {}", value);
/// }
/// ```
///
pub struct Callback<'a, FN: 'a, T: 'a>
where FN: FnMut(&dyn Component, Option<&T>)
{
    function: FN,
    components: Vec<(&'a dyn Component, Option<T>)>
}

impl<'a, FN: 'a, T: 'a> Callback<'a, FN, T>
where FN: FnMut(&dyn Component, Option<&T>)
{
    ///
    /// Create a new `Callback` using the function or closure `function` and
    /// associate it with `component`.
    ///
    /// * `component` - The `Component` associated with the callback.
    /// * `function` - The function or closure to call when the
    ///                `Component` is activated.
    /// * `data` - Optional user data to pass to the function.
    ///
    pub fn new(component: &'a dyn Component, function: FN, data: Option<T>)
      -> Box<Callback<'a, FN, T>> {

        let cb = Box::new(Callback {
            function,
            components: vec![(component, data)]
        });
        newt_set_callback(component.co(), cb.as_ref());
        cb
    }

    ///
    /// Associate another component with the `Callback`.
    ///
    /// * `component` - Another `Component` to associate with the callback.
    /// * `data` - Optional user data to pass to the function.
    ///
    pub fn add_component(&mut self, component: &'a dyn Component,
                         data: Option<T>)
    {
        self.components.push((component, data));
        newt_set_callback(component.co(), &self);
    }

    pub(crate) fn call(&mut self, co: newtComponent) {
        for (component, data) in self.components.iter() {
            if component.co() == co {
                (self.function)(*component, data.as_ref());
            }
        }
    }
}

impl<'a, FN: 'a, T: 'a> Drop for Callback<'a, FN, T>
where FN: FnMut(&dyn Component, Option<&T>)
{
    fn drop(&mut self) {
        for (component, _data) in self.components.iter() {
            newt_unset_callback(*component)
        }
    }
}