pub unsafe trait WidgetExt {
Show 100 methods
// Required methods
fn with_pos(self, x: i32, y: i32) -> Self
where Self: Sized;
fn with_size(self, width: i32, height: i32) -> Self
where Self: Sized;
fn with_label(self, title: &str) -> Self
where Self: Sized;
fn with_align(self, align: Align) -> Self
where Self: Sized;
fn with_type<T: WidgetType>(self, typ: T) -> Self
where Self: Sized;
fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
where Self: Sized;
fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
where Self: Sized;
fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
where Self: Sized;
fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
where Self: Sized;
fn center_of<W: WidgetExt>(self, w: &W) -> Self
where Self: Sized;
fn center_x<W: WidgetExt>(self, w: &W) -> Self
where Self: Sized;
fn center_y<W: WidgetExt>(self, w: &W) -> Self
where Self: Sized;
fn center_of_parent(self) -> Self
where Self: Sized;
fn size_of<W: WidgetExt>(self, w: &W) -> Self
where Self: Sized;
fn size_of_parent(self) -> Self
where Self: Sized;
fn set_pos(&mut self, x: i32, y: i32);
fn set_size(&mut self, width: i32, height: i32);
fn set_label(&mut self, title: &str);
fn redraw(&mut self);
fn show(&mut self);
fn hide(&mut self);
fn x(&self) -> i32;
fn y(&self) -> i32;
fn width(&self) -> i32;
fn height(&self) -> i32;
fn w(&self) -> i32;
fn h(&self) -> i32;
fn label(&self) -> 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_trigger(&mut self, trigger: CallbackTrigger);
fn trigger(&self) -> CallbackTrigger;
fn as_window(&self) -> Option<Box<dyn WindowExt>>;
fn as_group(&self) -> Option<Group>;
unsafe fn into_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 { ... }
unsafe fn image_mut(&self) -> Option<&mut Image> { ... }
unsafe fn deimage_mut(&self) -> Option<&mut Image> { ... }
}
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§
sourcefn with_size(self, width: i32, height: i32) -> Selfwhere
Self: Sized,
fn with_size(self, width: i32, height: i32) -> Selfwhere
Self: Sized,
Initialize to size width, height
sourcefn with_label(self, title: &str) -> Selfwhere
Self: Sized,
fn with_label(self, title: &str) -> Selfwhere
Self: Sized,
Initialize with a label
sourcefn with_align(self, align: Align) -> Selfwhere
Self: Sized,
fn with_align(self, align: Align) -> Selfwhere
Self: Sized,
Initialize with alignment
sourcefn with_type<T: WidgetType>(self, typ: T) -> Selfwhere
Self: Sized,
fn with_type<T: WidgetType>(self, typ: T) -> Selfwhere
Self: Sized,
Initialize with type
sourcefn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
Initialize at bottom of another widget
sourcefn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
Initialize above of another widget
sourcefn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
Initialize right of another widget
sourcefn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Selfwhere
Self: Sized,
Initialize left of another widget
sourcefn center_of<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
fn center_of<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
Initialize center of another widget
sourcefn center_x<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
fn center_x<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
Initialize center of another widget on the x axis
sourcefn center_y<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
fn center_y<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
Initialize center of another widget on the y axis
sourcefn center_of_parent(self) -> Selfwhere
Self: Sized,
fn center_of_parent(self) -> Selfwhere
Self: Sized,
Initialize center of parent
sourcefn size_of<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
fn size_of<W: WidgetExt>(self, w: &W) -> Selfwhere
Self: Sized,
Initialize to the size of another widget
sourcefn size_of_parent(self) -> Selfwhere
Self: Sized,
fn size_of_parent(self) -> Selfwhere
Self: Sized,
Initialize to the size of the parent
sourcefn set_label(&mut self, title: &str)
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.
sourcefn measure_label(&self) -> (i32, i32)
fn measure_label(&self) -> (i32, i32)
Measures the label’s width and height
sourcefn as_widget_ptr(&self) -> *mut Fl_Widget
fn as_widget_ptr(&self) -> *mut Fl_Widget
transforms a widget to a base Fl_Widget
, for internal use
sourcefn inside<W: WidgetExt>(&self, wid: &W) -> boolwhere
Self: Sized,
fn inside<W: WidgetExt>(&self, wid: &W) -> boolwhere
Self: Sized,
Checks whether the self widget is inside another widget
sourcefn get_type<T: WidgetType>(&self) -> Twhere
Self: Sized,
fn get_type<T: WidgetType>(&self) -> Twhere
Self: Sized,
Returns the widget type when applicable
sourcefn set_type<T: WidgetType>(&mut self, typ: T)where
Self: Sized,
fn set_type<T: WidgetType>(&mut self, typ: T)where
Self: Sized,
Sets the widget type
sourcefn set_image<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
fn set_image<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
Sets the image of the widget
sourcefn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
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
sourcefn image(&self) -> Option<Box<dyn ImageExt>>where
Self: Sized,
fn image(&self) -> Option<Box<dyn ImageExt>>where
Self: Sized,
Gets the image associated with the widget
sourcefn set_deimage<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
Sets the deactivated image of the widget
sourcefn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)where
Self: Sized,
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
sourcefn deimage(&self) -> Option<Box<dyn ImageExt>>where
Self: Sized,
fn deimage(&self) -> Option<Box<dyn ImageExt>>where
Self: Sized,
Gets the deactivated image associated with the widget
sourcefn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)where
Self: Sized,
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
sourcefn emit<T: 'static + Clone + Send + Sync>(&mut self, sender: Sender<T>, msg: T)where
Self: Sized,
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
sourcefn deactivate(&mut self)
fn deactivate(&mut self)
Deactivates the widget
sourcefn redraw_label(&mut self)
fn redraw_label(&mut self)
Redraws the label of the widget
sourcefn resize(&mut self, x: i32, y: i32, width: i32, height: i32)
fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)
Resizes and/or moves the widget, takes x, y, width and height
sourcefn set_tooltip(&mut self, txt: &str)
fn set_tooltip(&mut self, txt: &str)
Sets the tooltip text
sourcefn label_color(&self) -> Color
fn label_color(&self) -> Color
Returns the widget label’s color
sourcefn set_label_color(&mut self, color: Color)
fn set_label_color(&mut self, color: Color)
Sets the widget label’s color
sourcefn label_font(&self) -> Font
fn label_font(&self) -> Font
Returns the widget label’s font
sourcefn set_label_font(&mut self, font: Font)
fn set_label_font(&mut self, font: Font)
Sets the widget label’s font
sourcefn label_size(&self) -> i32
fn label_size(&self) -> i32
Returns the widget label’s size
sourcefn set_label_size(&mut self, sz: i32)
fn set_label_size(&mut self, sz: i32)
Sets the widget label’s size
sourcefn label_type(&self) -> LabelType
fn label_type(&self) -> LabelType
Returns the widget label’s type
sourcefn set_label_type(&mut self, typ: LabelType)
fn set_label_type(&mut self, typ: LabelType)
Sets the widget label’s type
sourcefn set_changed(&mut self)
fn set_changed(&mut self)
Mark the widget as changed
sourcefn clear_changed(&mut self)
fn clear_changed(&mut self)
Clears the changed status of the widget
sourcefn selection_color(&self) -> Color
fn selection_color(&self) -> Color
Gets the selection color of the widget
sourcefn set_selection_color(&mut self, color: Color)
fn set_selection_color(&mut self, color: Color)
Sets the selection color of the widget
sourcefn do_callback(&mut self)
fn do_callback(&mut self)
Runs the already registered callback
sourcefn top_window(&self) -> Option<Box<dyn WindowExt>>
fn top_window(&self) -> Option<Box<dyn WindowExt>>
Returns the topmost window holding the widget
sourcefn takes_events(&self) -> bool
fn takes_events(&self) -> bool
Checks whether a widget is capable of taking events
sourcefn take_focus(&mut self) -> Result<(), FltkError>
fn take_focus(&mut self) -> Result<(), FltkError>
sourcefn set_visible_focus(&mut self)
fn set_visible_focus(&mut self)
Set the widget to have visible focus
sourcefn clear_visible_focus(&mut self)
fn clear_visible_focus(&mut self)
Clear visible focus
sourcefn visible_focus(&mut self, v: bool)
fn visible_focus(&mut self, v: bool)
Set the visible focus using a flag
sourcefn has_visible_focus(&self) -> bool
fn has_visible_focus(&self) -> bool
Return whether the widget has visible focus
sourcefn was_deleted(&self) -> bool
fn was_deleted(&self) -> bool
Check if a widget was deleted
sourcefn set_damage(&mut self, flag: bool)
fn set_damage(&mut self, flag: bool)
Signal the widget as damaged and it should be redrawn in the next event loop cycle
sourcefn damage_type(&self) -> Damage
fn damage_type(&self) -> Damage
Return the damage mask
sourcefn set_damage_type(&mut self, mask: Damage)
fn set_damage_type(&mut self, mask: Damage)
Signal the type of damage a widget received
sourcefn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)
fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)
Signal damage for an area inside the widget
sourcefn clear_damage(&mut self)
fn clear_damage(&mut self)
Clear the damaged flag
sourcefn set_trigger(&mut self, trigger: CallbackTrigger)
fn set_trigger(&mut self, trigger: CallbackTrigger)
Sets the default callback trigger for a widget, equivalent to when()
sourcefn trigger(&self) -> CallbackTrigger
fn trigger(&self) -> CallbackTrigger
Return the callback trigger, equivalent to when()
sourcefn as_window(&self) -> Option<Box<dyn WindowExt>>
fn as_window(&self) -> Option<Box<dyn WindowExt>>
Return the widget as a window if it’s a window
sourceunsafe fn into_widget<W: WidgetBase>(&self) -> Wwhere
Self: Sized,
unsafe fn into_widget<W: WidgetBase>(&self) -> Wwhere
Self: Sized,
Upcast a WidgetExt
to some widget type
Safety
Allows for potentially unsafe casts between incompatible widget types
sourcefn visible_r(&self) -> bool
fn visible_r(&self) -> bool
Returns whether a widget or any of its parents are visible (recursively)
sourcefn is_same<W: WidgetExt>(&self, other: &W) -> boolwhere
Self: Sized,
fn is_same<W: WidgetExt>(&self, other: &W) -> boolwhere
Self: Sized,
Return whether two widgets object point to the same widget
sourcefn active_r(&self) -> bool
fn active_r(&self) -> bool
Returns whether a widget or any of its parents are active (recursively)
sourcefn widget_resize(&mut self, x: i32, y: i32, w: i32, h: i32)
fn widget_resize(&mut self, x: i32, y: i32, w: i32, h: i32)
Does a simple resize ignoring class-specific resize functionality
sourcefn handle_event(&mut self, event: Event) -> bool
fn handle_event(&mut self, event: Event) -> bool
Handle a specific event
Provided Methods§
sourcefn as_base_widget(&self) -> Widgetwhere
Self: Sized,
fn as_base_widget(&self) -> Widgetwhere
Self: Sized,
Upcast a WidgetExt
to a Widget
sourcefn is_derived(&self) -> bool
fn is_derived(&self) -> bool
Check whether a widget is derived
sourceunsafe fn image_mut(&self) -> Option<&mut Image>
unsafe fn image_mut(&self) -> Option<&mut Image>
Get a reference type of the widget’s image
Safety
The widget needs to be still around when the image is accessed
sourceunsafe fn deimage_mut(&self) -> Option<&mut Image>
unsafe fn deimage_mut(&self) -> Option<&mut Image>
Get a reference type of the widget’s deactivated image
Safety
The widget needs to be still around when the image is accessed