Enum slint::platform::WindowEvent

#[non_exhaustive]
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: char,
    },
    KeyReleased {
        text: char,
    },
}

A event that describes user input.

Slint backends typically receive events from the windowing system, translate them to this enum and deliver 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

Fields

position: LogicalPosition

button: PointerEventButton

The button that was pressed.

A pointer was pressed.

PointerReleased

Fields

position: LogicalPosition

button: PointerEventButton

The button that was released.

A pointer was released.

PointerMoved

Fields

position: LogicalPosition

The position of the pointer has changed.

PointerScrolled

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.

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

PointerExited

The pointer exited the window.

KeyPressed

Fields

text: char

The unicode representation of the key pressed.

Example

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

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

A key was pressed.

KeyReleased

Fields

text: char

The unicode representation of the key released.

Example

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

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

A key was pressed.

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<WindowEvent> for WindowEvent

fn eq(&self, other: &WindowEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for WindowEvent

impl StructuralPartialEq for WindowEvent