Namespace: ui

All documented symbols in the ui namespace.

namespace · ui

Interface

namespace ui

Backend-neutral semantic interface composition functions.

function · ui

begin_panel

ui.begin_panel(panel_contract)

Begins one bounded backend-neutral semantic panel.

function · ui

begin_row_group

ui.begin_row_group()

Begins one non-nested horizontal widget group.

function · ui

button

ui.button(label, action_id, semantic_label, focus_order?)

Records one semantic button bound to a logical action.

function · ui

end_panel

ui.end_panel()

Closes the current semantic panel.

function · ui

end_row_group

ui.end_row_group()

Closes the current horizontal widget group.

function · ui

explain

ui.explain(text)

Records one wrapped full-width explanation paragraph.

function · ui

ghost

ui.ghost(origin_x, origin_y, width, height, valid, caption)

Records one optional placement-footprint ghost.

function · ui

list

ui.list(action_id, rows, options?)

Records one bounded selectable list with stable row identities.

function · ui

menu

ui.menu(label, state?)

Records one menu heading.

function · ui

pan_camera

ui.pan_camera(cell_x, cell_y)

Records one optional camera-centering intent.

function · ui

progress

ui.progress(label, value, maximum)

Records one bounded progress value.

function · ui

row

ui.row(label, value)

Records one labeled value row.

function · ui

select_provider

ui.select_provider(surface_id, provider_id)

Requests one declared provider for a replaceable UI surface.

function · ui

separator

ui.separator()

Records a vertical group separator or horizontal panel separator.

function · ui

set_theme

ui.set_theme(theme_contract)

Selects typed scale and accessibility theme constraints.

function · ui

spacer

ui.spacer()

Consumes remaining width inside a horizontal widget group.

function · ui

surface

ui.surface(kind, aspect, action_id)

Records one bounded spatial presentation surface.

function · ui

stat

ui.stat(value, label)

Records one compact figure with a caption.

function · ui

tabs

ui.tabs(action_id, labels, active_index)

Records one bounded tab strip before a panel's widgets.

function · ui

text

ui.text(label, value?)

Records one text widget.

function · ui

tooltip

ui.tooltip(label, text)

Records tooltip content.