Struct OutgoingEvent 

pub struct OutgoingEvent {
    pub message_type: &'static str,
    pub session: String,
    pub family: String,
    pub id: String,
    pub value: Option<Value>,
    pub tag: Option<String>,
    pub modifiers: Option<KeyModifiers>,
    pub data: Option<Value>,
    pub captured: Option<bool>,
}

An event written to stdout by the renderer.

All events share a flat struct with optional fields. There are two constructor patterns:

• Widget events (click, input, toggle, etc.) use id to identify the source widget. Built via bare.
• Subscription events (key_press, cursor_moved, window_opened, etc.) use tag to identify the subscription that requested them. Built via tagged. The id field is empty.

Extension authors emit custom events via extension_event.

Fields

message_type: &'static str

Always "event".

session: String

Session that produced this event.

family: String

Event type (e.g. "click", "key_press", "window_opened").

id: String

Source widget node ID (widget events) or empty (subscription events).

value: Option<Value>

Primary value payload (e.g. input text, slider value, selected option).

tag: Option<String>

Subscription tag identifying which subscription requested this event.

modifiers: Option<KeyModifiers>

Keyboard modifier state at the time of the event.

data: Option<Value>

Flexible extra data for events that carry additional fields beyond the standard id/value/tag/modifiers shape.

captured: Option<bool>

Whether the event was captured (consumed) by an iced widget before reaching the subscription listener. Present on keyboard, mouse, touch, and IME events; absent on widget-level events.

Implementations

impl OutgoingEvent

pub fn with_captured(self, captured: bool) -> Self

Mark the event with its capture status.

pub fn with_session(self, session: impl Into<String>) -> Self

Set the session ID for this event.

impl OutgoingEvent

pub fn generic( family: impl Into<String>, id: String, data: Option<Value>, ) -> Self

Generic widget event with a family string and optional data payload. Used for on_open, on_close, sort, and other events.

pub fn extension_event(family: String, id: String, data: Option<Value>) -> Self

Convenience constructor for extension-emitted events.

pub fn click(id: String) -> Self

pub fn input(id: String, value: String) -> Self

pub fn submit(id: String, value: String) -> Self

pub fn toggle(id: String, checked: bool) -> Self

pub fn slide(id: String, value: f64) -> Self

pub fn slide_release(id: String, value: f64) -> Self

pub fn select(id: String, value: String) -> Self

pub fn key_press(tag: String, data: &KeyEventData) -> Self

pub fn key_release(tag: String, data: &KeyEventData) -> Self

pub fn modifiers_changed(tag: String, modifiers: KeyModifiers) -> Self

pub fn cursor_moved(tag: String, x: f32, y: f32) -> Self

pub fn cursor_entered(tag: String) -> Self

pub fn cursor_left(tag: String) -> Self

pub fn button_pressed(tag: String, button: String) -> Self

pub fn button_released(tag: String, button: String) -> Self

pub fn wheel_scrolled( tag: String, delta_x: f32, delta_y: f32, unit: &str, ) -> Self

pub fn finger_pressed(tag: String, finger_id: u64, x: f32, y: f32) -> Self

pub fn finger_moved(tag: String, finger_id: u64, x: f32, y: f32) -> Self

pub fn finger_lifted(tag: String, finger_id: u64, x: f32, y: f32) -> Self

pub fn finger_lost(tag: String, finger_id: u64, x: f32, y: f32) -> Self

pub fn ime_opened(tag: String) -> Self

pub fn ime_preedit( tag: String, text: String, cursor: Option<Range<usize>>, ) -> Self

pub fn ime_commit(tag: String, text: String) -> Self

pub fn ime_closed(tag: String) -> Self

pub fn window_opened( tag: String, window_id: String, position: Option<(f32, f32)>, width: f32, height: f32, scale_factor: f32, ) -> Self

pub fn window_closed(tag: String, window_id: String) -> Self

pub fn window_close_requested(tag: String, window_id: String) -> Self

pub fn window_moved(tag: String, window_id: String, x: f32, y: f32) -> Self

pub fn window_resized( tag: String, window_id: String, width: f32, height: f32, ) -> Self

pub fn window_focused(tag: String, window_id: String) -> Self

pub fn window_unfocused(tag: String, window_id: String) -> Self

pub fn window_rescaled( tag: String, window_id: String, scale_factor: f32, ) -> Self

pub fn file_hovered(tag: String, window_id: String, path: String) -> Self

pub fn file_dropped(tag: String, window_id: String, path: String) -> Self

pub fn files_hovered_left(tag: String, window_id: String) -> Self

pub fn animation_frame(tag: String, timestamp_millis: u128) -> Self

pub fn theme_changed(tag: String, mode: String) -> Self

pub fn sensor_resize(id: String, width: f32, height: f32) -> Self

pub fn canvas_press(id: String, x: f32, y: f32, button: String) -> Self

pub fn canvas_release(id: String, x: f32, y: f32, button: String) -> Self

pub fn canvas_move(id: String, x: f32, y: f32) -> Self

pub fn canvas_scroll( id: String, x: f32, y: f32, delta_x: f32, delta_y: f32, ) -> Self

pub fn mouse_right_press(id: String) -> Self

pub fn mouse_right_release(id: String) -> Self

pub fn mouse_middle_press(id: String) -> Self

pub fn mouse_middle_release(id: String) -> Self

pub fn mouse_double_click(id: String) -> Self

pub fn mouse_enter(id: String) -> Self

pub fn mouse_exit(id: String) -> Self

pub fn mouse_area_move(id: String, x: f32, y: f32) -> Self

pub fn mouse_area_scroll(id: String, delta_x: f32, delta_y: f32) -> Self

pub fn pane_resized(id: String, split: String, ratio: f32) -> Self

pub fn pane_dragged( id: String, kind: &str, pane: String, target: Option<String>, region: Option<&str>, edge: Option<&str>, ) -> Self

pub fn pane_clicked(id: String, pane: String) -> Self

pub fn pane_focus_cycle(id: String, pane: String) -> Self

pub fn paste(id: String, text: String) -> Self

pub fn scripting_key_press(key: String, modifiers_json: Value) -> Self

Key press event from scripting (no full KeyEventData).

pub fn scripting_key_release(key: String, modifiers_json: Value) -> Self

Key release event from scripting (no full KeyEventData).

pub fn scripting_cursor_moved(x: f64, y: f64) -> Self

Cursor moved event from scripting.

pub fn scripting_scroll(delta_x: f64, delta_y: f64) -> Self

Scroll event from scripting.

pub fn option_hovered(id: String, value: String) -> Self

pub fn scroll( id: String, abs_x: f32, abs_y: f32, rel_x: f32, rel_y: f32, bounds_w: f32, bounds_h: f32, content_w: f32, content_h: f32, ) -> Self

Trait Implementations

impl Debug for OutgoingEvent

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

Formats the value using the given formatter.

impl Serialize for OutgoingEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.