afrish 0.1.1

A Rust binding for the Tk graphics toolkit, made for building the Afrim IME.
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

//! Label widgets - displays text/image.
//!
//! * also see the Tk [manual](https://www.tcl-lang.org/man/tcl8.6/TkCmd/ttk_label.htm)
//!
//! ## Examples
//!
//! The simplest label has some text:
//!
//! ```ignore
//! let label_1 = afrish::make_label(&root);
//! label_1.text("Label text");
//! ```
//!
//! Labels 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 label with both an image and text is set to show
//! the image below the text:
//!
//! ```ignore
//! let label_3 = afrish::make_label(&root);
//! label_3.image(&read_image("tcllogo.gif"));
//! label_3.text("Tcl Logo");
//! label_3.compound(afrish::Compound::Bottom);
//! ```
//!
//! Labels can also show multi-line text. For this, specify a wrap-length (in pixels):
//!
//! ```ignore
//! let label_7 = afrish::make_label(&root);
//! label_7.wrap_length(300);
//! label_7.text("Rust has great documentation, a friendly compiler with useful error messages, and
//! top-notch tooling - an integrated package manager and build tool, smart multi-editor support
//! with auto-completion and type inspections, an auto-formatter, and more. --
//! https://rust-lang.org");
//! ```
//!

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

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

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

    TkLabel { id }
}

impl widget::TkWidget for TkLabel {
    /// Returns the widget's id reference - used within tk
    fn id(&self) -> &str {
        &self.id
    }
}
impl grid::TkGridLayout for TkLabel {}
impl pack::TkPackLayout for TkLabel {}
impl widget::TkLabelOptions for TkLabel {}

impl TkLabel {
    /// Position of information with respect to internal margins.
    ///
    /// e.g. the space allocated to the label can be larger than its
    /// text needs, so an Anchor value of E (east) will display the
    /// text against the right-margin.
    pub fn anchor(&self, value: widget::Anchor) {
        widget::configure(&self.id, "anchor", &value.to_string());
    }

    /// Specifies the background colour.
    ///
    /// Colours are specified as a string, by either:
    ///
    /// * `name` - using one of the values in the tk [colours](https://tcl.tk/man/tcl8.6/TkCmd/colors.htm) list
    /// * `rgb` - as a 6-digit hexadecimal value in form "#RRGGBB"
    pub fn background(&self, colour: &str) {
        widget::configure(&self.id, "background", colour);
    }

    /// Alignment of text within widget.
    pub fn justify(&self, value: widget::Justify) {
        widget::configure(&self.id, "justify", &value.to_string());
    }

    /// Style of border around label.
    pub fn relief(&self, value: widget::Relief) {
        widget::configure(&self.id, "relief", &value.to_string());
    }

    /// Sets the maximum line length, in pixels.
    /// When set, displayed text is separated into lines, not exceeding
    /// the given length.
    pub fn wrap_length(&self, length: u64) {
        widget::configure(&self.id, "wraplength", &length.to_string());
    }
}