appcui 0.4.8

A feature-rich and cross-platform TUI/CUI framework for Rust, enabling modern terminal-based applications on Windows, Linux, and macOS. Includes built-in UI components like buttons, menus, list views, tree views, checkboxes, and more. Perfect for building fast and interactive CLI tools and text-based interfaces.
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

use super::{ItemBase, Side};
use crate::graphics::*;
use crate::system::Theme;

/// A label in the app bar.
/// 
/// # Examples
/// 
/// ```rust, no_run
/// use appcui::prelude::*;
/// 
/// let label = appbar::Label::new("Label", 0, appbar::Side::Left);
/// ```
pub struct Label {
    text: String,
    desc: String,
    pub(super) base: ItemBase,
}

impl Label {
    const MAX_CAPTION_SIZE: usize = 128; // must be smaller than 255 (u8::MAX)
    /// Creates a new label with the specified caption, order and position.
    /// 
    /// # Parameters
    /// 
    /// * `caption` - The caption of the label. If the caption is longer than 128 characters, it will be truncated.
    /// * `order` - The order of the label (a number that determines the order of the label in the app bar - lower numbers are displayed first from either **left** or **right** depending on the **pos** parameter)
    /// * `pos` - The position of the label (`Left` or `Right`)
    /// 
    /// # Example
    /// 
    /// ```rust, no_run
    /// use appcui::prelude::*;
    /// 
    /// let label = appbar::Label::new("Label", 0, appbar::Side::Left);
    /// ```
    pub fn new(caption: &str, order: u8, pos: Side) -> Self {
        let width = caption.chars().count();
        let s = if width > Label::MAX_CAPTION_SIZE {
            caption.chars().take(Label::MAX_CAPTION_SIZE).collect()
        } else {
            caption.to_string()
        };
        Self {
            text: s,
            desc: String::new(),
            base: ItemBase::new(width.min(Label::MAX_CAPTION_SIZE) as u8, order, pos, false),
        }
    }
    
    /// Returns the caption of the label.
    #[inline(always)]
    pub fn caption(&self) -> &str {
        self.text.as_str()
    }
    
    /// Sets the caption of the label. If the caption is longer than 128 characters, it will be truncated.
    #[inline(always)]
    pub fn set_caption(&mut self, text: &str) {
        self.text.clear();
        self.text.push_str(text);
        let mut width = 0;
        let mut tpos = None;
        for (pos, _) in self.text.char_indices() {
            if pos >= Label::MAX_CAPTION_SIZE {
                tpos = Some(pos);
                break;
            }
            width += 1;
        }
        if let Some(tp) = tpos {
            self.text.truncate(tp);
        }
        //let orig_width = self.base.width();
        self.base.set_width(width as u8);
        self.base.refresh();
    }
   
    /// Returns the tooltip of the label.
    #[inline(always)]
    pub fn tooltip(&self) -> &str {
        &self.desc
    }
    
    /// Sets the tooltip of the label.
    #[inline(always)]
    pub fn set_tooltip(&mut self, text: &str) {
        if self.desc != text {
            self.desc.clear();
            self.desc.push_str(text);
            self.base.refresh();
        }
    }
    pub(super) fn paint(&self, surface: &mut Surface, theme: &Theme) {
        surface.write_string(self.base.x(), 0, &self.text, theme.menu.text.normal, false);
    }
}