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
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

use crate::prelude::*;
use crate::ui::panel::Type;

#[CustomControl(overwrite=OnPaint, internal=true)]
pub struct Panel {
    caption: Caption,
    panel_type: Type,
}
impl Panel {
    /// Creates a new Panel control with the specified caption and layout.
    /// The type of the panel will be obtained from the current theme.
    ///
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    ///
    /// let mut panel = Panel::new("Panel",
    ///                            layout!("x:1,y:1,w:20,h:10"));
    /// ```
    pub fn new(caption: &str, layout: Layout) -> Self {
        Self::inner_create(caption, layout, Type::Border, StatusFlags::ThemeType)
    }
    /// Creates a new Panel control with the specified caption, layout and type.
    /// The panel type is one of the following values:
    /// * `Type::Border` - a panel with a border around it
    /// * `Type::Window` - a panel with a border around it and a title bar
    /// * `Type::Page` - a panel without a border, used to group controls
    /// * `Type::TopBar` - a panel without a border, used to group controls and to display a title bar
    /// * `Type::Raised` - a panel with a 3D raised border
    /// * `Type::Sunken` - a panel with a 3D sunken border
    ///
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    ///
    /// let mut panel = Panel::with_type("Panel",
    ///                                  layout!("x:1,y:1,w:20,h:10"),
    ///                                  panel::Type::Border);
    /// ```
    pub fn with_type(caption: &str, layout: Layout, panel_type: Type) -> Self {
        Self::inner_create(caption, layout, panel_type, StatusFlags::None)
    }

    pub fn inner_create(caption: &str, layout: Layout, panel_type: Type, status: StatusFlags) -> Self {
        let mut panel = Panel {
            base: ControlBase::with_status_flags(layout, StatusFlags::Visible | StatusFlags::Enabled | status),
            caption: Caption::new(caption, ExtractHotKeyMethod::NoHotKey),
            panel_type,
        };
        panel.update_margins();
        panel
    }

    fn update_margins(&mut self) {
        match self.panel_type {
            Type::Border => self.base.set_margins(1, 1, 1, 1),
            Type::Window => self.base.set_margins(1, 1, 1, 1),
            Type::Page => self.base.set_margins(0, 0, 0, 0),
            Type::TopBar => self.base.set_margins(0, 1, 0, 0),
            Type::Raised => self.base.set_margins(1, 1, 1, 1),
            Type::Sunken => self.base.set_margins(1, 1, 1, 1),
        }
    }

    /// Sets the title of the panel. The title is displayed only if the panel type is `Type::Window` , `Type::TopBar` or
    pub fn set_title(&mut self, text: &str) {
        self.caption.set_text(text, ExtractHotKeyMethod::NoHotKey);
    }

    /// Returns the title of the panel
    #[inline(always)]
    pub fn title(&self) -> &str {
        self.caption.text()
    }

    /// Returns the type of the panel
    #[inline(always)]
    pub fn panel_type(&self) -> Type {
        self.panel_type
    }

    /// Adds a new control to the panel. The control will be added as a child of the panel and will be automatically removed when the panel is destroyed.
    /// Returns a handle to the newly created control.
    ///
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    ///
    /// let mut panel = Panel::new("Panel", layout!("x:1,y:1,w:10,h:10"));
    /// let handle_button = panel.add(Button::new("Button", layout!("x:1,y:1,w:8")));
    /// ```
    #[inline(always)]
    pub fn add<T>(&mut self, control: T) -> Handle<T>
    where
        T: Control + NotWindow + NotDesktop + 'static,
    {
        self.add_child(control)
    }
    #[inline(always)]
    fn paint_border(&self, surface: &mut Surface, theme: &Theme) {
        let sz = self.size();
        let border_color = if self.is_enabled() { theme.border.normal } else { theme.border.inactive };
        surface.clear(Character::with_char(' '));
        surface.draw_rect(Rect::with_point_and_size(Point::ORIGIN, sz), LineType::Single, border_color);
        let chars_count = self.caption.chars_count();
        if (chars_count > 0) && (sz.width > 7) {
            let format = TextFormatBuilder::new()
                .position(3, 0)
                .attribute(if self.is_enabled() { theme.text.normal } else { theme.text.inactive })
                .align(TextAlignment::Left)
                .wrap_type(WrapType::SingleLineWrap((sz.width - 6) as u16))
                .chars_count(chars_count as u16)
                .build();
            surface.write_text(self.caption.text(), &format);
            surface.write_char(2, 0, Character::with_char(' '));
            if chars_count > (sz.width - 6) as usize {
                surface.write_char((sz.width - 3) as i32, 0, Character::with_char(' '));
                surface.write_char((sz.width - 4) as i32, 0, Character::with_char(SpecialChar::ThreePointsHorizontal));
            } else {
                surface.write_char(3 + chars_count as i32, 0, Character::with_char(' '));
            }
        }
    }
    #[inline(always)]
    fn paint_window(&self, surface: &mut Surface, theme: &Theme) {
        let sz = self.size();
        let border_color = if self.is_enabled() { theme.border.normal } else { theme.border.inactive };
        surface.clear(Character::with_char(' '));
        surface.draw_rect(Rect::with_point_and_size(Point::ORIGIN, sz), LineType::Single, border_color);
        let chars_count = self.caption.chars_count();
        if (chars_count > 0) && (sz.width > 7) {
            let mut format = TextFormatBuilder::new()
                .position(3, 0)
                .attribute(if self.is_enabled() { theme.text.normal } else { theme.text.inactive })
                .align(TextAlignment::Left)
                .wrap_type(WrapType::SingleLineWrap((sz.width - 6) as u16))
                .chars_count(chars_count as u16)
                .build();

            if chars_count > (sz.width - 6) as usize {
                surface.write_text(self.caption.text(), &format);
                surface.write_char(2, 0, Character::with_char(' '));
                surface.write_char((sz.width - 3) as i32, 0, Character::with_char(' '));
                surface.write_char((sz.width - 4) as i32, 0, Character::with_char(SpecialChar::ThreePointsHorizontal));
            } else {
                let x = ((sz.width / 2) as i32) - ((chars_count + 2) as i32) / 2;
                format.x = x + 1;
                surface.write_text(self.caption.text(), &format);
                surface.write_char(x, 0, Character::with_char(' '));
                surface.write_char(x + 1 + chars_count as i32, 0, Character::with_char(' '));
            }
        }
    }
    #[inline(always)]
    fn paint_page(&self, surface: &mut Surface, theme: &Theme) {
        // title si ignored
        if self.is_enabled() {
            surface.clear(Character::with_attributes(' ', theme.tab.text.pressed_or_selected));
        } else {
            surface.clear(Character::with_char(' '));
        }
    }
    #[inline(always)]
    fn paint_topbar(&self, surface: &mut Surface, theme: &Theme) {
        let sz = self.size();
        if self.is_enabled() {
            surface.clear(Character::with_attributes(' ', theme.tab.text.pressed_or_selected));
            surface.fill_horizontal_line(0, 0, sz.width as i32, Character::with_attributes(' ', theme.tab.text.normal))
        } else {
            surface.clear(Character::with_char(' '));
        }
        let chars_count = self.caption.chars_count();
        if (chars_count > 0) && (sz.width > 7) {
            let mut format = TextFormatBuilder::new()
                .position(3, 0)
                .attribute(if self.is_enabled() { theme.tab.text.normal } else { theme.text.inactive })
                .align(TextAlignment::Left)
                .wrap_type(WrapType::SingleLineWrap((sz.width - 6) as u16))
                .chars_count(chars_count as u16)
                .build();
            if chars_count > (sz.width - 6) as usize {
                surface.write_text(self.caption.text(), &format);
                surface.write_char(2, 0, Character::with_char(' '));
                surface.write_char((sz.width - 3) as i32, 0, Character::with_char(' '));
                surface.write_char((sz.width - 4) as i32, 0, Character::with_char(SpecialChar::ThreePointsHorizontal));
            } else {
                let x = ((sz.width / 2) as i32) - ((chars_count + 2) as i32) / 2;
                format.x = x + 1;
                surface.write_text(self.caption.text(), &format);
                surface.write_char(x, 0, Character::with_char(' '));
                surface.write_char(x + 1 + chars_count as i32, 0, Character::with_char(' '));
            }
        }
    }
    #[inline(always)]
    fn paint_3d_bar(&self, surface: &mut Surface, theme: &Theme, line_type: LineType, raised: bool) {
        let sz = self.size();
        let enabled = self.is_enabled();
        let attr = if enabled { theme.border.normal } else { theme.border.inactive };
        let r = Rect::with_point_and_size(Point::ORIGIN, sz);
        surface.clear(Character::with_char(' '));
        if enabled {
            surface.draw_bevel_rect(r, line_type, theme.button.bevel.dark_margin, theme.button.bevel.light_margin, raised);
        } else {
            surface.draw_rect(r, line_type, attr);
        }
        let chars_count = self.caption.chars_count();
        if (chars_count > 0) && (sz.width > 7) {
            let format = TextFormatBuilder::new()
                .position(3, 0)
                .attribute(if self.is_enabled() { theme.text.normal } else { theme.text.inactive })
                .align(TextAlignment::Left)
                .wrap_type(WrapType::SingleLineWrap((sz.width - 6) as u16))
                .chars_count(chars_count as u16)
                .build();
            surface.write_text(self.caption.text(), &format);
            surface.write_char(2, 0, Character::with_char(' '));
            if chars_count > (sz.width - 6) as usize {
                surface.write_char((sz.width - 3) as i32, 0, Character::with_char(' '));
                surface.write_char((sz.width - 4) as i32, 0, Character::with_char(SpecialChar::ThreePointsHorizontal));
            } else {
                surface.write_char(3 + chars_count as i32, 0, Character::with_char(' '));
            }
        }
    }
}
impl OnPaint for Panel {
    fn on_paint(&self, surface: &mut Surface, theme: &Theme) {
        match self.panel_type {
            Type::Border => self.paint_border(surface, theme),
            Type::Window => self.paint_window(surface, theme),
            Type::Page => self.paint_page(surface, theme),
            Type::TopBar => self.paint_topbar(surface, theme),
            Type::Raised => self.paint_3d_bar(surface, theme, LineType::Single, true),
            Type::Sunken => self.paint_3d_bar(surface, theme, LineType::Single, false),
        }
    }
}