Struct Status 

pub struct Status {

    pub interaction: Interaction,
    pub focused: bool,
    pub cursor: Option<usize>,
    pub selection: Option<(usize, usize)>,
    pub composing: Option<(usize, usize)>,
    pub toolbar: Option<bool>,
    pub handles: bool,
    pub region: Option<(usize, usize)>,
    pub region_bar: bool,
    pub region_grips: (Option<usize>, Option<usize>),
    pub caret_hidden: bool,
    pub drag_over: bool,
    pub hover_progress: f32,
    pub focus_progress: f32,
    pub press_progress: f32,
    pub opacity: f32,
    pub value: f32,
    pub time: f32,
    pub anim_color: Option<Color>,
    pub anim_radius: Option<BorderRadius>,
    pub scroll_y: f32,
    pub hover_cursor: Option<Point>,
    pub value_placed: bool,
    pub thumb: Option<usize>,
}

A widget’s complete status for one frame: pointer interaction, focus, caret and selection (for fields), animation progress and opacity.

Fields

interaction: Interaction

Whether the pointer is over the widget or pressing it.

focused: bool

Whether the widget holds the keyboard focus.

cursor: Option<usize>

The caret’s (character) index, if this widget is a focused field.

selection: Option<(usize, usize)>

The selected (start, end) range, in character indices.

composing: Option<(usize, usize)>

The (start, end) range being composed by the IME (provisional, underlined text); None outside composition. In character indices.

toolbar: Option<bool>

Is the field’s bar (Cut, Copy, Paste, Select all) showing over its selection? Some(can_paste) when it is — with whether the clipboard held text when it opened — and None otherwise. Set by the shell, and only for the focused field.

handles: bool

Does the selection carry handles? A selection made with a finger does — a long press on a word — and one made with a mouse or the keyboard does not. Set by the shell, and only for the focused field.

region: Option<(usize, usize)>

The (start, end) range of this text that a SelectionArea’s selection covers, in characters. Kept by the shell, for any text in the area whether or not it has the focus — which is the difference from selection, a field’s own.

region_bar: bool

Does the selection a selection area holds show its bar? Set for every text the selection covers; the first of them in reading order carries the bar.

region_grips: (Option<usize>, Option<usize>)

The handles of a selection area’s touch selection that hang from this text: the character where the selection starts, if it starts here, and the boundary where it ends, if it ends here.

caret_hidden: bool

Is the caret in the hidden half of its blink? Set by the shell, and only for the focused field; a field paints no caret while it is.

drag_over: bool

Is a drag currently over this widget, and would it be accepted? Only ever true for a crate::DragTarget; it is what lets one paint the “drop it here” state itself rather than have the shell paint it from outside.

hover_progress: f32

The hover transition’s progress (0.0..=1.0).

focus_progress: f32

The focus transition’s progress (0.0..=1.0).

press_progress: f32

The press transition’s progress (0.0..=1.0): the animated form of Interaction::Pressed, as hover_progress is the animated form of Interaction::Hovered.

A press used to be a flag and nothing else, so every state layer and every held radius in the crate reached full the instant a finger landed and vanished the instant it left. The reference fades its press highlight over 200 ms against the 50 ms it gives hover and focus (ink_well.dart:995) — the press is the slower of the two, which is the opposite of what a flag does.

interaction stays for the decisions that really are discrete — is this the widget being held? — and this is what the paint reads.

opacity: f32

The opacity to apply (a fade-in); 1.0 = opaque.

value: f32

The widget’s own animated value (a switch’s 0 → 1, for instance), driven by Widget::anim_target.

time: f32

The time elapsed (in seconds) since start-up — for continuous, time-driven animations (a CircularProgressIndicator, for instance).

anim_color: Option<Color>

The interpolated color of an animated background (Container::animated_color) while in transition; None = no animated color, and the widget uses its own.

anim_radius: Option<BorderRadius>

The interpolated corner radius (Container::animated_radius) while in transition; None = a fixed radius, and the widget uses its own.

scroll_y: f32

This widget’s retained vertical scroll (in px), for widgets that scroll their own content (a multi-line field); 0 otherwise.

hover_cursor: Option<Point>

The pointer’s absolute position when it hovers an interactive sub-region of this widget (milestone 208); None otherwise. The widget brings it back to local coordinates through its bounds to highlight the targeted zone (a suffix icon…). Set by the shell from cursor_icon.

value_placed: bool

Was value placed by a finger — held by a drag, or settling from where one let go (milestone 638)? A widget that curves its value paints it straight while it is: the thumb under a finger is where the finger is.

thumb: Option<usize>

Which of this widget’s thumbs the last drag on it took (milestone 651), on a track with two: 0 the start, 1 the end. It stays after the drag ends, as the reference’s last selection does, so that the thumb last moved stays on top and its press fades out on it rather than on its neighbour. Set by the shell.

Implementations

impl Status

pub fn states(&self) -> WidgetStates

The states this widget is in, as a WidgetStateProperty resolves against (widget_state.dart:168).

Three of the eight, because three are all a status honestly knows: hovered, focused and pressed. Selected, Disabled, Error, Dragged and ScrolledUnder are the widget’s own to add with WidgetStates::set — nothing outside a checkbox knows whether it is ticked, and a status that guessed would be wrong for every widget that never selects anything.

It reads the flags, not the fades: a property is a step between values, and where the change should be gradual the widget animates between two resolved values rather than resolving a fraction. See the module note.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Status

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl PartialEq for Status

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Status