#[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: SharedString,
    },
    KeyReleased {
        text: SharedString,
    },
}
Expand description

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)ยง

This enum is marked as 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

ยงbutton: PointerEventButton

The button that was pressed.

A pointer was pressed.

ยง

PointerReleased

Fields

ยงbutton: PointerEventButton

The button that was released.

A pointer was released.

ยง

PointerMoved

Fields

The position of the pointer has changed.

ยง

PointerScrolled

Fields

ยง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: 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() };

A key was pressed.

ยง

KeyReleased

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() };

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. Read more
1.0.0 ยท sourceยง

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

Performs copy-assignment from source. Read more
ยง

impl Debug for WindowEvent

ยง

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

Formats the value using the given formatter. Read more
ยง

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 ==.
1.0.0 ยท sourceยง

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

Auto Trait Implementationsยง

Blanket Implementationsยง

sourceยง

impl<T> Any for Twhere T: 'static + ?Sized,

sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
sourceยง

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable ยท sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
sourceยง

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable ยท sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
ยง

impl<T> Downcast for Twhere T: Any,

ยง

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
ยง

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
ยง

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Anyโ€™s vtable from &Traitโ€™s.
ยง

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Anyโ€™s vtable from &mut Traitโ€™s.
sourceยง

impl<T> From<T> for T

const: unstable ยท sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

sourceยง

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable ยท sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

ยง

impl<T> Pointable for T

ยง

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
ยง

type Init = T

The type for initializers.
ยง

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
ยง

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
ยง

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
ยง

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
sourceยง

impl<T> ToOwned for Twhere T: Clone,

ยง

type Owned = T

The resulting type after obtaining ownership.
sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
sourceยง

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

ยง

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable ยท sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
sourceยง

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

ยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable ยท sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.