Trait fltk::prelude::WidgetExt [−][src]
pub unsafe trait WidgetExt {
Show 94 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_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);
unsafe 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(&mut 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(&mut self) -> bool;
fn has_focus(&mut 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 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 user_data(&self) -> Option<Box<dyn FnMut()>>;
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);
}
Expand description
Defines the methods implemented by all widgets
Required methods
Initialize to size width, height
fn with_label(self, title: &str) -> Self where
Self: Sized,
fn with_label(self, title: &str) -> Self where
Self: Sized,
Initialize with a label
fn with_align(self, align: Align) -> Self where
Self: Sized,
fn with_align(self, align: Align) -> Self where
Self: Sized,
Initialize with alignment
fn with_type<T: WidgetType>(self, typ: T) -> Self where
Self: Sized,
fn with_type<T: WidgetType>(self, typ: T) -> Self where
Self: Sized,
Initialize with type
Initialize at bottom of another widget
Initialize above of another widget
Initialize right of another widget
Initialize left of another widget
Initialize center of another widget
fn center_of_parent(self) -> Self where
Self: Sized,
fn center_of_parent(self) -> Self where
Self: Sized,
Initialize center of parent
Initialize to the size of another widget
fn size_of_parent(self) -> Self where
Self: Sized,
fn size_of_parent(self) -> Self where
Self: Sized,
Initialize to the size of the parent
Sets the widget’s label.
labels support special symbols preceded by an @
sign.
and for the associated formatting.
unsafe fn as_widget_ptr(&self) -> *mut Fl_Widget
unsafe fn as_widget_ptr(&self) -> *mut Fl_Widget
transforms a widget to a base Fl_Widget
, for internal use
Safety
Can return multiple mutable pointers to the same widget
Checks whether the self widget is inside another widget
fn get_type<T: WidgetType>(&self) -> T where
Self: Sized,
fn get_type<T: WidgetType>(&self) -> T where
Self: Sized,
Returns the widget type when applicable
fn 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
Sets the image of the widget
fn 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
Gets the image associated with the widget
fn 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 deactived image of the widget
fn 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
Gets the deactivated image associated with the widget
fn 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
Emits a message on callback using a sender
fn deactivate(&mut self)
fn deactivate(&mut self)
Deactivates the widget
fn redraw_label(&mut self)
fn redraw_label(&mut self)
Redraws the label of the widget
Resizes and/or moves the widget, takes x, y, width and height
fn set_tooltip(&mut self, txt: &str)
fn set_tooltip(&mut self, txt: &str)
Sets the tooltip text
fn label_color(&self) -> Color
fn label_color(&self) -> Color
Returns the widget label’s color
fn set_label_color(&mut self, color: Color)
fn set_label_color(&mut self, color: Color)
Sets the widget label’s color
fn label_font(&self) -> Font
fn label_font(&self) -> Font
Returns the widget label’s font
fn set_label_font(&mut self, font: Font)
fn set_label_font(&mut self, font: Font)
Sets the widget label’s font
fn label_size(&self) -> i32
fn label_size(&self) -> i32
Returns the widget label’s size
fn set_label_size(&mut self, sz: i32)
fn set_label_size(&mut self, sz: i32)
Sets the widget label’s size
fn label_type(&self) -> LabelType
fn label_type(&self) -> LabelType
Returns the widget label’s type
fn set_label_type(&mut self, typ: LabelType)
fn set_label_type(&mut self, typ: LabelType)
Sets the widget label’s type
fn set_changed(&mut self)
fn set_changed(&mut self)
Mark the widget as changed
fn clear_changed(&mut self)
fn clear_changed(&mut self)
Clears the changed status of the widget
fn selection_color(&mut self) -> Color
fn selection_color(&mut self) -> Color
Gets the selection color of the widget
fn set_selection_color(&mut self, color: Color)
fn set_selection_color(&mut self, color: Color)
Sets the selection color of the widget
fn do_callback(&mut self)
fn do_callback(&mut self)
Runs the already registered callback
fn top_window(&self) -> Option<Box<dyn WindowExt>>
fn top_window(&self) -> Option<Box<dyn WindowExt>>
Returns the topmost window holding the widget
fn takes_events(&self) -> bool
fn takes_events(&self) -> bool
Checks whether a widget is capable of taking events
fn take_focus(&mut self) -> Result<(), FltkError>
fn take_focus(&mut self) -> Result<(), FltkError>
fn set_visible_focus(&mut self)
fn set_visible_focus(&mut self)
Set the widget to have visible focus
fn clear_visible_focus(&mut self)
fn clear_visible_focus(&mut self)
Clear visible focus
fn visible_focus(&mut self, v: bool)
fn visible_focus(&mut self, v: bool)
Set the visible focus using a flag
fn has_visible_focus(&mut self) -> bool
fn has_visible_focus(&mut self) -> bool
Return whether the widget has visible focus
fn was_deleted(&self) -> bool
fn was_deleted(&self) -> bool
Check if a widget was deleted
fn 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
fn damage_type(&self) -> Damage
fn damage_type(&self) -> Damage
Return the damage mask
fn set_damage_type(&mut self, mask: Damage)
fn set_damage_type(&mut self, mask: Damage)
Signal the type of damage a widget received
fn clear_damage(&mut self)
fn clear_damage(&mut self)
Clear the damaged flag
fn set_trigger(&mut self, trigger: CallbackTrigger)
fn set_trigger(&mut self, trigger: CallbackTrigger)
Sets the default callback trigger for a widget, equivalent to when()
fn trigger(&self) -> CallbackTrigger
fn trigger(&self) -> CallbackTrigger
Return the callback trigger, equivalent to when()
Return the widget as a window if it’s a window
INTERNAL: Retakes ownership of the user callback data
Safety
Can return multiple mutable references to the user_data
unsafe fn into_widget<W: WidgetBase>(&self) -> W where
Self: Sized,
unsafe fn into_widget<W: WidgetBase>(&self) -> W where
Self: Sized,
Upcast a WidgetExt
to a Widget
Safety
Allows for potentially unsafe casts between incompatible widget types
Returns whether a widget or any of its parents are visible (recursively)
Return whether two widgets object point to the same widget
Returns whether a widget or any of its parents are active (recursively)
Does a simple resize ignoring class-specific resize functionality
fn handle_event(&mut self, event: Event)
fn handle_event(&mut self, event: Event)
Handle a specific event