Struct egui::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 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.
ime: Option<IMEOutput>
This is set if, and only if, the user is currently editing text.
Useful for IME.
accesskit_update: Option<TreeUpdate>
The difference in the widget tree since last frame.
NOTE: this needs to be per-viewport.
Implementations§
Trait Implementations§
source§impl Clone for PlatformOutput
impl Clone for PlatformOutput
source§fn clone(&self) -> PlatformOutput
fn clone(&self) -> PlatformOutput
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Default for PlatformOutput
impl Default for PlatformOutput
source§fn default() -> PlatformOutput
fn default() -> PlatformOutput
Returns the “default value” for a type. Read more
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>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq for PlatformOutput
impl PartialEq for PlatformOutput
source§fn eq(&self, other: &PlatformOutput) -> bool
fn eq(&self, other: &PlatformOutput) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for PlatformOutput
impl Serialize 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
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more