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).
Iff Some
, the user is editing text.
accesskit_update: Option<TreeUpdate>
The difference in the widget tree since last frame.
NOTE: this needs to be per-viewport.
Implementations§
source§impl PlatformOutput
impl PlatformOutput
sourcepub fn open_url(&mut self, url: impl ToString)
👎Deprecated: Use Context::open_url instead
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.
sourcepub fn events_description(&self) -> String
pub fn events_description(&self) -> String
This can be used by a text-to-speech system to describe the events (if any).
Trait Implementations§
source§impl Clone for PlatformOutput
impl Clone for PlatformOutput
source§fn clone(&self) -> PlatformOutput
fn clone(&self) -> PlatformOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for PlatformOutput
impl Default for PlatformOutput
source§fn default() -> PlatformOutput
fn default() -> PlatformOutput
source§impl<'de> Deserialize<'de> for PlatformOutput
impl<'de> Deserialize<'de> for PlatformOutput
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
source§impl PartialEq for PlatformOutput
impl PartialEq for PlatformOutput
source§fn eq(&self, other: &PlatformOutput) -> bool
fn eq(&self, other: &PlatformOutput) -> bool
self
and other
values to be equal, and is used
by ==
.