Struct RenderOutput

Source

pub struct RenderOutput {
    pub entries: Vec<TextPropertyEntry>,
    pub hits: Vec<HitArea>,
    pub instance_states: HashMap<String, WidgetInstanceState>,
    pub focus_key: String,
    pub tabbable: Vec<String>,
    pub focus_cursor: Option<FocusCursor>,
    pub embeds: Vec<EmbedRect>,
    pub overlays: Vec<OverlayRow>,
    pub scroll_regions: Vec<ScrollRegion>,
}

Expand description

What a single render of a WidgetSpec produces.

entries — the bytes for set_virtual_buffer_content.
hits — click rectangles for the WidgetRegistry so a later mouse_click dispatches a semantic widget_event.
instance_states — next-tick widget instance state (List scroll offsets / selection, TextInput value+cursor, …).
focus_key — currently focused widget key, clamped to a tabbable that exists in the spec (or "" when there are no tabbables).
tabbable — focusable widget keys collected in declaration order. The Tab-cycle command finds the current focus_key’s index in this list to advance it.
focus_cursor — when a TextInput is focused, where the terminal cursor should land. Replaces the previous “overlay-as-cursor” hack — the actual hardware cursor blinks at the right byte, with no theme-color guesswork.

Fields§

§entries: Vec<TextPropertyEntry>§hits: Vec<HitArea>§instance_states: HashMap<String, WidgetInstanceState>§focus_key: String§tabbable: Vec<String>§focus_cursor: Option<FocusCursor>§embeds: Vec<EmbedRect>

Rectangles reserved by WindowEmbed widgets. Each entry names a window id and the cell range (relative to the rendered panel’s inner area) the host should paint that window into after laying down the regular entries.

§overlays: Vec<OverlayRow>

Rows produced by WidgetSpec::Overlay children. Each row carries its anchor buffer_row (relative to the rendered panel’s inner area) and is painted by the host AFTER the main entries, on top of whatever is at that row. Used for dropdown completions, tooltips, hover popups — anything that should appear next to a focused widget without reflowing the rest of the layout when it shows or hides.

§scroll_regions: Vec<ScrollRegion>

Scrollable List widgets that overflowed their visible height, with the geometry + state the host needs to paint and drag a scrollbar. Empty for lists that fit.

Auto Trait Implementations§

§

RenderOutput

Struct RenderOutput Copy item path

Fields§

Auto Trait Implementations§

impl Freeze for RenderOutput

impl RefUnwindSafe for RenderOutput

impl Send for RenderOutput

impl Sync for RenderOutput

impl Unpin for RenderOutput

impl UnsafeUnpin for RenderOutput

impl UnwindSafe for RenderOutput

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

impl<T> From<T> for T

fn from(t: T) -> T

impl<'a, T> FromIn<'a, T> for T

fn from_in(t: T, _: &'a Allocator) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<'a, T, U> IntoIn<'a, U> for Twhere U: FromIn<'a, T>,

fn into_in(self, allocator: &'a Allocator) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Struct RenderOutput

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

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

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

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,