Struct AdaptEventCx 

pub struct AdaptEventCx<'a: 'b, 'b> { /* private fields */ }

An EventCx with embedded Id and input data

NOTE: this is a temporary design: it may be expanded or integrated with EventCx in the future.

Implementations

impl<'a: 'b, 'b> AdaptEventCx<'a, 'b>

pub fn new(cx: &'b mut EventCx<'a>, id: Id) -> Self

Construct

pub fn id(&self) -> Id

Get the widget’s identifier

pub fn is_disabled(&self) -> bool

Check whether this widget is disabled

pub fn set_disabled(&mut self, state: bool)

Set/unset disabled status for this widget

pub fn request_timer(&mut self, handle: TimerHandle, delay: Duration)

Schedule a timed update

Widget updates may be used for delayed action. For animation, prefer to use Draw::animate or Self::request_frame_timer.

This widget will receive an update for timer handle at approximately time = now + delay (or possibly a little later due to frame-rate limiters and processing time).

Requesting an update with delay == 0 is valid except from a timer handler where it may cause an infinite loop.

Multiple timer requests with the same id and handle are merged (see TimerHandle documentation).

pub fn request_frame_timer(&mut self, handle: TimerHandle)

Schedule a frame timer update

Widget id will receive Event::Timer with this handle either before or soon after the next frame is drawn.

This may be useful for animations which mutate widget state. Animations which don’t mutate widget state may use Draw::animate instead.

It is expected that handle.earliest() == true (style guide).

Methods from Deref<Target = EventState>

pub fn has_input_focus(&self, w_id: &Id) -> Option<bool>

Get whether this widget has input focus

Return values:

• None if the widget does not have selection focus
• Some(false) if the widget has selection focus but not keyboard or IME focus
• Some(true) if the widget has keyboard and/or IME focus

pub fn modifiers(&self) -> ModifiersState

Get the current modifier state

pub fn has_nav_focus(&self, w_id: &Id) -> bool

Get whether this widget has navigation focus

pub fn nav_focus(&self) -> Option<&Id>

Get the current navigation focus, if any

This is the widget selected by navigating the UI with the Tab key.

Note: changing navigation focus (e.g. via EventCx::clear_nav_focus, EventCx::request_nav_focus or EventCx::next_nav_focus) does not immediately affect the result of this method.

pub fn is_depressed(&self, w_id: &Id) -> bool

Check whether the given widget is visually depressed

pub fn is_under_mouse(&self, w_id: &Id) -> bool

Get whether the widget is under the mouse pointer

pub fn any_grab_on(&self, id: &Id) -> bool

Returns true if there is a mouse or touch grab on id or any descendant of id

pub fn press_velocity(&self, source: PressSource) -> Option<Vec2>

Get velocity of the mouse pointer or a touch

The velocity is calculated at the time this method is called using existing samples of motion.

Where the source is a mouse this always succeeds. For touch events this requires an active grab and is not guaranteed to succeed; currently only a limited number of presses with mode GrabMode::Grab are tracked for velocity.

pub fn platform(&self) -> Platform

Get the platform

pub fn window_has_focus(&self) -> bool

True when the window has focus

pub fn is_disabled(&self, w_id: &Id) -> bool

Check whether a widget is disabled

A widget is disabled if any ancestor is.

pub fn config(&self) -> &WindowConfig

Access configuration data

All widgets will be reconfigured if configuration data changes.

pub fn config_enable_pan(&self, source: PressSource) -> bool

Is mouse panning enabled?

pub fn config_enable_mouse_text_pan(&self) -> bool

Is mouse text panning enabled?

pub fn config_test_pan_thresh(&self, dist: Offset) -> bool

Test pan threshold against config, adjusted for scale factor

Returns true when dist is large enough to switch to pan mode.

Trait Implementations

impl<'a: 'b, 'b> Deref for AdaptEventCx<'a, 'b>

type Target = &'b mut EventCx<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a: 'b, 'b> DerefMut for AdaptEventCx<'a, 'b>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.