Enum tao::event::WindowEvent

#[non_exhaustive]
pub enum WindowEvent<'a> {
    Resized(PhysicalSize<u32>),
    Moved(PhysicalPosition<i32>),
    CloseRequested,
    Destroyed,
    DroppedFile(PathBuf),
    HoveredFile(PathBuf),
    HoveredFileCancelled,
    ReceivedImeText(String),
    Focused(bool),
    KeyboardInput {
        device_id: DeviceId,
        event: KeyEvent,
        is_synthetic: bool,
    },
    ModifiersChanged(ModifiersState),
    CursorMoved {
        device_id: DeviceId,
        position: PhysicalPosition<f64>,
        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,
    },
    Touch(Touch),
    ScaleFactorChanged {
        scale_factor: f64,
        new_inner_size: &'a mut PhysicalSize<u32>,
    },
    ThemeChanged(Theme),
    DecorationsClick,
}

Describes an event from a Window.

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.

Resized(PhysicalSize<u32>)

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

Moved(PhysicalPosition<i32>)

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

Platform-specific

• Linux(Wayland): will always be (0, 0) since Wayland doesn’t support a global cordinate system.

CloseRequested

The window has been requested to close.

Destroyed

The window has been destroyed.

Platform-specific

• Windows / Linux: Only fired if the crate::window::Window is dropped.
• macOS: Fired if the crate::window::Window is dropped or the dock Quit item is clicked.

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.

ReceivedImeText(String)

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

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

device_id: DeviceId

event: KeyEvent

is_synthetic: bool

If true, the event was generated synthetically by tao in one of the following circumstances:

• Synthetic key press events are generated for all keys pressed when a window gains focus. Likewise, synthetic key release events are generated for all keys pressed when a window goes out of focus. Currently, this is only functional on Linux and Windows

Otherwise, this value is always false.

An event from the keyboard has been received.

Platform-specific

• Windows: The shift key overrides NumLock. In other words, while shift is held down, numpad keys act as if NumLock wasn’t active. When this is used, the OS sends fake key events which are not marked as is_synthetic.

ModifiersChanged(ModifiersState)

The keyboard modifiers have changed.

CursorMoved

Fields

device_id: DeviceId

position: PhysicalPosition<f64>

(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

👎Deprecated:

Deprecated in favor of WindowEvent::ModifiersChanged

The cursor has moved on the window.

CursorEntered

Fields

device_id: DeviceId

The cursor has entered the window.

CursorLeft

Fields

device_id: DeviceId

The cursor has left the window.

MouseWheel

Fields

device_id: DeviceId

delta: MouseScrollDelta

phase: TouchPhase

modifiers: ModifiersState

👎Deprecated:

Deprecated in favor of WindowEvent::ModifiersChanged

A mouse wheel movement or touchpad scroll occurred.

MouseInput

Fields

device_id: DeviceId

state: ElementState

button: MouseButton

modifiers: ModifiersState

👎Deprecated:

Deprecated in favor of WindowEvent::ModifiersChanged

An mouse button press has been received.

TouchpadPressure

Fields

device_id: DeviceId

pressure: f32

stage: i64

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

AxisMotion

Fields

device_id: DeviceId

axis: AxisId

value: f64

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

Touch(Touch)

Touch event has been received

ScaleFactorChanged

Fields

scale_factor: f64

new_inner_size: &'a mut PhysicalSize<u32>

The window’s scale factor has changed.

The following user actions can cause DPI changes:

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

After this event callback has been processed, the window will be resized to whatever value is pointed to by the new_inner_size reference. By default, this will contain the size suggested by the OS, but it can be changed to any value.

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

ThemeChanged(Theme)

The system window theme has changed.

Applications might wish to react to this to change the theme of the content of the window when the system changes the window theme.

Platform-specific

• Linux / Android / iOS: Unsupported

DecorationsClick

The window decorations has been clicked.

Platform-specific

• Linux / macOS / Android / iOS: Unsupported

Implementations

impl<'a> WindowEvent<'a>

pub fn to_static(self) -> Option<WindowEvent<'static>>

Trait Implementations

impl Clone for WindowEvent<'static>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WindowEvent<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<WindowEvent<'a>> for WindowEvent<'a>

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