Struct egui::output::Output[−][src]

pub struct Output {
    pub cursor_icon: CursorIcon,
    pub open_url: Option<OpenUrl>,
    pub copied_text: String,
    pub needs_repaint: bool,
    pub events: Vec<OutputEvent>,
    pub mutable_text_under_cursor: bool,
    pub text_cursor_pos: Option<Pos2>,
}

Expand description

What egui emits each frame. 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.

needs_repaint: bool

If true, egui is requesting immediate repaint (i.e. on the next frame).

This happens for instance when there is an animation, or if a user has called Context::request_repaint().

As an egui user: don’t set this value directly. Call Context::request_repaint() instead and it will do so for you.

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 egui_web to show/hide mobile keyboard and IME agent.

text_cursor_pos: Option<Pos2>

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

Implementations

impl Output

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.

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)

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Default for Output

fn default() -> Output

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

impl<'de> Deserialize<'de> for Output

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<Output> for Output

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Serialize for Output

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Output

Auto Trait Implementations

impl RefUnwindSafe for Output

impl Send for Output

impl Sync for Output

impl Unpin for Output

impl UnwindSafe for Output

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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