Struct egui::output::WidgetInfo

source ·
pub struct WidgetInfo {
    pub typ: WidgetType,
    pub enabled: bool,
    pub label: Option<String>,
    pub current_text_value: Option<String>,
    pub prev_text_value: Option<String>,
    pub selected: Option<bool>,
    pub value: Option<f64>,
    pub text_selection: Option<RangeInclusive<usize>>,
}
Expand description

Describes a widget such as a crate::Button or a crate::TextEdit.

Fields§

§typ: WidgetType

The type of widget this is.

§enabled: bool

Whether the widget is enabled.

§label: Option<String>

The text on labels, buttons, checkboxes etc.

§current_text_value: Option<String>

The contents of some editable text (for TextEdit fields).

§prev_text_value: Option<String>

The previous text value.

§selected: Option<bool>

The current value of checkboxes and radio buttons.

§value: Option<f64>

The current value of sliders etc.

§text_selection: Option<RangeInclusive<usize>>

Selected range of characters in Self::current_text_value.

Implementations§

source§

impl WidgetInfo

source

pub fn new(typ: WidgetType) -> Self

source

pub fn labeled(typ: WidgetType, label: impl ToString) -> Self

source

pub fn selected(typ: WidgetType, selected: bool, label: impl ToString) -> Self

checkboxes, radio-buttons etc

source

pub fn drag_value(value: f64) -> Self

source

pub fn slider(value: f64, label: impl ToString) -> Self

source

pub fn text_edit( prev_text_value: impl ToString, text_value: impl ToString ) -> Self

source

pub fn text_selection_changed( text_selection: RangeInclusive<usize>, current_text_value: impl ToString ) -> Self

source

pub fn description(&self) -> String

This can be used by a text-to-speech system to describe the widget.

Trait Implementations§

source§

impl Clone for WidgetInfo

source§

fn clone(&self) -> WidgetInfo

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for WidgetInfo

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for WidgetInfo

source§

fn eq(&self, other: &WidgetInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for WidgetInfo

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,