[go: up one dir, main page]

Struct egui::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 text_cursor: 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

Response to crate::Event::Copy or crate::Event::Cut. Ignore if empty.

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.

text_cursor: Option<Pos2>

Position of text widgts’ cursor

Implementations

impl Output[src]

pub fn open_url(&mut self, url: impl ToString)[src]

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[src]

This can be used by a text-to-speech system to describe the events (if any).

Trait Implementations

impl Clone for Output[src]

fn clone(&self) -> Output[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Default for Output[src]

fn default() -> Output[src]

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

impl PartialEq<Output> for Output[src]

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

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

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

This method tests for !=.

impl StructuralPartialEq for Output[src]

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, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

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

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

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>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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>[src]

Performs the conversion.