Struct PlatformOutput

pub struct PlatformOutput {
    pub commands: Vec<OutputCommand>,
    pub cursor_icon: CursorIcon,
    pub open_url: Option<OpenUrl>,
    pub copied_text: String,
    pub events: Vec<OutputEvent>,
    pub mutable_text_under_cursor: bool,
    pub ime: Option<IMEOutput>,
    pub num_completed_passes: usize,
    pub request_discard_reasons: Vec<RepaintCause>,
}

The non-rendering part of what egui emits each frame.

You can access (and modify) this with crate::Context::output.

The backend should use this.

Fields

commands: Vec<OutputCommand>

Commands that the egui integration should execute at the end of a frame.

cursor_icon: CursorIcon

Set the cursor to this icon.

open_url: Option<OpenUrl>

👎Deprecated: Use Context::open_url or PlatformOutput::commands instead

If set, open this url.

copied_text: String

👎Deprecated: Use Context::copy_text or PlatformOutput::commands instead

If set, put this text in the system clipboard. Ignore if empty.

This is often a response to crate::Event::Copy or crate::Event::Cut.

if ui.button("📋").clicked() {
    ui.output_mut(|o| o.copied_text = "some_text".to_string());
}

events: Vec<OutputEvent>

Events that may be useful to e.g. a screen reader.

mutable_text_under_cursor: bool

Is there a mutable TextEdit under the cursor? Use by eframe web to show/hide mobile keyboard and IME agent.

ime: Option<IMEOutput>

This is set if, and only if, the user is currently editing text.

Useful for IME.

num_completed_passes: usize

How many ui passes is this the sum of?

See crate::Context::request_discard for details.

This is incremented at the END of each frame, so this will be 0 for the first pass.

request_discard_reasons: Vec<RepaintCause>

Was crate::Context::request_discard called during the latest pass?

If so, what was the reason(s) for it?

If empty, there was never any calls.

Implementations

impl PlatformOutput

pub fn events_description(&self) -> String

This can be used by a text-to-speech system to describe the events (if any).

pub fn append(&mut self, newer: Self)

Add on new output.

pub fn take(&mut self) -> Self

Take everything ephemeral (everything except cursor_icon currently)

pub fn requested_discard(&self) -> bool

Was crate::Context::request_discard called?

Trait Implementations

impl Clone for PlatformOutput

fn clone(&self) -> PlatformOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PlatformOutput

fn default() -> PlatformOutput

Returns the “default value” for a type.

impl PartialEq for PlatformOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlatformOutput