Struct BaseListener

pub struct BaseListener<T: WidgetBase + WidgetExt, TRIG> { /* private fields */ }

The base listener widget, wraps a fltk WidgetBase.

Implementations

impl<T: WidgetBase + WidgetExt + Into<BaseListener<T, TRIG>>, TRIG> BaseListener<T, TRIG>

Constructors, depends on impl From<T> for BaseListener<T, TRIG>, see crate::blocking::Listener::from

pub fn from_widget(wid: T) -> Self

Not recommanded, use Into<BaseListener> like let btn: Listener<_> = btn.into();

pub fn new<S: Into<Option<&'static str>>>( x: i32, y: i32, w: i32, h: i32, label: S, ) -> Self

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

pub fn default_fill() -> Self

Construct a widget filling the parent. Same as WidgetBase::default_fill

impl<T: WidgetBase + WidgetExt, TRIG> BaseListener<T, TRIG>

Builder functions, delegated to WidgetBase

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

Initialize to position x, y

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

Initialize to size width, height

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

Initialize with a label

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

Initialize with alignment

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

Initialize with type

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

Initialize at bottom of another widget

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

Initialize above of another widget

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

Initialize right of another widget

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

Initialize left of another widget

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

Initialize center of another widget

pub fn center_of_parent(self) -> Self

Initialize center of parent

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

Initialize center of another widget on the x axis

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

Initialize center of another widget on the y axis

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

Initialize to the size of another widget

pub fn size_of_parent(self) -> Self

Initialize to the size of the parent

impl<T: WidgetBase + WidgetExt> BaseListener<T, Trig<T>>

core implementation

pub fn triggered(&self) -> bool

Check whether a widget was triggered

Examples found in repository

examples/triggered.rs (line 26)

fn main() {
    let a = app::App::default().with_scheme(app::Scheme::Gtk);
    app::set_font_size(20);

    let mut count = 0;

    let mut wind = Window::default()
        .with_size(160, 200)
        .with_label("Counter");
    let flex = Flex::default()
        .with_size(120, 160)
        .center_of_parent()
        .column();
    let but_inc: Listener<_> = Button::default().with_label("+").into();
    let mut frame = Frame::default().with_label(&count.to_string());
    let but_dec: Listener<_> = Button::default().with_label("-").into();
    flex.end();
    wind.end();
    wind.show();

    while a.wait() {
        if fltk_evented::event() {
            if but_inc.triggered() {
                count += 1;
            }
            if but_dec.triggered() {
                count -= 1;
            }
            frame.set_label(&count.to_string());
        }
    }
}

examples/evented.rs (line 39)

fn main() {
    let a = app::App::default().with_scheme(app::Scheme::Gtk);
    app::set_font_size(20);

    let mut count = 0;

    let mut wind = Window::default()
        .with_size(160, 200)
        .with_label("Counter");
    let flex = Flex::default()
        .with_size(120, 160)
        .center_of_parent()
        .column();
    let mut but_inc: Listener<_> = Button::default().with_label("+").into();
    let mut frame = Frame::default().with_label(&count.to_string());
    let mut but_dec: Listener<_> = Button::default().with_label("-").into();
    flex.end();
    wind.end();
    wind.show();

    fn button_color(btn: &mut Button, c: Color) {
        btn.set_color(c);
        btn.redraw();
    }

    while a.wait() {
        if fltk_evented::event() {
            if but_inc.triggered() {
                count += 1;
            }
    
            if but_dec.triggered() {
                count -= 1;
            }
    
            match but_inc.event() {
                Event::Enter | Event::Move => button_color(&mut but_inc, Color::White),
                Event::Leave => button_color(&mut but_inc, Color::BackGround),
                _ => (),
            }
    
            match but_dec.event() {
                Event::Enter | Event::Move => button_color(&mut but_dec, Color::White),
                Event::Leave => button_color(&mut but_dec, Color::BackGround),
                _ => (),
            }

            frame.set_label(&count.to_string());
        }
    }
}

pub fn event(&self) -> Event

Get an event the widget received, returns Event::NoEvent if no events received

Examples found in repository

examples/evented.rs (line 47)

fn main() {
    let a = app::App::default().with_scheme(app::Scheme::Gtk);
    app::set_font_size(20);

    let mut count = 0;

    let mut wind = Window::default()
        .with_size(160, 200)
        .with_label("Counter");
    let flex = Flex::default()
        .with_size(120, 160)
        .center_of_parent()
        .column();
    let mut but_inc: Listener<_> = Button::default().with_label("+").into();
    let mut frame = Frame::default().with_label(&count.to_string());
    let mut but_dec: Listener<_> = Button::default().with_label("-").into();
    flex.end();
    wind.end();
    wind.show();

    fn button_color(btn: &mut Button, c: Color) {
        btn.set_color(c);
        btn.redraw();
    }

    while a.wait() {
        if fltk_evented::event() {
            if but_inc.triggered() {
                count += 1;
            }
    
            if but_dec.triggered() {
                count -= 1;
            }
    
            match but_inc.event() {
                Event::Enter | Event::Move => button_color(&mut but_inc, Color::White),
                Event::Leave => button_color(&mut but_inc, Color::BackGround),
                _ => (),
            }
    
            match but_dec.event() {
                Event::Enter | Event::Move => button_color(&mut but_dec, Color::White),
                Event::Leave => button_color(&mut but_dec, Color::BackGround),
                _ => (),
            }

            frame.set_label(&count.to_string());
        }
    }
}

pub fn on(&mut self, ev: Event, cb: impl FnMut(&mut T) + 'static)

What the widget should do on a custom event

pub fn on_hover(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on hover

Examples found in repository

examples/on_event.rs (lines 21-23)

fn main() {
    let app = app::App::default();
    let mut wind = window::Window::default().with_size(400, 300);
    wind.set_color(Color::White);
    let mut but: Listener<_> = button::Button::new(160, 210, 80, 35, "Click me!").into();
    but.set_frame(FrameType::FlatBox);
    but.set_color(Color::Cyan);
    but.set_selection_color(Color::Cyan.darker());
    but.clear_visible_focus();
    wind.end();
    wind.show();

    but.on_hover(|b| {
        b.set_color(Color::Cyan.lighter().lighter());
    });

    but.on_leave(|b| {
        b.set_color(Color::Cyan);
    });

    but.on_click(|b| {
        println!("Clicked");
        b.set_label_color(Color::White);
    });

    but.on_release(move |b| {
        wind.set_label("Button Released!");
        b.set_label_color(Color::Black);
    });

    app.run().unwrap();
}

pub fn on_leave(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on leave

Examples found in repository

examples/on_event.rs (lines 25-27)

fn main() {
    let app = app::App::default();
    let mut wind = window::Window::default().with_size(400, 300);
    wind.set_color(Color::White);
    let mut but: Listener<_> = button::Button::new(160, 210, 80, 35, "Click me!").into();
    but.set_frame(FrameType::FlatBox);
    but.set_color(Color::Cyan);
    but.set_selection_color(Color::Cyan.darker());
    but.clear_visible_focus();
    wind.end();
    wind.show();

    but.on_hover(|b| {
        b.set_color(Color::Cyan.lighter().lighter());
    });

    but.on_leave(|b| {
        b.set_color(Color::Cyan);
    });

    but.on_click(|b| {
        println!("Clicked");
        b.set_label_color(Color::White);
    });

    but.on_release(move |b| {
        wind.set_label("Button Released!");
        b.set_label_color(Color::Black);
    });

    app.run().unwrap();
}

pub fn on_click(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on click

Examples found in repository

examples/on_event.rs (lines 29-32)

fn main() {
    let app = app::App::default();
    let mut wind = window::Window::default().with_size(400, 300);
    wind.set_color(Color::White);
    let mut but: Listener<_> = button::Button::new(160, 210, 80, 35, "Click me!").into();
    but.set_frame(FrameType::FlatBox);
    but.set_color(Color::Cyan);
    but.set_selection_color(Color::Cyan.darker());
    but.clear_visible_focus();
    wind.end();
    wind.show();

    but.on_hover(|b| {
        b.set_color(Color::Cyan.lighter().lighter());
    });

    but.on_leave(|b| {
        b.set_color(Color::Cyan);
    });

    but.on_click(|b| {
        println!("Clicked");
        b.set_label_color(Color::White);
    });

    but.on_release(move |b| {
        wind.set_label("Button Released!");
        b.set_label_color(Color::Black);
    });

    app.run().unwrap();
}

pub fn on_release(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on release

Examples found in repository

examples/on_event.rs (lines 34-37)

fn main() {
    let app = app::App::default();
    let mut wind = window::Window::default().with_size(400, 300);
    wind.set_color(Color::White);
    let mut but: Listener<_> = button::Button::new(160, 210, 80, 35, "Click me!").into();
    but.set_frame(FrameType::FlatBox);
    but.set_color(Color::Cyan);
    but.set_selection_color(Color::Cyan.darker());
    but.clear_visible_focus();
    wind.end();
    wind.show();

    but.on_hover(|b| {
        b.set_color(Color::Cyan.lighter().lighter());
    });

    but.on_leave(|b| {
        b.set_color(Color::Cyan);
    });

    but.on_click(|b| {
        println!("Clicked");
        b.set_label_color(Color::White);
    });

    but.on_release(move |b| {
        wind.set_label("Button Released!");
        b.set_label_color(Color::Black);
    });

    app.run().unwrap();
}

pub fn on_drag(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on drag

pub fn on_focus(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on focus

pub fn on_unfocus(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on unfocus

pub fn on_keydown(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on keydown

pub fn on_keyup(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on keyup

pub fn on_close(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on close

pub fn on_move(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on move

pub fn on_shortcut(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on shortcut

pub fn on_deactivate(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on deactivate

pub fn on_activate(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on activate

pub fn on_hide(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on hide

pub fn on_show(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on show

pub fn on_paste(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on paste

pub fn on_selection_clear(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on selection_clear

pub fn on_mousewheel(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on mousewheel

pub fn on_dnd_enter(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on dnd_enter

pub fn on_dnd_drag(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on dnd_drag

pub fn on_dnd_leave(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on dnd_leave

pub fn on_dnd_release(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on dnd_release

pub fn on_screen_config_changed(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on screen_config_changed

pub fn on_fullscreen(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on fullscreen

pub fn on_zoom_gesture(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on zoom_gesture

pub fn on_zoom(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on zoom

pub fn on_resize(&mut self, cb: impl FnMut(&mut T) + 'static)

What the widget should do on resize

impl<T: WidgetBase + WidgetExt> BaseListener<T, Trig>

core implementation

pub async fn triggered(&self) -> bool

Available on crate features tokio or async-std only.

Check whether a widget was triggered

pub fn event(&self) -> Event

Available on crate features tokio or async-std only.

Get an event the widget received, returns Event::NoEvent if no events received

Trait Implementations

impl<T: Clone + WidgetBase + WidgetExt, TRIG: Clone> Clone for BaseListener<T, TRIG>

fn clone(&self) -> BaseListener<T, TRIG>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + WidgetBase + WidgetExt, TRIG: Debug> Debug for BaseListener<T, TRIG>

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

Formats the value using the given formatter.

impl<T: WidgetBase + WidgetExt + Default + Into<BaseListener<T, TRIG>>, TRIG> Default for BaseListener<T, TRIG>

#[derive(Default)] won’t register callbacks, so we must impl Default manually.

fn default() -> Self

Returns the “default value” for a type.

impl<T: WidgetBase + WidgetExt, TRIG> Deref for BaseListener<T, TRIG>

Used to call methods like WidgetExt::x.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: WidgetBase + WidgetExt, TRIG> DerefMut for BaseListener<T, TRIG>

Used to call methods like WidgetExt::set_pos.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.