Struct EventCx 

pub struct EventCx<'a, Msg> { /* private fields */ }

Event handling context.

Implementations

impl<Msg> EventCx<'_, Msg>

pub fn id(&self) -> WidgetId

The id of the widget handling the event.

pub fn area(&self) -> Rect

The area the widget was painted in during the last frame.

pub fn focused_area(&self) -> Option<Rect>

The area the focused widget was painted in during the last frame, if a widget has focus. Lets a container place something next to the focused child, e.g. a context menu opened from the keyboard.

pub fn env(&self) -> &Env

The environment.

pub fn now(&self) -> Duration

Time since the runtime started.

pub fn emit(&mut self, message: Msg)

Sends a message to the application.

pub fn memory<T: Default + 'static>(&mut self) -> &mut T

This widget’s state of type T.

pub fn is_focused(&self) -> bool

Whether this widget has keyboard focus.

pub fn request_focus(&mut self)

Moves keyboard focus to this widget.

pub fn focus_next(&mut self)

Moves keyboard focus to the next widget in focus order, as Tab does. Forms use it to go to the next field on Enter.

pub fn forward(&mut self, node: &Node<Msg>, rect: Rect, event: &Event) -> bool

where Msg: 'static,

Offers event to a child node painted in rect, as if the child had received it: the child keeps its own memory, and its messages and requests go out with this widget’s. For widgets that take focus as one control and let a child act, e.g. a settings row passing Space to its switch. Returns whether the child used the event.

pub fn capture_keys(&mut self, on: bool)

While on, every key event goes to this widget first (an open dropdown), and a pointer press on any other widget, including one inside it, first sends it Event::PointerOutside and then reaches that widget as usual. A press on this widget itself reaches only this widget.

pub fn capture_pointer(&mut self)

Keeps pointer events flowing to this widget until the button is released.

pub fn flash(&mut self)

Flashes this widget to confirm an activation.

pub fn copy(&mut self, text: impl Into<String>)

Copies text to the system clipboard.

pub fn run_action(&mut self, scope: Scope, action: impl Into<String>)

Runs keymap action action of scope as if its key had been pressed, after this event. Application actions reach App::action even while a modal layer is open, since the user asked for them explicitly (e.g. from a command palette).

pub fn repeat_pointer(&mut self, interval: Duration)

While the pointer is captured, delivers a Drag event at the last pointer position to this widget every interval until the button is released, as if the pointer moved in place. Terminals send nothing while a button is held still; this lets a widget react to how long it is held (hold-to-confirm, auto-repeating steppers). Call it together with EventCx::capture_pointer on the button press.

pub fn stop_pointer_repeat(&mut self)

Ends the repeat EventCx::repeat_pointer started for this widget before the button is released, so a widget that needs timed drags only for a while (scrolling while a dragged item rests against an edge) does not keep waking the loop afterwards. A repeat asked for in the same event wins. Nothing happens when this widget has no repeat running.