Skip to main content

InputOptions

Struct InputOptions 

Source
pub struct InputOptions {
    pub line_scroll_speed: f32,
    pub scroll_zoom_speed: f32,
    pub max_click_dist: f32,
    pub max_click_duration: f64,
    pub max_double_click_delay: f64,
    pub zoom_modifier: Modifiers,
    pub horizontal_scroll_modifier: Modifiers,
    pub vertical_scroll_modifier: Modifiers,
    pub surrender_focus_on: SurrenderFocusOn,
}
Expand description

Options for input state handling.

Fields§

§line_scroll_speed: f32

Multiplier for the scroll speed when reported in crate::MouseWheelUnit::Lines.

§scroll_zoom_speed: f32

Controls the speed at which we zoom in when doing ctrl/cmd + scroll.

§max_click_dist: f32

After a pointer-down event, if the pointer moves more than this, it won’t become a click.

§max_click_duration: f64

If the pointer is down for longer than this it will no longer register as a click.

If a touch is held for this many seconds while still, then it will register as a “long-touch” which is equivalent to a secondary click.

This is to support “press and hold for context menu” on touch screens.

§max_double_click_delay: f64

The new pointer press must come within this many seconds from previous pointer release for double click (or when this value is doubled, triple click) to count.

§zoom_modifier: Modifiers

When this modifier is down, all scroll events are treated as zoom events.

The default is CTRL/CMD, and it is STRONGLY recommended to NOT change this.

§horizontal_scroll_modifier: Modifiers

When this modifier is down, all scroll events are treated as horizontal scrolls, and when combined with Self::zoom_modifier it will result in zooming on only the horizontal axis.

The default is SHIFT, and it is STRONGLY recommended to NOT change this.

§vertical_scroll_modifier: Modifiers

When this modifier is down, all scroll events are treated as vertical scrolls, and when combined with Self::zoom_modifier it will result in zooming on only the vertical axis.

§surrender_focus_on: SurrenderFocusOn

When should we surrender focus from the focused widget?

Implementations§

Source§

impl InputOptions

Source

pub fn ui(&mut self, ui: &mut Ui)

Show the options in the ui.

Trait Implementations§

Source§

impl Clone for InputOptions

Source§

fn clone(&self) -> InputOptions

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 Copy for InputOptions

Source§

impl Debug for InputOptions

Source§

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

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

impl Default for InputOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for InputOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for InputOptions

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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.