Struct egui::data::output::PlatformOutput

source ·
pub struct PlatformOutput {
    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>,
}
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§

§cursor_icon: CursorIcon

Set the cursor to this icon.

§open_url: Option<OpenUrl>

If set, open this url.

§copied_text: String

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§

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

Trait Implementations§

source§

impl Clone for PlatformOutput

source§

fn clone(&self) -> PlatformOutput

Returns a copy 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 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 StructuralPartialEq for PlatformOutput

Auto Trait Implementations§

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,