Struct PlatformOutput

Source

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 accesskit_update: Option<TreeUpdate>,
    pub num_completed_passes: usize,
    pub request_discard_reasons: Vec<RepaintCause>,
}

Expand description

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.

§accesskit_update: Option<TreeUpdate>

The difference in the widget tree since last frame.

NOTE: this needs to be per-viewport.

§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§

Source §

impl PlatformOutput

Source

pub fn events_description(&self) -> String

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

Source

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

Add on new output.

Source

pub fn take(&mut self) -> Self

Take everything ephemeral (everything except cursor_icon currently)

Source

pub fn requested_discard(&self) -> bool

Was crate::Context::request_discard called?

Trait Implementations§

Source §

impl Clone for PlatformOutput

Source §

fn clone(&self) -> PlatformOutput

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Default for PlatformOutput

Source §

fn default() -> PlatformOutput

Returns the “default value” for a type. Read more

Source §

impl<'de> Deserialize<'de> for PlatformOutput

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl PartialEq for PlatformOutput

Source §

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

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

1.0.0 · Source§

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

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

Source §

impl Serialize for PlatformOutput

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Source §

impl StructuralPartialEq for PlatformOutput

Auto Trait Implementations§

§

impl UnwindSafe for PlatformOutput

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §