Struct TableHeader 

pub struct TableHeader { /* private fields */ }

A table’s column header strip: one Role::ColumnHeader cell per column, with click-to-sort, drag-to-resize on every divider, drag-to-reorder, pinned columns, the filter popover and a horizontal scroll offset to follow a scrolled body.

let widths = Signal::new(HashMap::new());
let sort = Signal::new(None);
let header = TableHeader::new(vec![
    ColumnSpec::new("title", lit!("Title")).sortable(true),
    ColumnSpec::new("length", lit!("Length"))
        .width(ColumnWidth::Fixed(80.0))
        .sortable(true),
])
.widths(widths.clone())
.sort(sort.clone());
let layout = header.resolved_widths_signal().clone(); // line rows up with this

A header announces itself as the Role::Row with row index 1, its cells as Role::ColumnHeaders, so place it inside the container that announces the rows under it as a table or a grid.

See the module docs for how its state is shared and for how a view hosts it.

Implementations

impl TableHeader

pub fn new(columns: Vec<ColumnSpec>) -> Self

A header over columns, in declaration order. Every piece of state it is not handed is its own.

pub fn widths(self, widths: Signal<HashMap<String, f32>>) -> Self

Adopt widths as the map of column id → width override; a column with no entry takes its declared ColumnWidth. A resize drag writes the resized column only. Each Flex column before it keeps its current width in this header, but not in the map, which other views may share at other widths.

pub fn sort(self, sort: Signal<Option<(String, SortDirection)>>) -> Self

Adopt sort as the active sort. A click on a sortable column cycles it None → ascending → descending → None.

pub fn order(self, order: Signal<Vec<String>>) -> Self

Adopt order as the column order, a list of column ids; columns it does not name follow in declaration order. A reorder drop writes it.

pub fn pinning(self, pinning: Signal<HashMap<String, PinnedSide>>) -> Self

Adopt pinning as the per-column pinning overrides, which win over each ColumnSpec::pinned; PinnedSide::None unpins a column declared pinned. A reorder drop writes it: an entry when the drop puts the column in a pane other than the one it declares, none when it puts it back.

pub fn filters(self, filters: Signal<HashMap<String, String>>) -> Self

Adopt filters as the per-column filter text the filter popover of a filterable column edits.

pub fn scroll_x(self, scroll_x: Signal<f32>) -> Self

Follow scroll_x, the horizontal offset of the body under the header: the unpinned columns shift left by it, the pinned ones stay put.

pub fn resize_policy(self, policy: ColumnResizePolicy) -> Self

Whether a resize writes its width on every pointer move (Live, the default) or on release (OnRelease, with a guide line meanwhile).

pub fn stretch_last_column(self, on: bool) -> Self

Let the last column in display order take the width the others leave — see TableView::stretch_last_column. Default off.

pub fn widths_signal(&self) -> &Signal<HashMap<String, f32>>

The width overrides — the signal widths adopted, or the header’s own.

pub fn sort_signal(&self) -> &Signal<Option<(String, SortDirection)>>

The active sort — the signal sort adopted, or the header’s own.

pub fn order_signal(&self) -> &Signal<Vec<String>>

The column order — the signal order adopted, or the header’s own.

pub fn pinning_signal(&self) -> &Signal<HashMap<String, PinnedSide>>

The pinning overrides — the signal pinning adopted, or the header’s own.

pub fn filters_signal(&self) -> &Signal<HashMap<String, String>>

The filters — the signal filters adopted, or the header’s own.

pub fn scroll_x_signal(&self) -> &Signal<f32>

The horizontal offset the header follows — the signal scroll_x adopted, or the header’s own (which stays at 0).

pub fn resolved_widths_signal(&self) -> &Signal<Vec<(String, f32)>>

(column id, width) for each displayed column, in display order: the widths the header laid its cells out at, after the overrides, the declared widths, the Flex share and the min / max clamps. Written when the header is placed in a layout pass, and only when it changed; bind a row’s layout to it to line the row’s cells up with the columns. Leading-pinned columns come first and do not move with scroll_x, nor do the trailing-pinned ones at the end.

Rows follow it one layout pass late, unless they read it in their own place_children and are laid out after the header (below it in the same stack): only the header’s bounds settle the widths, and a row that sizes itself from them in layout_response (a FixedSize bound to a width derived from this, say) has been measured by then, so it is relaid out on the next pass. During a live resize drag such a row trails the header by a frame, and a headless test needs a second layout() before it lines up.

Published by a standalone header only; a view hosting the header lays its rows out from the same widths directly.

Trait Implementations

impl Debug for TableHeader

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

Formats the value using the given formatter.

impl Widget for TableHeader

fn post_paint(&self, bounds: Rect, canvas: &mut Canvas, ctx: &PaintContext<'_>)

The OnRelease resize guide. Under that policy no column moves until the button comes up, so this line is the only feedback the gesture has. Drawn over the cells, within the strip.

fn build(&mut self, ctx: &mut BuildContext<'_>) -> Vec<WidgetId>

Compose child widgets. Called once after the widget is placed in the arena, and again whenever the widget is marked for rebuild — a BindingLevel::Rebuild binding, rebuild_single_widget, or a density switch. A theme or locale switch does not rebuild: set_theme and set_locale mark layout + paint dirty and leave the built subtree standing, so anything derived from the theme or the locale must be read per pass or bound to a signal rather than captured here. Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

fn layout_response( &self, proposal: SizeProposal, _ctx: &LayoutContext<'_>, ) -> LayoutResponse

Respond to the parent’s size proposal with this widget’s wanted size, grow/shrink weights, and compression floor (see [LayoutResponse]).

fn place_children( &self, bounds: Rect, _proposal: SizeProposal, children: &mut [WidgetPlacement], ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

fn paint(&self, bounds: Rect, canvas: &mut Canvas, ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

fn wants_post_paint(&self) -> bool

Whether this widget wants its post_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t draw a foreground over their children.

fn accessibility(&self, builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

fn children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

fn clips_children(&self) -> bool

Whether this widget clips its children to its bounds.

fn as_any(&self) -> Option<&dyn Any>

Downcast hook. Default implementation returns None; concrete widgets override with Some(self) when they want to expose their concrete type to test-level introspection or reflection. The trait already bounds on std::any::Any so concrete types satisfy the 'static requirement.

fn type_name(&self) -> &'static str

Concrete type name of this widget (e.g. "teksilo_widgets::button::Button"). The default implementation resolves at the impl site via std::any::type_name::<Self>(), so calls through &dyn Widget correctly dispatch to the monomorphized fn for the concrete type — getting the concrete name through the vtable without per-impl boilerplate.

fn cacheable_layout(&self) -> bool

Whether this widget’s layout_response may be memoized by the per-pass layout cache. Defaults to true.

fn wants_after_paint(&self) -> bool

Whether this widget wants its after_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t aggregate descendant geometry.

fn after_paint(&self, _view: &WidgetTreeView<'_>, _ctx: &PaintContext<'_>)

Called once per frame after this widget’s subtree has finished painting. Receives a read-only view of the layout-resolved arena so a parent can read its descendants’ final bounds — e.g. TitleBar aggregates its drag region and control-button rects into a single HitRegions payload for the Windows backend’s WM_NCHITTEST.

fn wants_descendant_redirects(&self) -> bool

Whether this widget wants the AT walker to consult its a11y_redirect_descendant hook for every descendant during AT tree emission, not just its direct arena children.

fn culls_children(&self) -> bool

Whether this widget decides, on every layout pass, which of its children exist at all.

fn a11y_redirect_descendant( &self, _self_id: WidgetId, _descendant: WidgetId, ) -> Option<NodeId>

Optional redirection hook for AT-tree placement of a child.

fn accessible_title_hint(&self) -> Option<String>

Suggest an accessible title to an enclosing container that wraps this widget as content — typically a modal / dialog shell that wants to propagate the inner content’s visible title as the shell’s own accessible name.

fn accessible_title_node(&self) -> Option<WidgetId>

The widget that paints this one’s title, when it has one.

fn initial_focus_hint(&self) -> Option<WidgetId>

Optional hint that directs initial focus to a specific descendant when this widget is the root of a deferred-built modal surface.

fn accessibility_proxy(&self) -> Option<WidgetId>

The descendant whose accessibility node stands for this widget.

fn context_menu_key_target(&self) -> Option<WidgetId>

Which descendant a keyboard request for a context menu should target.

fn accessibility_children(&self) -> Option<Vec<WidgetId>>

Optional override for the child ORDER presented to assistive technology, when it must differ from the paint / z-order child order returned by children.

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

Mutable counterpart of as_any. Default returns None; widgets that want to expose mutable state to tests (e.g. so a test can mutate a Scene inside a SceneView post-layout) override with Some(self). Should follow the same opt-in pattern as as_any: only widgets that opt into & introspection should opt into &mut.

fn focus_reveal_rect(&self, _bounds: Rect) -> Option<Rect>

The rectangle (in absolute tree coordinates) that best represents this widget when the framework reveals it into an ancestor scroll area on focus gain. Returning None (the default) reveals the widget’s whole bounds — correct for most controls.

fn hit_shape(&self, _local_point: Point, _bounds: Rect) -> bool

Whether the point lies inside this widget’s actual shape, not just its rectangular bounds. Consulted by hit-testing right after the bounds check: returning false for a point that is inside the bounding box makes the widget transparent to the click there, so it falls through to whatever sibling is painted underneath (the same machinery as a fully pass-through node, but shape-aware).

fn accepts_child_hit(&self, _child: WidgetId, _point: Point) -> bool

Veto a hit on one of this widget’s direct children, per point.

fn hit_outset(&self, _kind: PointerKind, _tokens: &InputTokens) -> EdgeInsets

How far outside its own bounds this widget still absorbs a press, per edge, for the pointer that is asking.

fn hit_slop(&self, _kind: PointerKind, _tokens: &InputTokens) -> Option<HitSlop>

This widget’s own say in the miss-only slop pass, overriding the density default for its node.

fn hit_distance(&self, local_point: Point, bounds: Rect) -> Option<f32>

How far a missed press is from this widget’s actual silhouette, in the widget’s own bounds space.

fn target_regions(&self, _bounds: Rect) -> Vec<TargetRegion>

The interactive sub-regions this widget paints inside its own single node — a scroll bar’s thumb, a slider’s knob, a header cell’s filter affordance.

fn preserves_children_on_rebuild(&self) -> bool

How rebuild_single_widget treats this widget’s existing children when re-running its build().

fn tooltip_has_content(&self) -> bool

Whether this widget, used as tooltip content, currently has anything worth showing.

fn declare_shortcuts(&self) -> Vec<Shortcut>

Declare the rebindable keyboard shortcuts this widget exposes, without installing handlers. The framework calls this at arena insertion time (before build()) and at certain lazy boundaries (e.g. Switcher walks declarations on its not-yet-mounted Pending slots), so settings UIs and the ShortcutRegistry see the keystrokes the moment the owning container mounts — even if build() hasn’t run.

fn take_handler_set(&mut self) -> Option<HandlerSet>

Extract attached handler set from a WidgetWithHandlers wrapper. Called during arena insertion to transfer handlers to the WidgetNode. Default: returns None (no attached handlers).