Struct Button

pub struct Button { /* private fields */ }

Creates a normal button

Implementations

impl Button

pub fn new<'a, T: Into<Option<&'a str>>>( x: i32, y: i32, width: i32, height: i32, title: T, ) -> Button

Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title

Arguments

• x - The x coordinate in the screen
• y - The y coordinate in the screen
• width - The width of the widget
• heigth - The height of the widget
• title - The title or label of the widget

To use dynamic strings use with_label(self, &str) or set_label(&mut self, &str). labels support special symbols preceded by an @ sign and for the associated formatting.

Examples found in repository

examples/hello_button.rs (line 7)

fn main() {
    let app = app::App::default();
    let mut wind = Window::default().with_size(400, 300);
    let mut frame = Frame::default().with_size(200, 100).center_of(&wind);
    let mut but = Button::new(160, 210, 80, 40, "Click me!");
    wind.end();
    wind.show();

    but.set_callback(move |_| frame.set_label("Hello world"));

    app.run().unwrap();
}

examples/widget_table.rs (line 18)

fn main() {
    let a = app::App::default();
    let mut win = window::Window::default().with_size(500, 400);
    let mut table = table::Table::default()
        .with_size(400, 130)
        .center_of_parent();
    table.set_frame(enums::FrameType::NoBox);
    table.set_scrollbar_size(-1);
    table.set_rows(5);
    table.set_cols(5);
    for i in 0..5 {
        for j in 0..5 {
            if let Some((x, y, w, h)) = table.find_cell(table::TableContext::Cell, i, j) {
                button::Button::new(x, y, w, h, None).with_label(&(i + j).to_string());
            }
        }
    }
    table.end();
    win.end();
    win.show();
    a.run().unwrap();
}

examples/closable_tabs2.rs (line 23)

    fn create_tab_button(label: &str) -> group::Group {
        let mut grp = group::Group::new(0, 0, 150, 40, None);
        grp.set_align(Align::Left | Align::Inside);
        let mut but_handle = button::Button::new(grp.x() + 5, grp.y() + 5, 110, 30, "");
        but_handle.set_align(Align::Left | Align::Inside);
        but_handle.set_label(label);
        let mut but_close = button::Button::new(grp.x() + 120, grp.y() + 10, 20, 20, "@1+");
        but_handle.set_frame(FrameType::FlatBox);
        but_handle.clear_visible_focus();
        but_close.set_frame(FrameType::FlatBox);
        grp.end();
        grp.set_frame(FrameType::UpFrame);
        grp
    }

    // Public
    pub struct ClosableTab<'a> {
        current: Option<i32>, // The tab which is visible on the foreground
        snd: &'a app::Sender<Message>,
        contents: group::Group,
        tab_labels: group::Pack,
    }

    impl<'a> ClosableTab<'a> {
        pub fn new(x: i32, y: i32, w: i32, h: i32, snd: &'a app::Sender<Message>) -> Self {
            let current = None;
            let parent_grp = group::Group::new(x, y, w, h, None);
            let mut tab_labels = group::Pack::new(x + 5, y, w - 10, 40, None);
            tab_labels.set_spacing(3);
            tab_labels.set_type(group::PackType::Horizontal);
            tab_labels.end();
            let mut contents = group::Group::new(x, y + 40, w, h - 40, None);
            contents.set_frame(FrameType::NoBox);
            contents.end();
            parent_grp.end();
            Self {
                current,
                snd,
                contents,
                tab_labels,
            }
        }

        pub fn add(&mut self, child: &mut group::Group, label: &str) {
            child.resize(
                self.contents.x(),
                self.contents.y(),
                self.contents.w(),
                self.contents.h(),
            );
            self.contents.add(child);
            let but = create_tab_button(label);
            self.tab_labels.add(&but);
            but.child(1).unwrap().set_callback({
                let curr_child = child.clone();
                let contents = self.contents.clone();
                let sndb = *self.snd;
                move |_| {
                    let idx = contents.find(&curr_child);
                    sndb.send(Message::Delete(idx));
                    app::redraw();
                }
            });
            but.child(0).unwrap().set_callback({
                let curr_child = child.clone();
                let contents = self.contents.clone();
                let sndb = *self.snd;
                move |_| {
                    let idx = contents.find(&curr_child);
                    sndb.send(Message::Foreground(idx));
                    app::redraw();
                }
            });
        }

        pub fn remove(&mut self, idx: i32) {
            self.contents.remove_by_index(idx);
            self.tab_labels.remove_by_index(idx);
            if self.current == Some(idx) {
                if idx > 1 {
                    self.set_foreground(idx - 1);
                } else if self.contents.children() > 0 {
                    self.set_foreground(0);
                }
            }
        }

        /** No return variable, fails silently */
        pub fn set_foreground(&mut self, fg_idx: i32) {
            for idx in 0..self.contents.children() {
                if idx != fg_idx {
                    self.contents.child(idx).unwrap().hide();
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_label_color(fltk::enums::Color::Inactive);
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_color(fltk::enums::Color::Inactive);
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_frame(FrameType::DownFrame);
                } else {
                    self.contents.child(idx).unwrap().show();
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_label_color(Color::Selection);
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_color(fltk::enums::Color::Selection);
                    self.tab_labels
                        .child(idx)
                        .unwrap()
                        .set_frame(FrameType::NoBox);
                }
                self.tab_labels.child(idx).unwrap().set_damage(true);
                self.tab_labels.child(idx).unwrap().redraw();
                self.current = Some(fg_idx);
            }
        }

        /** Report which tab index is visible on foreground */
        pub fn get_foreground(&self) -> Option<i32> {
            self.current
        }
    }
}

fn main() {
    use fltk::{prelude::*, *};
    // Create groups to be used as content for tabs
    pub fn create_tab(from: i32, to: i32) -> group::Group {
        let grp = group::Group::new(0, 0, 800, 600, None);
        for idx in from..to {
            button::Button::new(
                idx * 10 + (idx - from) * 42,
                idx * 10 + (idx - from) * 42,
                80,
                40,
                None,
            )
            .with_label(&format!("button {idx}"));
        }
        grp.end();
        grp
    }

examples/composite_widgets.rs (line 14)

    pub fn new(w: i32, h: i32) -> MyButton {
        let mut grp = group::Group::new(0, 0, w, h, None);
        grp.set_frame(enums::FrameType::RFlatBox);
        grp.set_color(enums::Color::from_u32(0x01579b));
        grp.set_align(enums::Align::Center);
        let mut btn = button::Button::new(grp.x() + 420, grp.y() + 35, 30, 25, "@1+");
        btn.set_frame(enums::FrameType::OFlatBox);
        btn.set_color(enums::Color::from_u32(0xf49da9));
        btn.set_callback(move |b| b.parent().unwrap().hide());
        grp.end();
        grp.handle(|g, ev| match ev {
            enums::Event::Push => {
                g.do_callback();
                true
            }
            _ => false,
        });
        MyButton { grp }
    }

examples/custom_choice.rs (line 113)

    pub fn new<S: Into<Option<&'static str>>>(x: i32, y: i32, w: i32, h: i32, label: S) -> Self {
        let grp = group::Group::new(x, y, w, h, label).with_align(Align::Left);
        let mut frame = frame::Frame::new(x, y, w - w / 4, h, None);
        frame.set_frame(FrameType::DownBox);
        frame.set_color(Color::Background2);
        let mut btn = button::Button::new(x + w - w / 4, y, w / 4, h, "@2>");
        btn.clear_visible_focus();
        grp.end();
        let choices = Rc::from(RefCell::from(vec![]));
        btn.set_callback({
            let c = choices.clone();
            let mut f = frame.clone();
            let btn_win = btn.window().unwrap();
            move |b| {
                let mut menu = MyPopup::new(&c.borrow());
                let s = menu.popup(b.x() + btn_win.x() - f.w(), b.y() + btn_win.y() + b.h());
                f.set_label(&s.0);
            }
        });
        Self {
            grp,
            frame,
            btn,
            choices,
        }
    }

examples/calculator.rs (line 38)

    pub fn new(title: &'static str) -> MyButton {
        let mut b = Button::new(0, 0, 90, 0, title);
        b.set_label_size(20);
        b.set_compact(true);
        match title {
            "0" => {
                b.resize(0, 0, 90 * 2, 0);
                b.set_color(Color::Light3);
                b.set_shortcut(Shortcut::None | '0');
            }
            "CE" => {
                b.set_color(Color::Red);
                b.set_shortcut(Shortcut::None | Key::Delete);
            }
            "x" | "/" | "+" | "-" | "=" | "C" | "@<-" => {
                b.set_color(Color::Yellow);
                let shortcut = if title == "x" {
                    '*'
                } else {
                    title.chars().next().unwrap()
                };
                b.set_shortcut(Shortcut::None | shortcut);
                if shortcut == '@' {
                    b.set_shortcut(Shortcut::None | Key::BackSpace);
                }
                if shortcut == '=' {
                    b.set_shortcut(Shortcut::None | Key::Enter);
                }
            }
            _ => {
                b.set_color(Color::Light3);
                b.set_shortcut(Shortcut::None | title.chars().next().unwrap());
            }
        }
        Self { b }
    }

Additional examples can be found in:

• examples/tree.rs
• examples/calculator2.rs

pub fn default_fill() -> Self

Constructs a widget with the size of its parent

impl Button

pub fn set_compact(&mut self, flag: bool)

Set whether a button is compact

Examples found in repository

examples/calculator.rs (line 40)

    pub fn new(title: &'static str) -> MyButton {
        let mut b = Button::new(0, 0, 90, 0, title);
        b.set_label_size(20);
        b.set_compact(true);
        match title {
            "0" => {
                b.resize(0, 0, 90 * 2, 0);
                b.set_color(Color::Light3);
                b.set_shortcut(Shortcut::None | '0');
            }
            "CE" => {
                b.set_color(Color::Red);
                b.set_shortcut(Shortcut::None | Key::Delete);
            }
            "x" | "/" | "+" | "-" | "=" | "C" | "@<-" => {
                b.set_color(Color::Yellow);
                let shortcut = if title == "x" {
                    '*'
                } else {
                    title.chars().next().unwrap()
                };
                b.set_shortcut(Shortcut::None | shortcut);
                if shortcut == '@' {
                    b.set_shortcut(Shortcut::None | Key::BackSpace);
                }
                if shortcut == '=' {
                    b.set_shortcut(Shortcut::None | Key::Enter);
                }
            }
            _ => {
                b.set_color(Color::Light3);
                b.set_shortcut(Shortcut::None | title.chars().next().unwrap());
            }
        }
        Self { b }
    }

pub fn compact(&self) -> bool

Get whether a button is compact

Trait Implementations

impl ButtonExt for Button

fn shortcut(&self) -> Shortcut

Gets the shortcut associated with a button

fn set_shortcut(&mut self, shortcut: Shortcut)

Sets the shortcut associated with a button

fn clear(&mut self)

Clears the value of the button. Useful for round, radio, light, toggle and check buttons

fn is_set(&self) -> bool

Returns whether a button is set or not. Useful for round, radio, light, toggle and check buttons

fn set(&mut self, flag: bool)

Sets whether a button is set or not. Useful for round, radio, light, toggle and check buttons

fn value(&self) -> bool

Returns whether a button is set or not. Useful for round, radio, light, toggle and check buttons

fn set_value(&mut self, flag: bool)

Sets whether a button is set or not. Useful for round, radio, light, toggle and check buttons

fn set_down_frame(&mut self, f: FrameType)

Set the down_box of the widget

fn down_frame(&self) -> FrameType

Get the down frame type of the widget

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Button

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Button

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WidgetBase for Button

fn delete(wid: Self)

Deletes widgets and their children.

unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Self

transforms a widget pointer to a Widget, for internal use

unsafe fn from_widget<W: WidgetExt>(w: W) -> Self

Get a widget from base widget

fn handle<F: FnMut(&mut Self, Event) -> bool + 'static>(&mut self, cb: F)

Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int). Handled or ignored events should return true, unhandled events should return false. takes the widget as a closure argument. The ability to handle an event might depend on handling other events, as explained here

fn draw<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)

Set a custom draw method. takes the widget as a closure argument. macOS requires that WidgetBase::draw actually calls drawing functions

fn resize_callback<F: FnMut(&mut Self, i32, i32, i32, i32) + 'static>( &mut self, cb: F, )

Perform a callback on resize. Avoid resizing the parent or the same widget to avoid infinite recursion

unsafe fn assume_derived(&mut self)

Makes the widget derived

fn from_dyn_widget<W: WidgetExt>(w: &W) -> Option<Self>

Cast a type-erased widget back to its original widget

fn from_dyn_widget_ptr(w: *mut Fl_Widget) -> Option<Self>

Cast a type-erased widget pointer back to its original widget

impl WidgetExt for Button

fn set_label(&mut self, title: &str)

Sets the widget’s label. labels support special symbols preceded by an @ sign. and for the associated formatting.

fn unset_label(&mut self)

Unset a widget’s label

fn redraw(&mut self)

Redraws a widget, necessary for resizing and changing positions

fn show(&mut self)

Shows the widget

fn hide(&mut self)

Hides the widget

fn x(&self) -> i32

Returns the x coordinate of the widget

fn y(&self) -> i32

Returns the y coordinate of the widget

fn w(&self) -> i32

Returns the width of the widget

fn h(&self) -> i32

Returns the height of the widget

fn label(&self) -> Option<String>

Returns the label of the widget

fn measure_label(&self) -> (i32, i32)

Measures the label’s width and height

fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

fn activate(&mut self)

Activates the widget

fn deactivate(&mut self)

Deactivates the widget

fn redraw_label(&mut self)

Redraws the label of the widget

fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Resizes and/or moves the widget, takes x, y, width and height

fn widget_resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Does a simple resize ignoring class-specific resize functionality

fn tooltip(&self) -> Option<String>

Returns the tooltip text

fn set_tooltip(&mut self, txt: &str)

Sets the tooltip text

fn color(&self) -> Color

Returns the widget color

fn set_color(&mut self, color: Color)

Sets the widget’s color

fn label_color(&self) -> Color

Returns the widget label’s color

fn set_label_color(&mut self, color: Color)

Sets the widget label’s color

fn label_font(&self) -> Font

Returns the widget label’s font

fn set_label_font(&mut self, font: Font)

Sets the widget label’s font

fn label_size(&self) -> i32

Returns the widget label’s size

fn set_label_size(&mut self, sz: i32)

Sets the widget label’s size

fn label_type(&self) -> LabelType

Returns the widget label’s type

fn set_label_type(&mut self, typ: LabelType)

Sets the widget label’s type

fn frame(&self) -> FrameType

Returns the widget’s frame type

fn set_frame(&mut self, typ: FrameType)

Sets the widget’s frame type

fn changed(&self) -> bool

Returns whether the widget was changed

fn set_changed(&mut self)

Mark the widget as changed

fn clear_changed(&mut self)

Clears the changed status of the widget

fn align(&self) -> Align

Returns the alignment of the widget

fn set_align(&mut self, align: Align)

Sets the alignment of the widget

fn set_when(&mut self, trigger: When)

Sets the default callback trigger for a widget, equivalent to when()

fn when(&self) -> When

Return the callback trigger, equivalent to when()

fn parent(&self) -> Option<Group>

Returns the parent of the widget

fn selection_color(&self) -> Color

Gets the selection color of the widget

fn set_selection_color(&mut self, color: Color)

Sets the selection color of the widget

fn do_callback(&mut self)

Runs the already registered callback

fn window(&self) -> Option<Box<dyn WindowExt>>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Box<dyn WindowExt>>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

fn take_focus(&mut self) -> Result<(), FltkError>

Make the widget take focus

fn set_visible_focus(&mut self)

Set the widget to have visible focus

fn clear_visible_focus(&mut self)

Clear visible focus

fn visible_focus(&mut self, v: bool)

Set the visible focus using a flag

fn has_visible_focus(&self) -> bool

Return whether the widget has visible focus

fn has_focus(&self) -> bool

Return whether the widget has focus

fn was_deleted(&self) -> bool

Check if a widget was deleted

fn damage(&self) -> bool

Return whether the widget was damaged

fn set_damage(&mut self, flag: bool)

Signal the widget as damaged and it should be redrawn in the next event loop cycle

fn damage_type(&self) -> Damage

Return the damage mask

fn set_damage_type(&mut self, mask: Damage)

Signal the type of damage a widget received

fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)

Signal damage for an area inside the widget

fn clear_damage(&mut self)

Clear the damaged flag

fn as_window(&self) -> Option<Box<dyn WindowExt>>

Return the widget as a window if it’s a window

fn as_group(&self) -> Option<Group>

Return the widget as a group widget if it’s a group widget

fn inside<W: WidgetExt>(&self, wid: &W) -> bool

Checks whether the self widget is inside another widget

fn get_type<T: WidgetType>(&self) -> T

Returns the widget type when applicable

fn set_type<T: WidgetType>(&mut self, typ: T)

Sets the widget type

fn set_image<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget

fn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget scaled to the widget’s size

fn image(&self) -> Option<Box<dyn ImageExt>>

Gets the image associated with the widget

fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)

Sets the deactivated image of the widget

fn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)

Sets the deactivated image of the widget scaled to the widget’s size

fn deimage(&self) -> Option<Box<dyn ImageExt>>

Gets the deactivated image associated with the widget

fn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)

Sets the callback when the widget is triggered (clicks for example) takes the widget as a closure argument

fn emit<T: 'static + Clone + Send + Sync>(&mut self, sender: Sender<T>, msg: T)

Emits a message on callback using a sender

unsafe fn as_widget<W: WidgetBase>(&self) -> W

Upcast a WidgetExt to some widget type

fn visible(&self) -> bool

Returns whether a widget is visible

fn visible_r(&self) -> bool

Returns whether a widget or any of its parents are visible (recursively)

fn is_same<W: WidgetExt>(&self, other: &W) -> bool

Return whether two widgets object point to the same widget

fn active(&self) -> bool

Returns whether a widget is active

fn active_r(&self) -> bool

Returns whether a widget or any of its parents are active (recursively)

fn handle_event(&mut self, event: Event) -> bool

Handle a specific event

fn is_derived(&self) -> bool

Check whether a widget is derived

fn as_base_widget(&self) -> Widget

where Self: Sized,

Upcast a WidgetExt to a Widget

impl WidgetProps for Button

fn with_pos(self, x: i32, y: i32) -> Self

Initialize to position x, y

fn with_size(self, width: i32, height: i32) -> Self

Initialize to size width, height

fn with_label(self, title: &str) -> Self

Initialize with a label

fn with_align(self, align: Align) -> Self

Initialize with alignment

fn with_type<T: WidgetType>(self, typ: T) -> Self

Initialize with type

fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize at bottom of another widget

fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize above of another widget

fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize right of another widget

fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self

Initialize left of another widget

fn center_of<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget

fn center_x<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget on the x axis

fn center_y<W: WidgetExt>(self, w: &W) -> Self

Initialize center of another widget on the y axis

fn center_of_parent(self) -> Self

Initialize center of parent

fn size_of<W: WidgetExt>(self, w: &W) -> Self

Initialize to the size of another widget

fn size_of_parent(self) -> Self

Initialize to the size of the parent

impl Eq for Button

impl Send for Button

Available on non-crate feature single-threaded only.

impl Sync for Button

Available on non-crate feature single-threaded only.