rstk 0.3.0

A Rust binding for the Tk graphics toolkit. Tk is suitable for creating simple GUI programs or interactive graphical displays. This library supports a large portion of the Tk API, in a generally rust-like style.
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

//! Button widget - displays text/image. Executes a command when clicked.
//!
//! * also see the Tk [manual](https://www.tcl-lang.org/man/tcl8.6/TkCmd/ttk_button.htm)
//!
//! ## Examples
//!
//! The simplest button has some text and a command:
//!
//! ```ignore
//! let button_1 = rstk::make_button(&root);
//! button_1.text("Button text");
//! button_1.command(|| { println!("Clicked button_1"); });
//! ```
//! 
//! Buttons can also display images, with or without text, and how these are 
//! displayed can be controlled using [compound](widget::TkLabelOptions::compound).
//! In the following example, a button with both an image and text is set to show 
//! the image below the text:
//!
//! ```ignore
//! let button_3 = rstk::make_button(&root);
//! button_3.image(&read_image("tcllogo.gif"));
//! button_3.text("Tcl Logo");
//! button_3.command(|| { println!("Clicked button_3"); });
//! button_3.compound(rstk::Compound::Bottom);
//! ```
//! 

use super::grid;
use super::pack;
use super::widget;
use super::wish;

/// Refers to a button widget
#[derive(Clone, Debug, PartialEq)]
pub struct TkButton {
    pub id: String,
}

/// Creates an instance of a button widget in given parent.
pub fn make_button(parent: &impl widget::TkWidget) -> TkButton {
    let id = wish::next_wid(parent.id());
    let msg = format!("ttk::button {}", id);
    wish::tell_wish(&msg);

    TkButton { id }
}

impl widget::TkWidget for TkButton {
    /// Returns the widget's id reference - used within tk
    fn id(&self) -> &str {
        &self.id
    }
}

impl grid::TkGridLayout for TkButton {}
impl pack::TkPackLayout for TkButton {}

impl widget::TkLabelOptions for TkButton {}

impl TkButton {
    /// Sets the function to be called when the button is clicked.
    pub fn command(&self, command: impl Fn() + Send + 'static) {
        wish::add_callback0(&self.id, wish::mk_callback0(command));
        let msg = format!(
            "{} configure -command {{ puts clicked-{} ; flush stdout }}",
            self.id, self.id
        );
        wish::tell_wish(&msg);
    }

    /// Calls the button's command as if it were clicked.
    pub fn invoke(&self) {
        let msg = format!("{} invoke", self.id);
        wish::tell_wish(&msg);
    }

    /// Sets the state of the button, usually normal (clickable) 
    /// or disabled (unclickable).
    pub fn state(&self, value: widget::State) {
        widget::configure(&self.id, "state", &value.to_string());
    }
}