Enum tao::event::WindowEvent

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

Describes an event from a Window.

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.

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.

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

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.

Fields of KeyboardInput

device_id: DeviceIdevent: KeyEventis_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.

ModifiersChanged(ModifiersState)

The keyboard modifiers have changed.

CursorMoved

The cursor has moved on the window.

Fields of CursorMoved

device_id: DeviceIdposition: 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

CursorEntered

The cursor has entered the window.

Fields of CursorEntered

device_id: DeviceId

CursorLeft

The cursor has left the window.

Fields of CursorLeft

device_id: DeviceId

MouseWheel

A mouse wheel movement or touchpad scroll occurred.

Fields of MouseWheel

device_id: DeviceIddelta: MouseScrollDeltaphase: TouchPhasemodifiers: ModifiersState

👎 Deprecated:

Deprecated in favor of WindowEvent::ModifiersChanged

MouseInput

An mouse button press has been received.

Fields of MouseInput

device_id: DeviceIdstate: ElementStatebutton: MouseButtonmodifiers: ModifiersState

👎 Deprecated:

Deprecated in favor of WindowEvent::ModifiersChanged

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 of TouchpadPressure

device_id: DeviceIdpressure: f32stage: i64

AxisMotion

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

Fields of AxisMotion

device_id: DeviceIdaxis: AxisIdvalue: f64

Touch(Touch)

Touch event has been received

ScaleFactorChanged

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.

Fields of ScaleFactorChanged

scale_factor: f64new_inner_size: &'a mut PhysicalSize<u32>

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.

At the moment this is only supported on Windows.

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: &WindowEvent<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for WindowEvent<'a>