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

use crate::backend;
use crate::graphics::*;
use crate::system::*;
use crate::ui::common::traits::*;
use crate::ui::common::*;

pub struct Builder {
    pub(crate) size: Option<Size>,
    pub(crate) backend: Option<backend::Type>,
    pub(crate) debug_script: Option<String>,
    pub(crate) title: Option<String>,
    pub(crate) desktop_manager: Option<ControlManager>,
    pub(crate) has_app_bar: bool,
    pub(crate) has_command_bar: bool,
    pub(crate) single_window: bool,
    pub(crate) theme: Theme,
    pub(crate) max_timer_count: u8,
    pub(crate) log_file: Option<String>,
    pub(crate) log_append: bool,
    pub(crate) use_color_schema: bool,
    pub(crate) restore_screen: bool,
}
impl Builder {
    pub(crate) fn new() -> Self {
        Self {
            size: None,
            title: None,
            backend: None,
            debug_script: None,
            desktop_manager: None,
            has_app_bar: false,
            has_command_bar: false,
            single_window: false,
            max_timer_count: 4,
            theme: Theme::new(Themes::Default),
            log_file: None,
            log_append: false,
            use_color_schema: true,
            restore_screen: true,
        }
    }
    /// Builds the application using the current settings.
    #[inline(always)]
    pub fn build(self) -> Result<App, Error> {
        App::create(self)
    }
    /// Sets the size of the terminal.
    #[inline(always)]
    pub fn size(mut self, terminal_size: Size) -> Self {
        self.size = Some(terminal_size);
        self
    }
    /// Sets the title of the application.
    #[inline(always)]
    pub fn title(mut self, title: &str) -> Self {
        self.title = Some(String::from(title));
        self
    }
    /// Enables the Application bar.
    #[inline(always)]
    pub fn app_bar(mut self) -> Self {
        self.has_app_bar = true;
        self
    }
    /// Enables the command bar.
    #[inline(always)]
    pub fn command_bar(mut self) -> Self {
        self.has_command_bar = true;
        self
    }
    /// Enables the single window mode.
    #[inline(always)]
    pub fn single_window(mut self) -> Self {
        self.single_window = true;
        self
    }
    /// Sets the desktop manager.
    #[inline(always)]
    pub fn desktop<T>(mut self, desktop: T) -> Self
    where
        T: Control + DesktopControl + 'static,
    {
        self.desktop_manager = Some(ControlManager::new(desktop));
        self
    }
    /// Sets the theme of the application. If not specified, the default theme will be used.
    #[inline(always)]
    pub fn theme(mut self, theme: Theme) -> Self {
        self.theme = theme;
        self
    }
    /// Sets the number of timers that can be used in the application.
    #[inline(always)]
    pub fn timers_count(mut self, count: u8) -> Self {
        self.max_timer_count = count.max(1); // at least one timer
        self
    }
    /// Sets the log file where logs will be displayed. This option is used only in debug mode.
    #[inline(always)]
    pub fn log_file(mut self, name: &str, append: bool) -> Self {
        self.log_file = Some(String::from(name));
        self.log_append = append;
        self
    }
    /// Enables or disables the use of the terminal color schema.
    #[inline(always)]
    pub fn color_schema(mut self, enabled: bool) -> Self {
        self.use_color_schema = enabled;
        self
    }

    /// If enabled the backend will attempt to restore the original screen content and cursor position when the application ends.
    /// If disabled, when the application ends the screen will be cleared.
    /// By default this option is set.
    /// 
    /// **Remarks:** Not all backends have the support to restore the original screen (for those that do not have this support, the screen will always be cleared when application ends).
    #[inline(always)]
    pub fn restore_screen(mut self, enable: bool) -> Self {
        self.restore_screen = enable;
        self
    }
}