Struct Widget

pub struct Widget { /* private fields */ }

Available on crate feature dep_fltk only.

An empty widget. Instantiating a Widget requires that you at least add a draw callback for it to show anything

use fltk::{prelude::*, *};
fn main() {
    let a = app::App::default();
    let mut win = window::Window::default();
    let mut wid = widget::Widget::default();
    win.end();
    win.show();
    wid.draw(|w| {
        draw::draw_box(w.frame(), w.x(), w.y(), w.w(), w.h(), w.color());
        draw::set_draw_color(enums::Color::Black); // for the text
        draw::set_font(enums::Font::Helvetica, app::font_size());
        draw::draw_text2(&w.label(), w.x(), w.y(), w.w(), w.h(), w.align());
    });
    a.run().unwrap();
}

Trait Implementations

impl Clone for Widget

fn clone(&self) -> Widget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Widget

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

Formats the value using the given formatter.

impl Default for Widget

fn default() -> Widget

Returns the “default value” for a type.

impl PartialEq for Widget

fn eq(&self, other: &Widget) -> 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 Widget

fn new<'a, T>(x: i32, y: i32, width: i32, height: i32, title: T) -> Widget

where T: Into<Option<&'a str>>,

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

fn default_fill() -> Widget

Constructs a widget with the size of its parent

fn delete(wid: Widget)

Deletes widgets and their children.

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

transforms a widget pointer to a Widget, for internal use

unsafe fn from_widget<W>(w: W) -> Widget

where W: WidgetExt,

Get a widget from base widget

fn handle<F>(&mut self, cb: F)

where F: FnMut(&mut Widget, Event) -> bool + 'static,

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>(&mut self, cb: F)

where F: FnMut(&mut Widget) + 'static,

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>(&mut self, cb: F)

where F: FnMut(&mut Widget, i32, i32, i32, i32) + 'static,

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>(w: &W) -> Option<Widget>

where W: WidgetExt,

Cast a type-erased widget back to its original widget

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

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

impl WidgetExt for Widget

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

where W: WidgetExt,

Initialize center of another widget

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

where W: WidgetExt,

Initialize center of another widget

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

Initialize to a position x, y

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

Initialize to size width, height

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

Initialize with a label

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

Initialize with alignment

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

where T: WidgetType,

Initialize with type

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

where W: WidgetExt,

Initialize at bottom of another widget

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

where W: WidgetExt,

Initialize above of another widget

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

where W: WidgetExt,

Initialize right of another widget

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

where W: WidgetExt,

Initialize left of another widget

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

where W: WidgetExt,

Initialize center of another widget

fn center_of_parent(self) -> Widget

Initialize center of parent

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

where W: WidgetExt,

Initialize to the size of another widget

fn size_of_parent(self) -> Widget

Initialize to the size of the parent

fn set_pos(&mut self, x: i32, y: i32)

Set to position x, y

fn set_size(&mut self, width: i32, height: i32)

Set to dimensions width and height

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 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 width(&self) -> i32

Returns the width of the widget

fn height(&self) -> i32

Returns the height 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) -> 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_trigger(&mut self, trigger: CallbackTrigger)

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

fn trigger(&self) -> CallbackTrigger

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>(&self, wid: &W) -> bool

where W: WidgetExt,

Checks whether the self widget is inside another widget

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

where T: WidgetType,

Returns the widget type when applicable

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

where T: WidgetType,

Sets the widget type

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

where I: ImageExt,

Sets the image of the widget

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

where I: ImageExt,

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

unsafe fn image_mut(&self) -> Option<&mut Image>

Get a reference type of the widget’s image

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

where I: ImageExt,

Sets the deactivated image of the widget

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

where I: ImageExt,

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

unsafe fn deimage_mut(&self) -> Option<&mut Image>

Get a reference type of the widget’s deactivated image

fn set_callback<F>(&mut self, cb: F)

where F: FnMut(&mut Widget) + 'static,

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

fn emit<T>(&mut self, sender: Sender<T>, msg: T)

where T: 'static + Clone + Send + Sync,

Emits a message on callback using a sender

unsafe fn into_widget<W>(&self) -> W

where W: WidgetBase,

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>(&self, other: &W) -> bool

where W: WidgetExt,

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 Eq for Widget

impl Send for Widget

impl Sync for Widget