[go: up one dir, main page]

Struct egui::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 text_cursor_pos: Option<Pos2>,
    pub accesskit_update: Option<TreeUpdate>,
}
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.

§text_cursor_pos: Option<Pos2>

Screen-space position of text edit cursor (used for IME).

§accesskit_update: Option<TreeUpdate>

Implementations§

source§

impl PlatformOutput

source

pub fn open_url(&mut self, url: impl ToString)

Open the given url in a web browser. If egui is running in a browser, the same tab will be reused.

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)

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<'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<PlatformOutput> for PlatformOutput

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

const: unstable · 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 Twhere
T: Clone,

§

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 Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,

source§

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