Back to Projects
TUIX v0.5Beta

Last Updated: 2026-05-20

Builders API

The builders module provides the names used by objects.create_object(), aliases for ergonomic naming, layout constants, and standard builder registration.

Method

MethodHow to use itWhy it exists
builders.register_standard() -> intCall once after engine.init() and before creating objects.Registers every built-in native builder with the current engine registry.

Widget Builder Constants

ConstantNative Builder NameWhy / Use
builders.CANVASCanvasBuilderFree-draw surface for pixels, primitives, text, buffers, and sprites.
builders.CHOICEChoiceBuilderSelectable option list.
builders.INPUTInputBuilderSingle-line text input.
builders.PROGRESSBARProgressBarBuilderProgress bar widget.
builders.TEXTTextBuilderInline text label/content.
builders.BOXBoxBuilderFramed box container.
builders.DIVIDERDividerBuilderHorizontal or vertical divider.
builders.BADGEBadgeBuilderCompact badge label.
builders.BUTTONButtonBuilderClickable and keyboard-activatable button.
builders.TAGTagBuilderChip-style tag label.
builders.STATUSStatusBuilderStatus label with semantic levels.
builders.MENUMenuBuilderInteractive menu.
builders.SCROLL_CONTAINERScrollContainerBuilderViewport-backed scroll container.
builders.ROWRowBuilderHorizontal stack layout parent.
builders.COLUMNColumnBuilderVertical stack layout parent.
builders.SPLITPANESplitPaneBuilderTwo-pane split layout.
builders.SPLIT_PANESplitPaneBuilderAlias for SPLITPANE.
builders.GRIDGridBuilderFixed/weighted grid layout.
builders.CHECKBOXCheckboxBuilderToggle checkbox.
builders.LISTVIEWListViewBuilderViewport-backed selectable list.
builders.LIST_VIEWListViewBuilderAlias for LISTVIEW.
builders.TEXTAREATextAreaBuilderMultiline text area.
builders.TEXT_AREATextAreaBuilderAlias for TEXTAREA.
builders.DIALOGDialogBuilderModal dialog container.

Layout And Grid Constants

ConstantValueWhy / Use
builders.AXIS_NONE0No axis / unset orientation.
builders.AXIS_HORIZONTAL1Horizontal orientation.
builders.AXIS_VERTICAL2Vertical orientation.
builders.JUSTIFY_START0Pack children at main-axis start.
builders.JUSTIFY_CENTER1Center children on the main axis.
builders.JUSTIFY_END2Pack children at main-axis end.
builders.JUSTIFY_SPACE_BETWEEN3Distribute extra space between children.
builders.ALIGN_START0Align children at cross-axis start.
builders.ALIGN_CENTER1Center children on the cross axis.
builders.ALIGN_END2Align children at cross-axis end.
builders.ALIGN_STRETCH3Stretch children across the cross axis.
builders.ALIGN_AUTO-1Inherit/default child alignment.
builders.GRID_TRACK_FIXED0Fixed-size grid track.
builders.GRID_TRACK_WEIGHT1Weighted/flexible grid track.

Usage

engine.init()
builders.register_standard()
scenes.init_scene('Main')
scenes.select_scene('Main')

uid = objects.create_object(builders.GRID, 'Main', 0.9, 0.6, 0.1, 0.05)
grid = objects.get_object_by_uid(uid)
objects.tuix_grid_set_columns(grid, [(builders.GRID_TRACK_WEIGHT, 1)])