Struct UiEvent 

pub struct UiEvent {
    pub origin: OriginId,
    pub window: WindowId,
    pub key: Key,
    pub payload: Value,
    pub slot: Option<Key>,
}

An event produced by the UI, ready for routing.

Fields

origin: OriginId

window: WindowId

Which window the event came from — a new field and not a second reading of origin, which says which frontend drew the node and answers HOST for a window an extension also draws into.

Most producers cannot fill it in: a hit test and the edit buffer know nothing about windows. They leave it WindowId::MAIN and the core stamps its own env.window.id over it as the event leaves (Core::handle_input, Core::take_pending_events) — one core is one window, so that is the whole answer. The audio store is the exception: its mounts are per window, so a sound event carries the window that declared the node and the stamp leaves it alone. A driver that builds an event itself stamps it itself.

key: Key

payload: Value

slot: Option<Key>

The slot whose fill drew the node — its key, the one begin_slot returned and key_of(full_name) answers — or None for a node the host drew itself. What origin cannot say: one extension fills many slots (a Lua host with a view per pane), and an event routed by pane needs the slot, not the extension. Stamped by the core on the way out like window, from the fill ranges the last frame recorded (Tree::fills); a producer leaves it None.

Implementations

impl UiEvent

pub fn tag(&self) -> Option<&Value>

The app’s tag inside a core event’s payload — onDrag’s, onKey’s — as sent; UiEvent::message reads it typed.

pub fn drag(&self) -> Option<Drag>

This event as a drag, if it is one.

pub fn button(&self) -> Option<ButtonEvent>

This event as a held non-primary button’s press, move or release, if it is one.

pub fn key_press(&self) -> Option<(KeyPhase, KeyPress)>

This event as a key press or release on a key sink, if it is one (key_press, since key is the node the event is about): the KeyPress the core built it from, so a keymap binds the same value a headless press sends.

pub fn text(&self) -> Option<TextInput<'_>>

This event as inserted text, if it is some.

pub fn scroll(&self) -> Option<Scroll>

This event as a wheel scroll, if it is one.

pub fn hover(&self) -> Option<Hover>

This event as a hover edge, if it is one.

pub fn modifiers(&self) -> Option<KeyMods>

This event as a modifier change, if it is one: the keys now held.

pub fn layout(&self) -> Option<Layout>

This event as an onLayout report, if it is one.

impl UiEvent

pub fn on(origin: OriginId, key: Key, payload: Value) -> UiEvent

An event as a producer builds it: the window is left WindowId::MAIN and the slot None for the core to stamp on the way out (see UiEvent::window, UiEvent::slot).

pub fn kind(&self) -> Option<&str>

Merges the node’s tag into a map payload. A Null tag declares the behaviour and names nothing, so it is the one value left out — the rule every row with a tag reads by, stated once. The payload’s kind: what a core event says it is — "drag", "key", "scroll" — or the kind of an app’s own map tag. None for a payload that is not a map or has no string kind.

pub fn tagged(self, tag: Option<&Value>) -> UiEvent

impl UiEvent

pub fn message<M>(&self) -> Option<M>

where M: for<'a> TryFrom<&'a Value>,

The app’s message this event carries, as M: the payload itself for a click (what on_click was handed), and otherwise the tag inside a core event — a drag, a change, a scroll, a drop, a layout — which is what on_drag and the rest were handed. None when neither is an M: a key press, a core event with no tag, another type’s.

The event’s own fields stay on payload — a drag’s phase and x/y, a change’s value — so a handler matches on the message and reads those beside it.

Trait Implementations

impl Clone for UiEvent

fn clone(&self) -> UiEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiEvent

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

Formats the value using the given formatter.

impl PartialEq for UiEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UiEvent