Struct fltk::window::Window

pub struct Window { /* fields omitted */ }

Creates a window widget

Implementations

impl Window

pub unsafe fn find_by_handle(handle: RawHandle) -> Option<Window>

Find an Fl_Window through a raw handle. The window must have been instatiated by the app void pointer to: (Windows: HWND, X11: Xid (u64), MacOS: NSWindow)

Safety

The data must be valid and is OS-dependent.

pub fn show_with_env_args(&mut self)

Use FLTK specific arguments for the application: More info: https://www.fltk.org/doc-1.3/classFl.html#a1576b8c9ca3e900daaa5c36ca0e7ae48 The options are: -bg2 color -bg color -di[splay] host:n.n -dn[d] -fg color -g[eometry] WxH+X+Y -i[conic] -k[bd] -na[me] classname -nod[nd] -nok[bd] -not[ooltips] -s[cheme] scheme -ti[tle] windowtitle -to[oltips]

pub fn show_with_args(&mut self, args: &[&str])

Use FLTK specific arguments for the application: More info: https://www.fltk.org/doc-1.3/classFl.html#a1576b8c9ca3e900daaa5c36ca0e7ae48 The options are: -bg2 color -bg color -di[splay] host:n.n -dn[d] -fg color -g[eometry] WxH+X+Y -i[conic] -k[bd] -na[me] classname -nod[nd] -nok[bd] -not[ooltips] -s[cheme] scheme -ti[tle] windowtitle -to[oltips]

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Window

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

Formats the value using the given formatter.

impl GroupExt for Window

fn begin(&self)

Begins a group, used for widgets implementing the group trait

fn end(&self)

Ends a group, used for widgets implementing the group trait

fn find<Widget: WidgetExt>(&self, widget: &Widget) -> u32

Find a widget within a group and return its index

fn add<Widget: WidgetExt>(&mut self, widget: &Widget)

Add a widget to a group

fn insert<Widget: WidgetExt>(&mut self, widget: &Widget, index: u32)

Insert a widget to a group at a certain index

fn remove<Widget: WidgetExt>(&mut self, widget: &Widget)

Remove a widget from a group, but does not delete it

fn clear(&mut self)

Clear a group from all widgets

unsafe fn unsafe_clear(&mut self)

Clear a group from all widgets and recursively force-cleans capturing callbacks

fn children(&self) -> u32

Return the number of children in a group

fn child(&self, idx: u32) -> Option<Widget>

Return child widget by index

fn resizable<Widget: WidgetExt>(&self, widget: &mut Widget)

Make the passed widget resizable

impl Send for Window

impl Sync for Window

impl WidgetExt for Window

fn new(x: i32, y: i32, width: i32, height: i32, title: &str) -> Window

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

fn default() -> Self

Creates a default and zero initialized widget

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

Initialize to position x, y

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

Initialilze to dimensions width and height

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 with_label(self, title: &str) -> Self

Initialize with label/title

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

Sets the initial alignment of the widget

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

Sets the widget's label

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 label(&self) -> String

Returns the label of the widget

unsafe fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

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

transforms a widget pointer to a 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 tooltip(&self) -> Option<String>

Returns the tooltip text

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

Sets the tooltip text

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

Returns the widget type when applicable

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

Sets the widget type

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_image<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget

fn image(&self) -> Option<Image>

Gets the image associated with the widget

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

Sets the image of the widget

fn deimage(&self) -> Option<Image>

Gets the image associated with the widget

fn set_callback(&mut self, cb: Box<dyn FnMut()>)

Sets the callback when the widget is triggered (clicks for example)

unsafe fn unset_callback(&mut self)

INTERNAL: Unset the defined callback

fn handle(&mut self, cb: Box<dyn FnMut(Event) -> bool>)

Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int) Handled or ignored events shoult return true, unhandled events should return false

fn draw(&mut self, cb: Box<dyn FnMut()>)

Set a custom draw method

fn set_trigger(&mut self, trigger: CallbackTrigger)

Sets the default callback trigger for a widget

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

Positions the widget below w

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

Positions the widget above w

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

Positions the widget to the right of w

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

Positions the widget to the left of w

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

Positions the widget to the center of w

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

Takes the size of w

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

Returns the parent of the widget

fn selection_color(&mut 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 inside(&self, wid: Widget) -> bool

Checks whether the self widget is inside another widget

fn window(&self) -> Option<Window>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Window>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

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

Emits a message on callback using a sender

unsafe fn user_data(&self) -> Option<Box<dyn FnMut()>>

INTERNAL: Retakes ownership of the user callback data

unsafe fn set_user_data(&mut self, data: *mut c_void)

INTERNAL: Manually set the user data

unsafe fn raw_user_data(&self) -> *mut c_void

INTERNAL: Retakes ownership of the user callback data

fn delete(&mut self)

Manually delete a widget

unsafe fn unsafe_delete(&mut self)

Manually delete a widget and recursively force-cleans capturing callbacks

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(&mut self) -> bool

Return whether the widget has visible focus

fn was_deleted(&self) -> bool

Check if a widget was deleted

unsafe fn cleanup(&mut self)

INTERNAL: Cleanup after widget deletion

unsafe fn draw_data(&mut self) -> Option<Box<dyn FnMut()>>

INTERNAL: Retrieve the draw data

unsafe fn set_draw_data(&mut self, data: *mut c_void)

INTERNAL: Manually set the draw data

unsafe fn unset_draw_callback(&mut self)

INTERNAL: Unset the draw callback

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 clear_damage(&mut self)

Clear the damaged flag

fn as_window(&mut self) -> Option<Window>

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

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

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

impl WindowExt for Window

fn center_screen(self) -> Self

Positions the window to the center of the screen

fn make_modal(&mut self, val: bool)

Makes a window modal

fn fullscreen(&mut self, val: bool)

Makes a window fullscreen

fn make_current(&mut self)

Makes the window current

fn set_icon<T: ImageExt>(&mut self, image: Option<T>)

Sets the windows icon

fn icon(&self) -> Option<Image>

Returns the icon of the window

fn make_resizable(&mut self, val: bool)

Make the window resizable

fn set_cursor(&mut self, cursor: Cursor)

Sets the cursor style within the window Needs to be called after the window is shown

fn shown(&self) -> bool

Returns whether a window is shown

fn set_border(&mut self, flag: bool)

Sets whether the window has a border

fn border(&self) -> bool

Returns whether a window has a border

fn raw_handle(&self) -> RawHandle

Get the raw system handle of the window

unsafe fn set_raw_handle(&mut self, handle: RawHandle)

Set the window associated with a raw handle. RawHandle is a void pointer to: (Windows: HWND, X11: Xid (u64), MacOS: NSWindow)

fn region(&self) -> Region

Get the graphical draw region of the window

unsafe fn set_region(&mut self, region: Region)

Set the graphical draw region of the window

fn iconize(&mut self)

Iconifies the window

fn fullscreen_active(&self) -> bool

Returns whether the window is fullscreen or not