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
impl PlatformOutput
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).
sourcepub fn take(&mut self) -> Self
pub fn take(&mut self) -> Self
Take everything ephemeral (everything except cursor_icon
currently)
sourcepub fn requested_discard(&self) -> bool
pub fn requested_discard(&self) -> bool
Was crate::Context::request_discard
called?
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 PartialEq for PlatformOutput
impl PartialEq for PlatformOutput
impl StructuralPartialEq for PlatformOutput
Auto Trait Implementations§
impl Freeze for PlatformOutput
impl RefUnwindSafe for PlatformOutput
impl Send for PlatformOutput
impl Sync for PlatformOutput
impl Unpin for PlatformOutput
impl UnwindSafe for PlatformOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)