Back to Projects
TUIX v0.6Beta

Last Updated: 2026-08-14

Viewport & Dialog Widgets

Viewport and dialog widgets own virtual content coordinates, scroll offsets, clipping boundaries, and modal overlay state.

ScrollContainer (`content_builder.SCROLL_CONTAINER`)

MethodDescription
objects.tuix_scroll_container_set_content_size(obj_ptr, width: int, height: int) -> intSets virtual content canvas dimensions in cell units.
objects.tuix_scroll_container_set_offset(obj_ptr, offset_x: int, offset_y: int) -> intSets scrolling offset translation.
objects.tuix_scroll_container_add_object_at(obj_ptr, scene_name, builder_name, content_x, content_y, content_w, content_h) -> intPlaces a child widget at absolute virtual content coordinates.
objects.tuix_scroll_container_set_colors(obj_ptr, br, bg, bb, tr, tg, tb, bbr, bbg, bbb, body_r, body_g, body_b) -> intSets border, title, scrollbar, and body RGB colors.

ListView (`content_builder.LIST_VIEW`)

MethodDescription
objects.tuix_listview_set_items(obj_ptr, items: list) -> intSets virtual list items array.
objects.tuix_listview_set_selected(obj_ptr, index: int) -> intSets currently highlighted item index.
objects.tuix_listview_get_selected(obj_ptr) -> intReturns index of currently selected item.
objects.tuix_listview_take_activated(obj_ptr) -> intReads and consumes activated item index (e.g. on Enter key).

TextArea (`content_builder.TEXT_AREA`)

MethodDescription
objects.tuix_textarea_set_text(obj_ptr, text: str | bytes) -> intReplaces full multiline UTF-8 document text.
objects.tuix_textarea_get_text(obj_ptr) -> bytesReads current document text as UTF-8 bytes.
objects.tuix_textarea_set_placeholder(obj_ptr, text: str) -> intSets placeholder text shown when buffer is empty.
objects.tuix_textarea_set_readonly(obj_ptr, readonly: bool) -> intToggles read-only viewing vs editable mode.
objects.tuix_textarea_set_colors(obj_ptr, tr, tg, tb, bgr, bgg, bgb, br, bg, bb) -> intSets text, background, and border outline RGB colors.

Dialog (`content_builder.DIALOG`)

MethodDescription
objects.tuix_dialog_set_title(obj_ptr, title: str) -> intSets modal dialog header title.
objects.tuix_dialog_set_body_size(obj_ptr, width: int, height: int) -> intSets fixed cell dimensions of inner modal body.
objects.tuix_dialog_set_close_on_esc(obj_ptr, enabled: bool) -> intEnables close requests when Escape key is pressed.
objects.tuix_dialog_set_close_on_backdrop(obj_ptr, enabled: bool) -> intEnables close requests when clicking the dimmed backdrop area.
objects.tuix_dialog_activate(obj_ptr, scene_name: bytes) -> intActivates modal focus trapping overlay in scene.
objects.tuix_dialog_deactivate(obj_ptr, scene_name: bytes) -> intDeactivates modal overlay and restores normal scene input.
objects.tuix_dialog_take_close_requested(obj_ptr) -> intReads and consumes modal close request flag.