Enum slint::platform::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), }
Expand description

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)§

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

A pointer was pressed.

Fields

§button: PointerEventButton

The button that was pressed.

§

PointerReleased

A pointer was released.

Fields

§button: PointerEventButton

The button that was released.

§

PointerMoved

The position of the pointer has changed.

Fields

§

PointerScrolled

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

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.

§

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. 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 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 T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

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>

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

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.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

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> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where 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 T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more