Trait WidgetExt

Source

pub unsafe trait WidgetExt {
Show 80 methods    // Required methods
    fn set_label(&mut self, title: &str);
    fn unset_label(&mut self);
    fn redraw(&mut self);
    fn show(&mut self);
    fn hide(&mut self);
    fn x(&self) -> i32;
    fn y(&self) -> i32;
    fn w(&self) -> i32;
    fn h(&self) -> i32;
    fn label(&self) -> Option<String>;
    fn measure_label(&self) -> (i32, i32);
    fn as_widget_ptr(&self) -> *mut Fl_Widget;
    fn inside<W: WidgetExt>(&self, wid: &W) -> bool
       where Self: Sized;
    fn get_type<T: WidgetType>(&self) -> T
       where Self: Sized;
    fn set_type<T: WidgetType>(&mut self, typ: T)
       where Self: Sized;
    fn set_image<I: ImageExt>(&mut self, image: Option<I>)
       where Self: Sized;
    fn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)
       where Self: Sized;
    fn image(&self) -> Option<Box<dyn ImageExt>>
       where Self: Sized;
    fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)
       where Self: Sized;
    fn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)
       where Self: Sized;
    fn deimage(&self) -> Option<Box<dyn ImageExt>>
       where Self: Sized;
    fn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)
       where Self: Sized;
    fn emit<T: 'static + Clone + Send + Sync>(
        &mut self,
        sender: Sender<T>,
        msg: T,
    )
       where Self: Sized;
    fn activate(&mut self);
    fn deactivate(&mut self);
    fn redraw_label(&mut self);
    fn resize(&mut self, x: i32, y: i32, width: i32, height: i32);
    fn tooltip(&self) -> Option<String>;
    fn set_tooltip(&mut self, txt: &str);
    fn color(&self) -> Color;
    fn set_color(&mut self, color: Color);
    fn label_color(&self) -> Color;
    fn set_label_color(&mut self, color: Color);
    fn label_font(&self) -> Font;
    fn set_label_font(&mut self, font: Font);
    fn label_size(&self) -> i32;
    fn set_label_size(&mut self, sz: i32);
    fn label_type(&self) -> LabelType;
    fn set_label_type(&mut self, typ: LabelType);
    fn frame(&self) -> FrameType;
    fn set_frame(&mut self, typ: FrameType);
    fn changed(&self) -> bool;
    fn set_changed(&mut self);
    fn clear_changed(&mut self);
    fn align(&self) -> Align;
    fn set_align(&mut self, align: Align);
    fn parent(&self) -> Option<Group>;
    fn selection_color(&self) -> Color;
    fn set_selection_color(&mut self, color: Color);
    fn do_callback(&mut self);
    fn window(&self) -> Option<Box<dyn WindowExt>>;
    fn top_window(&self) -> Option<Box<dyn WindowExt>>;
    fn takes_events(&self) -> bool;
    fn take_focus(&mut self) -> Result<(), FltkError>;
    fn set_visible_focus(&mut self);
    fn clear_visible_focus(&mut self);
    fn visible_focus(&mut self, v: bool);
    fn has_visible_focus(&self) -> bool;
    fn has_focus(&self) -> bool;
    fn was_deleted(&self) -> bool;
    fn damage(&self) -> bool;
    fn set_damage(&mut self, flag: bool);
    fn damage_type(&self) -> Damage;
    fn set_damage_type(&mut self, mask: Damage);
    fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32);
    fn clear_damage(&mut self);
    fn set_when(&mut self, trigger: When);
    fn when(&self) -> When;
    fn as_window(&self) -> Option<Box<dyn WindowExt>>;
    fn as_group(&self) -> Option<Group>;
    unsafe fn as_widget<W: WidgetBase>(&self) -> W
       where Self: Sized;
    fn visible(&self) -> bool;
    fn visible_r(&self) -> bool;
    fn is_same<W: WidgetExt>(&self, other: &W) -> bool
       where Self: Sized;
    fn active(&self) -> bool;
    fn active_r(&self) -> bool;
    fn widget_resize(&mut self, x: i32, y: i32, w: i32, h: i32);
    fn handle_event(&mut self, event: Event) -> bool;

    // Provided methods
    fn as_base_widget(&self) -> Widget
       where Self: Sized { ... }
    fn is_derived(&self) -> bool { ... }
}

Expand description

Defines the methods implemented by all widgets

For multithreaded usage, see the widget module documentation’s note

§Safety

fltk-rs traits depend on some FLTK internal code

§Warning

fltk-rs traits are non-exhaustive, to avoid future breakage if you try to implement them manually, use the Deref and DerefMut pattern or the widget_extends! macro

Required Methods§

Source

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.

Source

fn unset_label(&mut self)

Unset a widget’s label

Source

fn redraw(&mut self)

Redraws a widget, necessary for resizing and changing positions

Source

fn show(&mut self)

Shows the widget

Source

fn hide(&mut self)

Hides the widget

Source

fn x(&self) -> i32

Returns the x coordinate of the widget

Source

fn y(&self) -> i32

Returns the y coordinate of the widget

Source

fn w(&self) -> i32

Returns the width of the widget

Source

fn h(&self) -> i32

Returns the height of the widget

Source

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

Returns the label of the widget

Source

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

Measures the label’s width and height

Source

fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

Source

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

Checks whether the self widget is inside another widget

Source

fn get_type<T: WidgetType>(&self) -> T
where Self: Sized,

Returns the widget type when applicable

Source

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

Sets the widget type

Source

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

Sets the image of the widget

Source

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

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

Source

fn image(&self) -> Option<Box<dyn ImageExt>>
where Self: Sized,

Gets the image associated with the widget

Source

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

Sets the deactivated image of the widget

Source

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

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

Source

fn deimage(&self) -> Option<Box<dyn ImageExt>>
where Self: Sized,

Gets the deactivated image associated with the widget

Source

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

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

Source

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

Emits a message on callback using a sender

Source

fn activate(&mut self)

Activates the widget

Source

fn deactivate(&mut self)

Deactivates the widget

Source

fn redraw_label(&mut self)

Redraws the label of the widget

Source

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

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

Source

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

Returns the tooltip text

Sets the tooltip text

Source

fn color(&self) -> Color

Returns the widget color

Source

fn set_color(&mut self, color: Color)

Sets the widget’s color

Source

fn label_color(&self) -> Color

Returns the widget label’s color

Source

fn set_label_color(&mut self, color: Color)

Sets the widget label’s color

Source

fn label_font(&self) -> Font

Returns the widget label’s font

Source

fn set_label_font(&mut self, font: Font)

Sets the widget label’s font

Source

fn label_size(&self) -> i32

Returns the widget label’s size

Source

fn set_label_size(&mut self, sz: i32)

Sets the widget label’s size

Source

fn label_type(&self) -> LabelType

Returns the widget label’s type

Source

fn set_label_type(&mut self, typ: LabelType)

Sets the widget label’s type

Source

fn frame(&self) -> FrameType

Returns the widget’s frame type

Source

fn set_frame(&mut self, typ: FrameType)

Sets the widget’s frame type

Source

fn changed(&self) -> bool

Returns whether the widget was changed

Source

fn set_changed(&mut self)

Mark the widget as changed

Source

fn clear_changed(&mut self)

Clears the changed status of the widget

Source

fn align(&self) -> Align

Returns the alignment of the widget

Source

fn set_align(&mut self, align: Align)

Sets the alignment of the widget

Source

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

Returns the parent of the widget

Source

fn selection_color(&self) -> Color

Gets the selection color of the widget

Source

fn set_selection_color(&mut self, color: Color)

Sets the selection color of the widget

Source

fn do_callback(&mut self)

Runs the already registered callback

Source

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

Returns the direct window holding the widget

Source

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

Returns the topmost window holding the widget

Source

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

Source

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

Make the widget take focus

§Errors

Errors on failure to take focus

Source

fn set_visible_focus(&mut self)

Set the widget to have visible focus

Source

fn clear_visible_focus(&mut self)

Clear visible focus

Source

fn visible_focus(&mut self, v: bool)

Set the visible focus using a flag

Source

fn has_visible_focus(&self) -> bool

Return whether the widget has visible focus

Source

fn has_focus(&self) -> bool

Return whether the widget has focus

Source

fn was_deleted(&self) -> bool

Check if a widget was deleted

Source

fn damage(&self) -> bool

Return whether the widget was damaged

Source

fn set_damage(&mut self, flag: bool)

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

Source

fn damage_type(&self) -> Damage

Return the damage mask

Source

fn set_damage_type(&mut self, mask: Damage)

Signal the type of damage a widget received

Source

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

Signal damage for an area inside the widget

Source

fn clear_damage(&mut self)

Clear the damaged flag

Source

fn set_when(&mut self, trigger: When)

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

Source

fn when(&self) -> When

Return the callback trigger, equivalent to when()

Source

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

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

Source

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

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

Source

unsafe fn as_widget<W: WidgetBase>(&self) -> W
where Self: Sized,

Upcast a WidgetExt to some widget type

§Safety

Allows for potentially unsafe casts between incompatible widget types

Source

fn visible(&self) -> bool

Returns whether a widget is visible

Source

fn visible_r(&self) -> bool

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

Source

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

Return whether two widgets object point to the same widget

Source

fn active(&self) -> bool

Returns whether a widget is active

Source

fn active_r(&self) -> bool

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

Source

fn widget_resize(&mut self, x: i32, y: i32, w: i32, h: i32)

Does a simple resize ignoring class-specific resize functionality

Source

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

Handle a specific event

Provided Methods§

Source

fn as_base_widget(&self) -> Widget
where Self: Sized,

Upcast a WidgetExt to a Widget

Source

fn is_derived(&self) -> bool

Check whether a widget is derived

Implementors§

Source §

Trait WidgetExtCopy item path

§Safety

§Warning

Required Methods§

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

fn unset_label(&mut self)

fn redraw(&mut self)

fn show(&mut self)

fn hide(&mut self)

fn x(&self) -> i32

fn y(&self) -> i32

fn w(&self) -> i32

fn h(&self) -> i32

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

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

fn as_widget_ptr(&self) -> *mut Fl_Widget

fn inside<W: WidgetExt>(&self, wid: &W) -> boolwhere Self: Sized,

fn get_type<T: WidgetType>(&self) -> Twhere Self: Sized,

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

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

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

fn image(&self) -> Option<Box<dyn ImageExt>>where Self: Sized,

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

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

fn deimage(&self) -> Option<Box<dyn ImageExt>>where Self: Sized,

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

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

fn activate(&mut self)

fn deactivate(&mut self)

fn redraw_label(&mut self)

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

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

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

fn color(&self) -> Color

fn set_color(&mut self, color: Color)

fn label_color(&self) -> Color

fn set_label_color(&mut self, color: Color)

fn label_font(&self) -> Font

fn set_label_font(&mut self, font: Font)

fn label_size(&self) -> i32

fn set_label_size(&mut self, sz: i32)

fn label_type(&self) -> LabelType

fn set_label_type(&mut self, typ: LabelType)

fn frame(&self) -> FrameType

fn set_frame(&mut self, typ: FrameType)

fn changed(&self) -> bool

fn set_changed(&mut self)

fn clear_changed(&mut self)

fn align(&self) -> Align

fn set_align(&mut self, align: Align)

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

fn selection_color(&self) -> Color

fn set_selection_color(&mut self, color: Color)

fn do_callback(&mut self)

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

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

fn takes_events(&self) -> bool

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

§Errors

fn set_visible_focus(&mut self)

fn clear_visible_focus(&mut self)

fn visible_focus(&mut self, v: bool)

fn has_visible_focus(&self) -> bool

fn has_focus(&self) -> bool

fn was_deleted(&self) -> bool

fn damage(&self) -> bool

fn set_damage(&mut self, flag: bool)

fn damage_type(&self) -> Damage

fn set_damage_type(&mut self, mask: Damage)

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

fn clear_damage(&mut self)

fn set_when(&mut self, trigger: When)

fn when(&self) -> When

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

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

unsafe fn as_widget<W: WidgetBase>(&self) -> Wwhere Self: Sized,

§Safety

fn visible(&self) -> bool

fn visible_r(&self) -> bool

fn is_same<W: WidgetExt>(&self, other: &W) -> boolwhere Self: Sized,

Trait WidgetExt

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

fn get_type<T: WidgetType>(&self) -> T
where Self: Sized,

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

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

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

fn image(&self) -> Option<Box<dyn ImageExt>>
where Self: Sized,

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

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

fn deimage(&self) -> Option<Box<dyn ImageExt>>
where Self: Sized,

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

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

unsafe fn as_widget<W: WidgetBase>(&self) -> W
where Self: Sized,

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

fn as_base_widget(&self) -> Widget
where Self: Sized,