Struct Widget 

pub struct Widget {

    pub kind: WidgetKind,
    pub id: Option<String>,
    pub style: Style,
    pub flex_dir: FlexDir,
    pub children: Vec<Widget>,
    pub on_click: Option<String>,
    pub enabled: bool,
    pub focused: bool,
    pub action: Option<Action>,
    pub visible: bool,
    pub state: StateFlags,
    pub states: Option<Box<StateStyles>>,
    pub tooltip: Option<String>,
}

A single widget in the UI tree.

Fields

kind: WidgetKind

id: Option<String>

style: Style

flex_dir: FlexDir

children: Vec<Widget>

on_click: Option<String>

enabled: bool

focused: bool

action: Option<Action>

Typed click target set by generated code (yog-kit) — like Self::on_click, but no string to parse. See Action.

visible: bool

false = collapsed: takes no space, isn’t drawn and can’t be hit (its layout node is a zero rect without children).

state: StateFlags

Interaction state (hover, pressed, selected, …) the host sets each frame — picks the Self::states patches applied when drawing.

states: Option<Box<StateStyles>>

Paint-only style overrides per state (hover:bg="..." in .yui).

tooltip: Option<String>

Text shown in a tooltip while the cursor rests on it (\n breaks lines) — see crate::UiRoot::tooltip_at.

Implementations

impl Widget

pub fn tooltip(self, text: impl Into<String>) -> Widget

See Self::tooltip; empty = none.

pub fn set_tooltip(&mut self, text: impl Into<String>)

Sets (empty: clears) Self::tooltip.

pub fn action(self, a: Action) -> Widget

Typed click target — see Action.

pub fn visible(self, v: bool) -> Widget

false = collapsed — see Widget::visible.

pub fn state_style(self, when: StateFlags, patch: StylePatch) -> Widget

Adds a paint-only override applied while the state contains when (later calls win over earlier ones).

pub fn get_path(&self, path: &[u16]) -> Option<&Widget>

The descendant at child-index path (&[] = self); None past the tree.

pub fn get_path_mut(&mut self, path: &[u16]) -> Option<&mut Widget>

Self::get_path, mutably.

pub fn is_interactive(&self) -> bool

Whether clicking it does something (an Action or on_click).

pub fn set_state_inherited(&mut self, mask: StateFlags, on: bool)

Sets (or clears) mask on this widget and its descendants, stopping at descendants that are interactive themselves (a button in a row keeps its own hover) — so a row’s labels follow the row’s state.

pub fn clear_state_deep(&mut self, mask: StateFlags)

Clears mask on the whole subtree (interactive descendants too).

pub fn effective_style(&self) -> Cow<'_, Style>

The style drawn: Self::style plus the Self::states patches matching Self::state (with DISABLED while enabled is false).

pub fn effective_style_in(&self, state: StateFlags) -> Cow<'_, Style>

Self::effective_style for an explicit state.

pub fn id(self, id: impl Into<String>) -> Widget

pub fn on_click(self, ev: impl Into<String>) -> Widget

pub fn child(self, w: Widget) -> Widget

pub fn w(self, w: impl Into<Units>) -> Widget

Accepts a plain px value (0.0 = auto) or a Units directly — e.g. .w(18.0) or .w(Units::Percent(60.0)).

pub fn h(self, h: impl Into<Units>) -> Widget

pub fn min_w(self, v: f32) -> Widget

pub fn min_h(self, v: f32) -> Widget

pub fn flex(self, v: f32) -> Widget

pub fn flex_dir(self, v: FlexDir) -> Widget

pub fn gap(self, v: f32) -> Widget

pub fn bg(self, v: Color) -> Widget

pub fn bg_image(self, source: impl Into<String>) -> Widget

See Style::bg_image.

pub fn color(self, v: Color) -> Widget

pub fn align(self, v: Align) -> Widget

pub fn font_scale(self, v: f32) -> Widget

pub fn shadow(self, v: bool) -> Widget

pub fn no_wrap(self) -> Widget

pub fn focus_style(self, v: FocusStyle) -> Widget

pub fn focus_color(self, v: Color) -> Widget

pub fn dock(self, v: Dock) -> Widget

pub fn enabled(self, v: bool) -> Widget

pub fn focused(self, v: bool) -> Widget

pub fn at(self, x: f32, y: f32) -> Widget

Position absolutely at (x, y) inside the parent’s content box — see Style::pos.

pub fn ellipsis(self) -> Widget

Single line, cut with ... when too wide — see Style::ellipsis.

pub fn clip(self, v: bool) -> Widget

Clip children to this widget’s rect — see Style::clip.

pub fn scroll_y(self, v: f32) -> Widget

Vertical scroll offset of the children — see Style::scroll_y.

pub fn scrollbar(self, v: bool) -> Widget

Draw a vertical scrollbar on overflow — see Style::scrollbar.

pub fn font(self, font: impl Into<String>) -> Widget

Font for this widget’s text — see Style::font.

pub fn placeholder(self, text: impl Into<String>) -> Widget

Text box: greyed text shown while it’s empty.

pub fn max_length(self, n: usize) -> Widget

Text box: longest text allowed, in characters (0 = unlimited).

pub fn on_change(self, ev: impl Into<String>) -> Widget

Text box: event name raised when the text changes.

pub fn on_submit(self, ev: impl Into<String>) -> Widget

Text box: event name raised by Enter.

pub fn stretch(self, stretch: Stretch) -> Widget

Image: how it fills the widget (WPF’s Stretch).

pub fn region(self, region: Rect) -> Widget

Image: draw only region of it (texture pixels).

pub fn tint(self, tint: Color) -> Widget

Image: multiply its colors by tint.

pub fn children(self, children: impl IntoIterator<Item = Widget>) -> Widget

Adds every widget in children, in order.

pub fn find_mut(&mut self, id: &str) -> Option<&mut Widget>

The first widget in this subtree (depth-first, self included) whose Widget::id is id — for changing a built tree before laying it out (dynamic text, enabled state, …).

pub fn set_text(&mut self, text: impl Into<String>) -> bool

Replaces the text of a label, button or text box; false for any other kind.

pub fn with_text(self, text: impl Into<String>) -> Widget

set_text as a builder call.

pub fn with_source(self, source: impl Into<String>) -> Widget

Replaces an image’s source or a slot’s item id (other kinds: no-op).

pub fn with_count(self, n: u32) -> Widget

Replaces an inventory slot’s stack count (other kinds: no-op).

pub fn padding(self, top: f32, right: f32, bottom: f32, left: f32) -> Widget

pub fn margin(self, top: f32, right: f32, bottom: f32, left: f32) -> Widget

pub fn cell(self, row: u16, col: u16) -> Widget

Puts it in grid cell (row, col) (spanning one row and column) — WPF’s Grid.Row / Grid.Column. See Self::span.

pub fn span(self, rows: u16, cols: u16) -> Widget

Spans rows × cols grid cells from its Self::cell — WPF’s Grid.RowSpan / Grid.ColumnSpan (0 counts as 1).

pub fn halign(self, v: HAlign) -> Widget

Horizontal placement in its slot — see HAlign.

pub fn valign(self, v: VAlign) -> Widget

Vertical placement in its slot — see VAlign.

pub fn rows(self, rows: impl IntoIterator<Item = impl Into<Track>>) -> Widget

Grid: its rows (no rows = one * row).

pub fn cols(self, cols: impl IntoIterator<Item = impl Into<Track>>) -> Widget

Grid: its columns (no columns = one * column).

pub fn row_spacing(self, v: f32) -> Widget

Grid: space between rows.

pub fn col_spacing(self, v: f32) -> Widget

Grid: space between columns.

Trait Implementations

impl Clone for Widget

fn clone(&self) -> Widget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Widget

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

Formats the value using the given formatter.