Struct i_slint_core::window::Window

pub struct Window { /* private fields */ }

Structure that represent a Window in the runtime

Implementations

impl Window

pub fn new(
    platform_window_fn: impl FnOnce(&Weak<Window>) -> Rc<dyn PlatformWindow>
) -> Rc<Self>

Create a new instance of the window, given the platform_window factory fn

pub fn set_component(&self, component: &ComponentRc)

Associates this window with the specified component. Further event handling and rendering, etc. will be done with that component.

pub fn component(&self) -> ComponentRc

return the component. Panics if it wasn’t set.

pub fn try_component(&self) -> Option<ComponentRc>

returns the component or None if it isn’t set.

pub fn process_mouse_input(self: Rc<Self>, event: MouseEvent)

Receive a mouse event and pass it to the items of the component to change their state.

Arguments:

• pos: The position of the mouse event in window physical coordinates.
• what: The type of mouse event.
• component: The Slint compiled component that provides the tree of items.

pub fn process_key_input(self: Rc<Self>, event: &KeyEvent)

Receive a key event and pass it to the items of the component to change their state.

Arguments:

• event: The key event received by the windowing system.
• component: The Slint compiled component that provides the tree of items.

pub fn set_cursor_blink_binding(&self, prop: &Property<bool>)

Installs a binding on the specified property that’s toggled whenever the text cursor is supposed to be visible or not.

pub fn set_focus_item(self: Rc<Self>, focus_item: &ItemRc)

Sets the focus to the item pointed to by item_ptr. This will remove the focus from any currently focused item.

pub fn set_focus(self: Rc<Self>, have_focus: bool)

Sets the focus on the window to true or false, depending on the have_focus argument. This results in WindowFocusReceived and WindowFocusLost events.

pub fn focus_next_item(self: Rc<Self>)

Move keyboard focus to the next item

pub fn focus_previous_item(self: Rc<Self>)

Move keyboard focus to the previous item.

pub fn set_active(&self, active: bool)

Marks the window to be the active window. This typically coincides with the keyboard focus. One exception though is when a popup is shown, in which case the window may remain active but temporarily loose focus to the popup.

pub fn active(&self) -> bool

Returns true of the window is the active window. That typically implies having the keyboard focus, except when a popup is shown and temporarily takes the focus.

pub fn update_window_properties(&self)

If the component’s root item is a Window element, then this function synchronizes its properties, such as the title for example, with the properties known to the windowing system.

pub fn draw_contents(
    self: Rc<Self>,
    render_components: impl FnOnce(&[(&ComponentRc, Point)])
)

Calls the render_components to render the main component and any sub-window components, tracked by a property dependency tracker.

pub fn show(&self)

Registers the window with the windowing system, in order to render the component’s items and react to input events once the event loop spins.

pub fn hide(&self)

De-registers the window with the windowing system.

pub fn set_active_popup(&self, popup: PopupWindow) -> Size

Registers the specified window and component to be considered the active popup. Returns the size of the popup.

pub fn show_popup(
    &self,
    popup: &ComponentRc,
    position: Point,
    parent_item: &ItemRc
)

Show a popup at the given position relative to the item

pub fn close_popup(&self)

Removes any active popup.

pub fn scale_factor(&self) -> f32

Returns the scale factor set on the window, as provided by the windowing system.

pub fn scale_factor_property(&self) -> Pin<&Property<f32>>

Returns the scale factor set on the window, as provided by the windowing system.

pub fn set_scale_factor(&self, factor: f32)

Sets the scale factor for the window. This is set by the backend or for testing.

pub fn default_font_properties(&self) -> FontRequest

Returns the font properties that are set on the root item if it’s a Window item.

pub fn set_window_item_geometry(&self, width: Coord, height: Coord)

Sets the size of the window item. This method is typically called in response to receiving a window resize event from the windowing system. Size is in logical pixels.

pub fn on_close_requested(
    &self,
    callback: impl FnMut() -> CloseRequestResponse + 'static
)

Sets the close_requested callback. The callback will be run when the user tries to close a window.

pub fn request_close(&self) -> bool

Runs the close_requested callback. If the callback returns KeepWindowShown, this function returns false. That should prevent the Window from closing. Otherwise it returns true, which allows the Window to hide.

Trait Implementations

impl Deref for Window

type Target = dyn PlatformWindow + 'static

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.