Struct OverlayWindow

pub struct OverlayWindow { /* private fields */ }

Available on crate feature dep_fltk only.

Creates an overlay (buffered) window widget

Implementations

impl OverlayWindow

pub unsafe fn find_by_handle(handle: u64) -> Option<impl WindowExt>

Find an Fl_Window through a raw handle. The window must have been instantiated by the app. void * 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 here. 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 here. 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 set_on_top(&mut self)

Set the window to be on top of other windows. Must only be called after the window has been shown.

pub fn maximize(&mut self)

Maximize the window

pub fn un_maximize(&mut self)

Unmaximize the window

pub fn maximize_active(&self) -> bool

Checks whether the window is maximized

pub fn default_xclass() -> Option<String>

Get the default XA_WM_CLASS property for all windows of your application

pub fn set_default_xclass(s: &str)

Set the default XA_WM_CLASS property for all windows of your application. This should be called before showing with window

impl OverlayWindow

pub fn pixels_per_unit(&self) -> f32

Returns the pixels per unit/point

pub fn pixel_w(&self) -> i32

Gets the window’s width in pixels

pub fn pixel_h(&self) -> i32

Gets the window’s height in pixels

impl OverlayWindow

pub fn flush(&mut self)

Forces the window to be drawn, this window is also made current and calls draw()

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

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

Draw overlay

pub fn redraw_overlay(&self)

Redraw overlay

pub fn can_do_overlay(&self) -> bool

Returns whether the overlay window can do hardware backed overlay

Trait Implementations

impl Clone for OverlayWindow

fn clone(&self) -> OverlayWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayWindow

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

Formats the value using the given formatter.

impl Default for OverlayWindow

fn default() -> OverlayWindow

Returns the “default value” for a type.

impl GroupExt for OverlayWindow

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

Clear a group from all widgets

fn children(&self) -> i32

Return the number of children in a group

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

Return child widget by index

fn find<W>(&self, widget: &W) -> i32

where W: WidgetExt,

Find a widget within a group and return its index

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

where W: WidgetExt,

Add a widget to a group

fn insert<W>(&mut self, widget: &W, index: i32)

where W: WidgetExt,

Insert a widget to a group at a certain index

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

where W: WidgetExt,

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

fn remove_by_index(&mut self, idx: i32)

Remove a child widget by its index

fn resizable<W>(&self, widget: &W)

where W: WidgetExt,

The resizable widget defines both the resizing frame and the resizing behavior of the group and its children.

fn make_resizable(&mut self, val: bool)

Make the group itself resizable, should be called before the widget is shown

fn add_resizable<W>(&mut self, widget: &W)

where W: WidgetExt,

Adds a widget to the group and makes it the resizable widget

fn set_clip_children(&mut self, flag: bool)

Clips children outside the group boundaries

fn clip_children(&self) -> bool

Get whether clip_children is set

fn draw_child<W>(&self, w: &mut W)

where W: WidgetExt,

Draw a child widget, the call should be in a WidgetBase::draw method

fn update_child<W>(&self, w: &mut W)

where W: WidgetExt,

Update a child widget, the call should be in a WidgetBase::draw method

fn draw_outside_label<W>(&self, w: &mut W)

where W: WidgetExt,

Draw the outside label, the call should be in a WidgetBase::draw method

fn draw_children(&mut self)

Draw children, the call should be in a WidgetBase::draw method

fn init_sizes(&mut self)

Resets the internal array of widget sizes and positions

fn bounds(&self) -> Vec<(i32, i32, i32, i32)>

Get the bounds of all children widgets (left, upper, right, bottom)

unsafe fn into_group(&self) -> Group

Converts a widget implementing GroupExt into a Group widget

impl IntoIterator for OverlayWindow

type Item = Widget

The type of the elements being iterated over.

type IntoIter = IntoIter<<OverlayWindow as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <OverlayWindow as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for OverlayWindow

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

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

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() -> OverlayWindow

Constructs a widget with the size of its parent

fn delete(wid: OverlayWindow)

Deletes widgets and their children.

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

transforms a widget pointer to a Widget, for internal use

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

where W: WidgetExt,

Get a widget from base widget

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

where F: FnMut(&mut OverlayWindow, 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 OverlayWindow) + '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 OverlayWindow, 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<OverlayWindow>

where W: WidgetExt,

Cast a type-erased widget back to its original widget

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

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

impl WidgetExt for OverlayWindow

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

where W: WidgetExt,

Initialize center of another widget

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

where W: WidgetExt,

Initialize center of another widget

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

Initialize to a position x, y

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

Initialize to size width, height

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

Initialize with a label

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

Initialize with alignment

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

where T: WidgetType,

Initialize with type

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

where W: WidgetExt,

Initialize at bottom of another widget

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

where W: WidgetExt,

Initialize above of another widget

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

where W: WidgetExt,

Initialize right of another widget

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

where W: WidgetExt,

Initialize left of another widget

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

where W: WidgetExt,

Initialize center of another widget

fn center_of_parent(self) -> OverlayWindow

Initialize center of parent

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

where W: WidgetExt,

Initialize to the size of another widget

fn size_of_parent(self) -> OverlayWindow

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 OverlayWindow) + '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 WindowExt for OverlayWindow

fn center_screen(self) -> OverlayWindow

Positions the window to the center of the screen

fn make_modal(&mut self, val: bool)

Makes a window modal, should be called before show

fn fullscreen(&mut self, val: bool)

Makes a window fullscreen. Requires that the window is resizable.

fn make_current(&mut self)

Makes the window current

fn icon(&self) -> Option<Box<dyn ImageExt>>

Returns the icon of the window

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

where T: ImageExt,

Sets the windows icon. Supported formats are bmp, jpeg, png and rgb.

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

Frees the position of the window

fn raw_handle(&self) -> u64

Get the raw system handle of the window

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. You can tell that the window is iconized by checking that it’s shown and not visible

fn fullscreen_active(&self) -> bool

Returns whether the window is fullscreen or not

fn decorated_w(&self) -> i32

Returns the decorated width

fn decorated_h(&self) -> i32

Returns the decorated height

fn size_range(&mut self, min_w: i32, min_h: i32, max_w: i32, max_h: i32)

Set the window’s minimum width, minimum height, max width and max height. You can pass 0 as max_w and max_h to allow unlimited upward resize of the window.

fn hotspot<W>(&mut self, w: &W)

where W: WidgetExt,

Set the hotspot widget of the window

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

where I: ImageExt,

Set the shape of the window. Supported image formats are BMP, RGB and Pixmap. The window covers non-transparent/non-black shape of the image. The image must not be scaled(resized) beforehand. The size will be adapted to the window’s size

fn shape(&self) -> Option<Box<dyn ImageExt>>

Get the shape of the window

fn x_root(&self) -> i32

Get the window’s x coord from the screen

fn y_root(&self) -> i32

Get the window’s y coord from the screen

fn set_cursor_image(&mut self, image: RgbImage, hot_x: i32, hot_y: i32)

Set the cursor image

fn default_cursor(&mut self, cursor: Cursor)

Set the window’s default cursor

fn screen_num(&self) -> i32

Get the screen number

fn set_screen_num(&mut self, n: i32)

Set the screen number

fn wait_for_expose(&self)

wait for the window to be displayed after calling show(). More info here

fn opacity(&self) -> f64

Get the window’s opacity

fn set_opacity(&mut self, val: f64)

Set the window’s opacity, Ranges from 0.0 to 1.0, where 1.0 is fully opaque and 0.0 is fully transparent. This should be called on a shown window. On X11, opacity support depends on the window manager and can be queried:

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

Get the window’s XA_WM_CLASS property

fn set_xclass(&mut self, s: &str)

Set the window’s XA_WM_CLASS property. This should be called before showing the window

fn clear_modal_states(&mut self)

Clear the modal state of the window

fn force_position(&mut self, flag: bool)

Forces the position of the window

fn set_override(&mut self)

removes the window border and sets the window on top, by settings the NOBORDER and OVERRIDE flags

fn is_override(&self) -> bool

Checks whether the OVERRIDE flag was set

fn set_icon_label(&mut self, label: &str)

Set the icon label

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

Get the icon label

impl Eq for OverlayWindow

impl Send for OverlayWindow

impl Sync for OverlayWindow