Struct xplm::window::KeyEvent

source ·
pub struct KeyEvent { /* private fields */ }
Expand description

An event associated with a key press

Implementations§

source§

impl KeyEvent

source

pub fn char(&self) -> Option<char>

Returns the character corresponding to the key associated with this event, if one exists

Some key combinations, including combinations with non-Shift modifiers, may not have corresponding characters.

source

pub fn key(&self) -> Key

Returns the key associated with this event

source

pub fn control_pressed(&self) -> bool

Returns true if the control key was held down when the action occurred

source

pub fn option_pressed(&self) -> bool

Returns true if the option/alt key was held down when the action occurred

source

pub fn shift_pressed(&self) -> bool

Returns true if a shift key was held down when the action occurred

source

pub fn action(&self) -> KeyAction

Returns the key action that occurred

Trait Implementations§

source§

impl Debug for KeyEvent

source§

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

Formats the value using the given formatter. Read more

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