Struct me3_framework::overlay::WidgetInfo

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>>,
}

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

impl WidgetInfo

pub fn new(typ: WidgetType) -> WidgetInfo

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

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

checkboxes, radio-buttons etc

pub fn drag_value(value: f64) -> WidgetInfo

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

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

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

pub fn description(&self) -> String

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

Trait Implementations

impl Clone for WidgetInfo

fn clone(&self) -> WidgetInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetInfo

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

Formats the value using the given formatter.

impl PartialEq<WidgetInfo> for WidgetInfo

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

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

const 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.

impl StructuralPartialEq for WidgetInfo