Skip to main content

WindowEvent

Enum WindowEvent 

Source
pub enum WindowEvent {
Show 20 variants Resized(LogicalSize), Moved(LogicalPosition), CloseRequested, Destroyed, DroppedFile(PathBuf), HoveredFile(PathBuf), HoveredFileCancelled, ReceivedCharacter(char), Focused(bool), KeyboardInput { device_id: DeviceId, input: KeyboardInput, }, CursorMoved { device_id: DeviceId, position: LogicalPosition, modifiers: ModifiersState, }, CursorEntered { device_id: DeviceId, }, CursorLeft { device_id: DeviceId, }, MouseWheel { device_id: DeviceId, delta: MouseScrollDelta, phase: TouchPhase, modifiers: ModifiersState, }, MouseInput { device_id: DeviceId, state: ElementState, button: MouseButton, modifiers: ModifiersState, }, TouchpadPressure { device_id: DeviceId, pressure: f32, stage: i64, }, AxisMotion { device_id: DeviceId, axis: AxisId, value: f64, }, Refresh, Touch(Touch), HiDpiFactorChanged(f64),
}
Expand description

Describes an event from a Window.

Variants§

§

Resized(LogicalSize)

The size of the window has changed. Contains the client area’s new dimensions.

§

Moved(LogicalPosition)

The position of the window has changed. Contains the window’s new position.

§

CloseRequested

The window has been requested to close.

§

Destroyed

The window has been destroyed.

§

DroppedFile(PathBuf)

A file has been dropped into the window.

When the user drops multiple files at once, this event will be emitted for each file separately.

§

HoveredFile(PathBuf)

A file is being hovered over the window.

When the user hovers multiple files at once, this event will be emitted for each file separately.

§

HoveredFileCancelled

A file was hovered, but has exited the window.

There will be a single HoveredFileCancelled event triggered even if multiple files were hovered.

§

ReceivedCharacter(char)

The window received a unicode character.

§

Focused(bool)

The window gained or lost focus.

The parameter is true if the window has gained focus, and false if it has lost focus.

§

KeyboardInput

An event from the keyboard has been received.

Fields

§device_id: DeviceId
§

CursorMoved

The cursor has moved on the window.

Fields

§device_id: DeviceId
§position: LogicalPosition

(x,y) coords in pixels relative to the top-left corner of the window. Because the range of this data is limited by the display area and it may have been transformed by the OS to implement effects such as cursor acceleration, it should not be used to implement non-cursor-like interactions such as 3D camera control.

§modifiers: ModifiersState
§

CursorEntered

The cursor has entered the window.

Fields

§device_id: DeviceId
§

CursorLeft

The cursor has left the window.

Fields

§device_id: DeviceId
§

MouseWheel

A mouse wheel movement or touchpad scroll occurred.

Fields

§device_id: DeviceId
§modifiers: ModifiersState
§

MouseInput

An mouse button press has been received.

Fields

§device_id: DeviceId
§modifiers: ModifiersState
§

TouchpadPressure

Touchpad pressure event.

At the moment, only supported on Apple forcetouch-capable macbooks. The parameters are: pressure level (value between 0 and 1 representing how hard the touchpad is being pressed) and stage (integer representing the click level).

Fields

§device_id: DeviceId
§pressure: f32
§stage: i64
§

AxisMotion

Motion on some analog axis. May report data redundant to other, more specific events.

Fields

§device_id: DeviceId
§axis: AxisId
§value: f64
§

Refresh

The window needs to be redrawn.

§

Touch(Touch)

Touch event has been received

§

HiDpiFactorChanged(f64)

The DPI factor of the window has changed.

The following user actions can cause DPI changes:

  • Changing the display’s resolution.
  • Changing the display’s DPI factor (e.g. in Control Panel on Windows).
  • Moving the window to a display with a different DPI factor.

For more information about DPI in general, see the dpi module.

Trait Implementations§

Source§

impl Clone for WindowEvent

Source§

fn clone(&self) -> WindowEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WindowEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WindowEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

Source§

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.