Skip to main content

PlatformInput

gpui

Enum PlatformInput 

Source 
pub enum PlatformInput {

Show 15 variants    KeyDown(KeyDownEvent),
    KeyUp(KeyUpEvent),
    ModifiersChanged(ModifiersChangedEvent),
    MouseDown(MouseDownEvent),
    MouseUp(MouseUpEvent),
    MousePressure(MousePressureEvent),
    MouseMove(MouseMoveEvent),
    MouseExited(MouseExitEvent),
    Scroll(ScrollEvent),
    Pinch(PinchEvent),
    LongPress(LongPressEvent),
    TouchDrag(TouchDragEvent),
    BackGesture(BackGestureEvent),
    FileDrop(FileDropEvent),
    Touch(TouchEvent),

}
Expand description

An enum corresponding to all kinds of platform input events.

Variants§

§

KeyDown(KeyDownEvent)

A key was pressed.

§

KeyUp(KeyUpEvent)

A key was released.

§

ModifiersChanged(ModifiersChangedEvent)

The keyboard modifiers were changed.

§

MouseDown(MouseDownEvent)

The mouse was pressed.

§

MouseUp(MouseUpEvent)

The mouse was released.

§

MousePressure(MousePressureEvent)

Mouse pressure.

§

MouseMove(MouseMoveEvent)

The mouse was moved.

§

MouseExited(MouseExitEvent)

The mouse exited the window.

§

Scroll(ScrollEvent)

A mouse wheel or trackpad scrolled. Touch pans reach the window as PlatformInput::Touch and are recognized into scrolls by GPUI.

§

Pinch(PinchEvent)

A pinch gesture was performed.

§

LongPress(LongPressEvent)

A long-press gesture recognized from touch input.

§

TouchDrag(TouchDragEvent)

A direct touch drag claimed by an element.

§

BackGesture(BackGestureEvent)

A back-navigation gesture recognized by the platform.

§

FileDrop(FileDropEvent)

Files were dragged and dropped onto the window.

§

Touch(TouchEvent)

A raw touch event on a touch screen.

Implementations§

Source§

impl PlatformInput

Source

pub fn kind_name(&self) -> &'static str

A short static name for this input’s variant, for diagnostics and telemetry.

Source

pub fn touch_event(&self) -> Option<&TouchEvent>

Returns the touch event contained in this input, if any.

Trait Implementations§

Source§

impl Clone for PlatformInput

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlatformInput

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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