Struct egui::Output

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>,
}

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.

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

Performs copy-assignment from source.

impl Default for Output

fn default() -> Output

Returns the “default value” for a type.

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.

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 ==.

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.

impl StructuralPartialEq for Output