Skip to content

Modern Tui TuiWidget SizeHint

Paul Squires edited this page Oct 19, 2026 · 6 revisions

Home › Terminal TUI Library › Widgets › TuiWidget.SizeHint

TuiWidget.SizeHint

Returns the size the widget would like in the space given; layouts may ignore it.

Syntax

TuiWidget.SizeHint( byval avail as TuiRect ) as TuiSize

Description

How big this widget would like to be, given the space available. Advisory: nothing is obliged to honour it, and the constraint solver does not consult it.

Example

#import "std/tui"
using tui

dim as TuiParagraph p
p.text = "one" & chr( 10 ) & "two" & chr( 10 ) & "three"

print p.SizeHint( TuiRectOf( 0, 0, 40, 10 ) ).rows   '' 1 -- wrap is OFF, so the
                                  '' hint does not lay the text out
p.wrap = TRUE
print p.SizeHint( TuiRectOf( 0, 0, 40, 10 ) ).rows   '' 3 -- now it does

See also

TuiWidget TuiWidget.HandleEvent TuiFocusRing TuiFocusRing.Count
TuiWidget.Render TuiWidget.CanFocus TuiFocusRing.Add TuiFocusRing.Current
TuiWidget.Kind TuiWidget.SetFocused TuiFocusRing.Clear TuiFocusRing.Next_

Library: Terminal TUI Library
Category: Terminal TUI Library
Documented under: Widgets
Working examples: hello.tiko · form.tiko · dashboard.tiko


Home · Keyword Index

Clone this wiki locally