Struct EventWindowConfig

pub struct EventWindowConfig<'a>(/* private fields */);

Accessor to event configuration

This is a helper to read event configuration, adapted for the current application and window scale.

Implementations

impl<'a> EventWindowConfig<'a>

pub fn base(&self) -> Ref<'_, EventConfig>

Access base (unscaled) event EventConfig

pub fn menu_delay(&self) -> Duration

Delay before opening/closing menus on mouse hover

pub fn touch_select_delay(&self) -> Duration

Delay before switching from panning to (text) selection mode

pub fn scroll_flick_timeout(&self) -> Duration

Controls activation of glide/momentum scrolling

This is the maximum time between the last press-movement and final release to activate momentum scrolling mode. The last few PressMove events within this time window are used to calculate the initial speed.

pub fn scroll_flick_decay(&self) -> (f32, f32)

Scroll flick velocity decay: (mul, sub)

The mul factor describes exponential decay: effectively, velocity is multiplied by mul every second. This is the dominant decay factor at high speeds; mul = 1.0 implies no decay while mul = 0.0 implies an instant stop.

The sub factor describes linear decay: effectively, speed is reduced by sub every second. This is the dominant decay factor at low speeds. Units are pixels/second (output is adjusted for the window’s scale factor).

pub fn scroll_distance(&self, lines: (f32, f32)) -> Offset

Get distance in pixels to scroll due to mouse wheel

Calculates scroll distance from (horiz, vert) lines.

pub fn pan_dist_thresh(&self) -> f32

Drag distance threshold before panning (scrolling) starts

When the distance moved is greater than this threshold, panning should start; otherwise the system should wait for the text-selection timer. We currently recommend the L-inf distance metric (max of abs of values).

Units are pixels (output is adjusted for the window’s scale factor).

pub fn mouse_pan(&self) -> MousePan

When to pan general widgets (unhandled events) with the mouse

pub fn mouse_text_pan(&self) -> MousePan

When to pan text fields with the mouse

pub fn mouse_nav_focus(&self) -> bool

Whether mouse clicks set keyboard navigation focus

pub fn touch_nav_focus(&self) -> bool

Whether touchscreen events set keyboard navigation focus

Trait Implementations

impl<'a> Clone for EventWindowConfig<'a>

fn clone(&self) -> EventWindowConfig<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EventWindowConfig<'a>

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

Formats the value using the given formatter.