Enum WindowEvent

#[non_exhaustive]
#[repr(u32)]
pub enum WindowEvent {
    PointerPressed {
        position: LogicalPosition,
        button: PointerEventButton,
    },
    PointerReleased {
        position: LogicalPosition,
        button: PointerEventButton,
    },
    PointerMoved {
        position: LogicalPosition,
    },
    PointerScrolled {
        position: LogicalPosition,
        delta_x: f32,
        delta_y: f32,
    },
    PointerExited,
    KeyPressed {
        text: SharedString,
    },
    KeyPressRepeated {
        text: SharedString,
    },
    KeyReleased {
        text: SharedString,
    },
    ScaleFactorChanged {
        scale_factor: f32,
    },
    Resized {
        size: LogicalSize,
    },
    CloseRequested,
    WindowActiveChanged(bool),
}

A event that describes user input or windowing system events.

Slint backends typically receive events from the windowing system, translate them to this enum and deliver them to the scene of items via slint::Window::dispatch_event().

The pointer variants describe events originating from an input device such as a mouse or a contact point on a touch-enabled surface.

All position fields are in logical window coordinates.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PointerPressed

A pointer was pressed.

Fields

position: LogicalPosition

button: PointerEventButton

The button that was pressed.

PointerReleased

A pointer was released.

Fields

position: LogicalPosition

button: PointerEventButton

The button that was released.

PointerMoved

The position of the pointer has changed.

Fields

position: LogicalPosition

PointerScrolled

The wheel button of a mouse was rotated to initiate scrolling.

Fields

position: LogicalPosition

delta_x: f32

The amount of logical pixels to scroll in the horizontal direction.

delta_y: f32

The amount of logical pixels to scroll in the vertical direction.

PointerExited

The pointer exited the window.

KeyPressed

A key was pressed.

Fields

text: SharedString

The unicode representation of the key pressed.

Example

A specific key can be mapped to a unicode by using the Key enum

let _ = slint::platform::WindowEvent::KeyPressed { text: slint::platform::Key::Shift.into() };

KeyPressRepeated

A key press was auto-repeated.

Fields

text: SharedString

The unicode representation of the key pressed.

Example

A specific key can be mapped to a unicode by using the Key enum

let _ = slint::platform::WindowEvent::KeyPressRepeated { text: slint::platform::Key::Shift.into() };

KeyReleased

A key was released.

Fields

text: SharedString

The unicode representation of the key released.

Example

A specific key can be mapped to a unicode by using the Key enum

let _ = slint::platform::WindowEvent::KeyReleased { text: slint::platform::Key::Shift.into() };

ScaleFactorChanged

The window’s scale factor has changed. This can happen for example when the display’s resolution changes, the user selects a new scale factor in the system settings, or the window is moved to a different screen. Platform implementations should dispatch this event also right after the initial window creation, to set the initial scale factor the windowing system provided for the window.

Fields

scale_factor: f32

The window system provided scale factor to map logical pixels to physical pixels.

Resized

The window was resized.

The backend must send this event to ensure that the width and height property of the root Window element are properly set.

Fields

size: LogicalSize

The new logical size of the window

CloseRequested

The user requested to close the window.

The backend should send this event when the user tries to close the window,for example by pressing the close button.

This will have the effect of invoking the callback set in Window::on_close_requested() and then hiding the window depending on the return value of the callback.

WindowActiveChanged(bool)

The Window was activated or de-activated.

The backend should dispatch this event with true when the window gains focus and false when the window loses focus.

Implementations

impl WindowEvent

pub fn position(&self) -> Option<LogicalPosition>

The position of the cursor for this event, if any

Trait Implementations

impl Clone for WindowEvent

fn clone(&self) -> WindowEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowEvent

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

Formats the value using the given formatter.

impl PartialEq for WindowEvent

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