Module ui

Expand description

UI framework — flexbox layout + widgets on top of yog-gfx.

Modules§

component: Custom components — a mod’s own reusable widgets, used from .yui markup like the built-in elements (the user controls of WPF).
event: The raw UI events a Yog screen’s register_ui handler receives, parsed once into UiEvent.
image: Image widgets: natural size (asked from the host, cached) and drawing — fitting the image into the widget per its Stretch and cutting it to the clip rect.
layout
scroll: Driving a scrolling container (widget::scroll_view()) from the raw UI events a Yog screen receives (scroll:DY, click:X:Y, drag:X:Y, release:X:Y).
text: Text wrapping utilities shared by layout (measuring) and render (drawing).
textbox: Driving a single-line text input (widget::text_box()) from the raw UI events a Yog screen receives — click:X:Y, drag:X:Y, release:X:Y, key:KEY:MODS and char:CODEPOINT — like ScrollState does for scroll views.
widget: Widget types and styling.

Action: A typed click target: owner 0 = the screen, k = items control k; slot = the command (or Action::SELECT); index = the item index inside an items control (0 elsewhere).
LayoutNode
Rect
ScrollState: Scroll offset plus scrollbar-drag state of one scrolling container.
StateFlags: Interaction state bits of a widget — see Widget::state.
StateStyles: A widget’s state patches: each applies when the widget’s state contains its flags; later rules win.
StylePatch: Paint-only style overrides — never affect layout.
TextBoxState: Text, caret, selection and focus of one text box.
UiRoot: Top-level UI tree. Build it, call layout, then [render] each frame.
Widget: A single widget in the UI tree.

Align
Dock: WinForms-style dock — which edge(s) the widget attaches to inside its parent.
FlexDir
FocusStyle: How a focused widget shows its focus indicator.
Stretch: How an image fills the box it’s given — WPF’s Stretch.
TextBoxEvent: What TextBoxState::handle did with an event.
UiEvent: One parsed UI event — see the module docs.
Units: A size value — either a fixed pixel amount, a CSS-style percentage of the parent’s own resolved content size (0.0–100.0), or Auto (size to content/available space, this crate’s original behaviour).

hit_path: The child-index path (as in Widget::at_path) of the node hit_test finds at (mx, my); None on a miss.
node_at: The node at child-index path (&[] = node).
set_focus: Walk tree and set focused = true on the node whose id matches, false on all others.