appcui/ui/button/

button.rs

use crate::prelude::*;
use crate::ui::button::{events::EventData, Type};

#[CustomControl(overwrite=OnPaint+OnDefaultAction+OnKeyPressed+OnMouseEvent, internal=true)]
pub struct Button {
    button_type: Type,
    caption: Caption,
    pressed: bool,
}
impl Button {
    /// Creates a new button with the specified caption and layout. The type of the button will be determined from the current theme.
    ///
    /// # Examples
    /// ```rust,no_run
    /// use appcui::prelude::*;
    ///
    /// let mut button = Button::new("Click me!",
    ///                              LayoutBuilder::new().x(1).y(1).width(15).build());
    /// ```
    pub fn new(caption: &str, layout: Layout) -> Self {
        Self::inner_create(caption, layout, button::Type::Normal, StatusFlags::ThemeType)
    }
    /// Creates a new button with the specified caption, layout and flags
    /// # Examples
    /// ```rust,no_run
    /// use appcui::prelude::*;
    /// let mut button = Button::with_type("Click me!", layout!("x:1,y:1,w:15"), button::Type::Normal);
    /// ```
    pub fn with_type(caption: &str, layout: Layout, button_type: Type) -> Self {
        Self::inner_create(caption, layout, button_type, StatusFlags::None)
    }

    fn inner_create(caption: &str, layout: Layout, button_type: Type, status: StatusFlags) -> Self {
        let mut but = Button {
            base: ControlBase::with_status_flags(layout, StatusFlags::Visible | StatusFlags::Enabled | StatusFlags::AcceptInput | status),
            caption: Caption::new(caption, ExtractHotKeyMethod::AltPlusKey),
            button_type,
            pressed: false,
        };
        but.update_bounds_limits();
        let hotkey = but.caption.hotkey();
        but.set_hotkey(hotkey);
        but
    }

    fn update_bounds_limits(&mut self) {
        let (min_w, min_h) = match self.button_type {
            Type::Normal => (4, 2),
            Type::Flat => (3, 1),
            Type::Raised => (5, 3),
        };
        self.set_size_bounds(min_w, min_h, u16::MAX, min_h);
    }

    /// Sets the caption of a button. Using `&` in the provided text followed by a letter or a number will automatically assign Alt+**<number|letter>** hotkey to that button.
    /// # Examples
    /// ```rust,no_run
    /// use appcui::prelude::*;
    /// let mut button = button!("one,x:1,y:1,w:15"); // the caption is `one`
    /// button.set_caption("&two");   // now the caption is `two` and Alt+T is a hotkey
    /// button.set_caption("three");  // caption is `three`, and no hot-key
    /// ```
    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 button caption.
    pub fn caption(&self) -> &str {
        self.caption.text()
    }

    fn paint_normal(&self, surface: &mut Surface, theme: &Theme) {
        let col_text = match () {
            _ if !self.is_enabled() => theme.button.regular.text.inactive,
            _ if self.has_focus() => theme.button.regular.text.focused,
            _ if self.is_mouse_over() => theme.button.regular.text.hovered,
            _ => theme.button.regular.text.normal,
        };
        let w = self.size().width.saturating_sub(1);
        let x = (w / 2) as i32;
        let mut format = TextFormatBuilder::new()
            .position(x, 0)
            .attribute(col_text)
            .align(TextAlignment::Center)
            .chars_count(self.caption.chars_count() as u16)
            .wrap_type(WrapType::SingleLineWrap(w as u16))
            .build();

        if self.caption.has_hotkey() {
            format.set_hotkey(
                match () {
                    _ if !self.is_enabled() => theme.button.regular.hotkey.inactive,
                    _ if self.has_focus() => theme.button.regular.hotkey.focused,
                    _ if self.is_mouse_over() => theme.button.regular.hotkey.hovered,
                    _ => theme.button.regular.hotkey.normal,
                },
                self.caption.hotkey_pos().unwrap() as u32,
            );
        }
        if self.pressed {
            surface.fill_horizontal_line_with_size(1, 0, w, Character::with_attributes(' ', col_text));
            format.x += 1;
            surface.write_text(self.caption.text(), &format);
        } else {
            surface.fill_horizontal_line_with_size(0, 0, w, Character::with_attributes(' ', col_text));
            surface.write_text(self.caption.text(), &format);
            surface.fill_horizontal_line_with_size(
                1,
                1,
                w,
                Character::with_attributes(SpecialChar::BlockUpperHalf, theme.button.regular.shadow),
            );
            surface.write_char(
                w as i32,
                0,
                Character::with_attributes(SpecialChar::BlockLowerHalf, theme.button.regular.shadow),
            );
        }
    }
    fn paint_flat(&self, surface: &mut Surface, theme: &Theme) {
        let col_text = match () {
            _ if !self.is_enabled() => theme.button.regular.text.inactive,
            _ if self.has_focus() => theme.button.regular.text.focused,
            _ if self.is_mouse_over() => theme.button.regular.text.hovered,
            _ => theme.button.regular.text.normal,
        };
        let w = self.size().width;
        let x = (w / 2) as i32;
        let mut format = TextFormatBuilder::new()
            .position(x, 0)
            .attribute(col_text)
            .align(TextAlignment::Center)
            .chars_count(self.caption.chars_count() as u16)
            .wrap_type(WrapType::SingleLineWrap(w as u16))
            .build();

        if self.caption.has_hotkey() {
            format.set_hotkey(
                match () {
                    _ if !self.is_enabled() => theme.button.regular.hotkey.inactive,
                    _ if self.has_focus() => theme.button.regular.hotkey.focused,
                    _ if self.is_mouse_over() => theme.button.regular.hotkey.hovered,
                    _ => theme.button.regular.hotkey.normal,
                },
                self.caption.hotkey_pos().unwrap() as u32,
            );
        }
        surface.clear(Character::with_attributes(' ', col_text));
        surface.write_text(self.caption.text(), &format);
    }
    fn paint_raised(&self, surface: &mut Surface, theme: &Theme) {
        let enabled = self.is_enabled();
        let focus = self.has_focus();
        let col_text = match () {
            _ if !enabled => theme.button.bevel.text.inactive,
            _ if self.pressed => theme.button.bevel.text.pressed_or_selected,
            _ if focus => theme.button.bevel.text.focused,
            _ if self.is_mouse_over() => theme.button.bevel.text.hovered,
            _ => theme.button.bevel.text.normal,
        };
        let w = self.size().width;
        let x = (w / 2) as i32 + if self.pressed { 1 } else { 0 };
        let mut format = TextFormatBuilder::new()
            .position(x, 1)
            .attribute(col_text)
            .align(TextAlignment::Center)
            .chars_count(self.caption.chars_count() as u16)
            .wrap_type(WrapType::SingleLineWrap((w as u16).saturating_sub(2)))
            .build();

        if self.caption.has_hotkey() {
            format.set_hotkey(
                match () {
                    _ if !enabled => theme.button.bevel.hotkey.inactive,
                    _ if self.pressed => theme.button.bevel.hotkey.pressed_or_selected,
                    _ if focus => theme.button.bevel.hotkey.focused,
                    _ if self.is_mouse_over() => theme.button.bevel.hotkey.hovered,
                    _ => theme.button.bevel.hotkey.normal,
                },
                self.caption.hotkey_pos().unwrap() as u32,
            );
        }
        surface.write_text(self.caption.text(), &format);
        let r = Rect::with_point_and_size(Point::ORIGIN, self.size());
        if enabled {
            surface.draw_bevel_rect(
                r,
                LineType::SingleRound,
                theme.button.bevel.dark_margin,
                theme.button.bevel.light_margin,
                !self.pressed,
            );
        } else {
            surface.draw_rect(r, LineType::SingleRound, theme.button.bevel.text.inactive);
        }
    }
}
impl OnDefaultAction for Button {
    fn on_default_action(&mut self) {
        self.raise_event(ControlEvent {
            emitter: self.handle,
            receiver: self.event_processor,
            data: ControlEventData::Button(EventData {}),
        });
    }
}
impl OnKeyPressed for Button {
    fn on_key_pressed(&mut self, key: Key, _character: char) -> EventProcessStatus {
        match key.value() {
            key!("Space") | key!("Enter") => {
                self.on_default_action();
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}

impl OnPaint for Button {
    fn on_paint(&self, surface: &mut Surface, theme: &Theme) {
        match self.button_type {
            Type::Normal => self.paint_normal(surface, theme),
            Type::Flat => self.paint_flat(surface, theme),
            Type::Raised => self.paint_raised(surface, theme),
        }
    }
}
impl OnMouseEvent for Button {
    fn on_mouse_event(&mut self, event: &MouseEvent) -> EventProcessStatus {
        match event {
            MouseEvent::Enter => {
                if self.caption.chars_count() > (self.size().width - 2) as usize {
                    self.show_tooltip(self.caption.text());
                }
                EventProcessStatus::Processed
            }
            MouseEvent::Leave => EventProcessStatus::Processed,
            MouseEvent::Released(data) => {
                self.pressed = false;
                if self.is_coord_in_control(data.x, data.y) {
                    self.on_default_action();
                }
                EventProcessStatus::Processed
            }
            MouseEvent::Drag(data) => {
                if self.pressed && (!self.is_coord_in_control(data.x, data.y)) {
                    self.pressed = false;
                    return EventProcessStatus::Processed;
                }
                EventProcessStatus::Ignored
            }
            MouseEvent::Pressed(_) => {
                self.pressed = true;
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}