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

use crate::prelude::*;
use crate::ui::radiobox::events::EventData;
use super::Type;

#[CustomControl(overwrite=OnPaint+OnDefaultAction+OnKeyPressed+OnMouseEvent+OnSiblingSelected,internal=true)]
pub struct RadioBox {
    caption: Caption,
    selected: bool,
    selected_symbol: Symbol,
    unselected_symbol: Symbol,
    symbol_width: u8,
}

impl RadioBox {
    /// Creates a new RadioBox with the specified caption, layout and initial selected state.
    /// When a radio box is selected, it will notify its parent control to update the selection state of its siblings. 
    /// Usually multiple radioboxes are being used as part of the same parent control (e.g., a panel)
    /// 
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    /// 
    /// let mut panel = Panel::with_type("Radioboxes group",
    ///                                   layout!("x:1,y:1,w:20,h:10"),
    ///                                   panel::Type::Border);
    /// panel.add(RadioBox::new("Select me &1", layout!("x:1,y:1,w:20,h:1"), false));
    /// panel.add(RadioBox::new("Select me &2", layout!("x:1,y:2,w:20,h:1"), false));
    /// panel.add(RadioBox::new("Select me &3", layout!("x:1,y:3,w:20,h:1"), true));
    /// ```
    /// All o the obove radio boxes will be part of the same parent control (the panel).
    /// When one of them is selected, the others will be automatically deselected.
    pub fn new(caption: &str, layout: Layout, selected: bool) -> Self {
        Self::inner_create(caption, layout, selected, Type::Standard, StatusFlags::ThemeType)
    }

    /// Creates a new RadioBox with the specified caption, layout, initial selected state and visual type.
    /// The type parameter determines how the radio box will be displayed when selected and unselected.
    /// 
    /// # Example
    /// ```rust, no_run
    /// use appcui::prelude::*;
    /// 
    /// let mut panel = Panel::with_type("Radioboxes group",
    ///                                  layout!("x:1,y:1,w:20,h:10"),
    ///                                  panel::Type::Border);
    /// panel.add(RadioBox::with_type("Select me &1", layout!("x:1,y:1,w:20,h:1"), false, radiobox::Type::Circle));
    /// panel.add(RadioBox::with_type("Select me &2", layout!("x:1,y:1,w:20,h:1"), false, radiobox::Type::Diamond));
    /// panel.add(RadioBox::with_type("Select me &3", layout!("x:1,y:1,w:20,h:1"), true, radiobox::Type::Ascii));
    /// ```
    pub fn with_type(caption: &str, layout: Layout, selected: bool, radio_type: Type) -> Self {
        Self::inner_create(caption, layout, selected, radio_type, StatusFlags::None)
    }

    fn inner_create(caption: &str, layout: Layout, selected: bool, radio_type: Type, status: StatusFlags) -> Self {
        let ss = Symbol::new(radio_type.selected_symbol());
        let us = Symbol::new(radio_type.unselected_symbol());
        if ss.width() != us.width() {
            panic!("RadioBox: selected and unselected symbols must have the same width (1, 2 or 3 characters)");
        }
        if ss.width() == 0 {
            panic!("RadioBox: selected and unselected symbols must have at least one character");
        }
        let symbol_width = ss.width() + 1;
        let mut rb = RadioBox {
            base: ControlBase::with_status_flags(layout, StatusFlags::Visible | StatusFlags::Enabled | StatusFlags::AcceptInput | status),
            caption: Caption::new(caption, ExtractHotKeyMethod::AltPlusKey),
            selected,
            selected_symbol: ss,
            unselected_symbol: us,
            symbol_width,
        };
        rb.set_size_bounds(5, 1, u16::MAX, u16::MAX);
        let hotkey = rb.caption.hotkey();
        rb.set_hotkey(hotkey);
        rb
    }    

    /// Returns **true** if the radio box is selected, **false** otherwise.
    #[inline(always)]
    pub fn is_selected(&self) -> bool {
        self.selected
    }

    /// Sets the radio box state to selected.
    /// When a radio box is selected, it will notify its parent control to update the selection state of its siblings to **unselected**.
    #[inline(always)]
    pub fn set_selected(&mut self) {
        if self.handle.is_none() {
            return; 
        }
        if let Some(parent) = RuntimeManager::get().get_controls_mut().get(self.parent) {
            parent.base().notify_children_of_selection(self.handle);
        }
    }

    /// Sets the radio box caption. The caption can contain a hotkey, which is indicated by an ampersand (&) before the character.
    pub fn set_caption(&mut self, caption: &str) {
        self.caption.set_text(caption, ExtractHotKeyMethod::AltPlusKey);
        let hotkey = self.caption.hotkey();
        self.set_hotkey(hotkey);
    }
    /// Returns the RadioBox caption.
    #[inline(always)]
    pub fn caption(&self) -> &str {
        self.caption.text()
    }
}
impl OnPaint for RadioBox {
    fn on_paint(&self, surface: &mut Surface, theme: &Theme) {
        let attr_text = match () {
            _ if !self.is_enabled() => theme.text.inactive,
            _ if self.has_focus() => theme.text.focused,
            _ if self.is_mouse_over() => theme.text.hovered,
            _ => theme.text.normal,
        };

        let enabled = self.is_enabled();
        let col_hot_key = if enabled { theme.text.hot_key } else { theme.text.inactive };
        let sz = self.size();

        if sz.width > self.symbol_width as u32 {
            let mut format = TextFormatBuilder::new()
                .position(self.symbol_width as i32, 0)
                .attribute(attr_text)
                .align(TextAlignment::Left)
                .chars_count(self.caption.chars_count() as u16)
                .build();
            if sz.height > 1 {
                format.set_wrap_type(WrapType::WordWrap(sz.width as u16 - self.symbol_width as u16));
            }
            if self.caption.has_hotkey() {
                format.set_hotkey(col_hot_key, self.caption.hotkey_pos().unwrap() as u32);
            }
            surface.write_text(self.caption.text(), &format);
        }
        if self.selected {
            let attr_symbol = if enabled { theme.symbol.checked } else { theme.symbol.inactive };
            let attr_margin = if self.symbol_width == 4 { attr_text } else { attr_symbol };
            self.selected_symbol.paint(surface, 0, 0, attr_margin, attr_symbol, attr_margin);
        } else {
            let attr_symbol = if enabled { theme.symbol.unchecked } else { theme.symbol.inactive };
            let attr_margin = if self.symbol_width == 4 { attr_text } else { attr_symbol };
            self.unselected_symbol.paint(surface, 0, 0, attr_margin, attr_symbol, attr_margin);
        }
        if self.has_focus() {
            surface.set_cursor(if self.symbol_width == 4 { 1 } else { 0 }, 0);
        }
    }
}
impl OnDefaultAction for RadioBox {
    fn on_default_action(&mut self) {
        self.set_selected();
        self.raise_event(ControlEvent {
            emitter: self.handle,
            receiver: self.event_processor,
            data: ControlEventData::RadioBox(EventData {}),
        });
    }
}
impl OnKeyPressed for RadioBox {
    fn on_key_pressed(&mut self, key: Key, _character: char) -> EventProcessStatus {
        if (key.modifier == KeyModifier::None) && ((key.code == KeyCode::Space) || (key.code == KeyCode::Enter)) {
            self.on_default_action();
            return EventProcessStatus::Processed;
        }
        EventProcessStatus::Ignored
    }
}
impl OnMouseEvent for RadioBox {
    fn on_mouse_event(&mut self, event: &MouseEvent) -> EventProcessStatus {
        match event {
            MouseEvent::Enter => {
                if self.caption.chars_count() > (self.size().width - 4) as usize {
                    self.show_tooltip(self.caption.text());
                }
                EventProcessStatus::Processed
            }
            MouseEvent::Leave => EventProcessStatus::Processed,
            MouseEvent::Released(data) => {
                if self.is_coord_in_control(data.x, data.y) {
                    self.on_default_action();
                }
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}
impl OnSiblingSelected for RadioBox {
    #[allow(private_interfaces)]
    fn on_sibling_selected(&mut self, handle: Handle<()>) {
        self.selected = self.handle == handle;
    }
}