Skip to main content

cturtle/ui/btlib

include "cturtle/ui/btlib";

Types​

CtAnimationNode​

Object

FieldTypeWritableDescription
idstringyes
labelstringyes
kindstringyes
modelstringyes
jointCtHierarchyPartyes

CtAnimationBinding​

Object

FieldTypeWritableDescription
namestringyes
nodesarray<CtAnimationNode>yes

WorkspaceCommandPalette​

Object

FieldTypeWritableDescription
shellWorkspacePaletteHostyes
rootUiElementyes
cardUiElementyes
formPanelyes
listUiElementyes
settingsHeaderUiElementyes
headingsarray<UiElement>yes
offsetsarray<float>yes
dismissWidgetyes
searchWidgetyes
statusFlowTextyes
rowsarray<WorkspaceMenuItem>yes
matchesarray<string>yes
selectedintyes
listHeightfloatyes
capacityintyes
activeboolyes
previousKeyboardTokenintyes
previousKeyboardUiKeyboardHandleryes
previousFieldTokenintyes
generationintyes
bindingsModeboolyes
recordingboolyes
suppressRecordedTextboolyes
recordedQuerystringyes
bindingControlsUiElementyes
recordBindingWidgetyes
clearBindingWidgetyes
resetBindingWidgetyes

resize infallible​

infallible fn resize()

open infallible​

infallible fn open()

openBindings infallible​

infallible fn openBindings()

record infallible​

infallible fn record()

changeBinding infallible​

infallible fn changeBinding(int key, int modifiers)

close infallible​

infallible fn close(bool restoreFocus)

filter infallible​

infallible fn filter(string query)

paint infallible​

infallible fn paint()

move infallible​

infallible fn move(int amount)

revealSelected infallible​

infallible fn revealSelected()

run infallible​

infallible fn run(int index)

shortcut​

fn shortcut(int key, int modifiers) -> bool

pasted​

fn pasted(string text)

onTextEdited infallible​

infallible fn onTextEdited(Widget widget, string text)

onClick infallible​

infallible fn onClick(Widget widget)

onValueChanged infallible​

infallible fn onValueChanged(Widget widget, float value)

onValueCommitted infallible​

infallible fn onValueCommitted(Widget widget, float value)

onToggle infallible​

infallible fn onToggle(Widget widget, bool on)

onTextCommitted infallible​

infallible fn onTextCommitted(Widget widget, string text)

onSelected infallible​

infallible fn onSelected(Widget widget, int index)

onClosed infallible​

infallible fn onClosed()

WorkspaceKeyBinding​

Object

FieldTypeWritableDescription
idstringyes
keyintyes
modifiersintyes

WorkspaceCommandPreferences​

Object

FieldTypeWritableDescription
bindingsarray<WorkspaceKeyBinding>yes
recentarray<string>yes

WorkspacePreferencesNothing​

Object

preferencesChanged infallible​

infallible fn preferencesChanged()

CtCurve​

Object

FieldTypeWritableDescription
x1floatyes
y1floatyes
x2floatyes
y2floatyes

CurveEditor​

Object

FieldTypeWritableDescription
libUiLibyes
formPanelyes
themeThemeyes
rootUiElementyes
plotUiElementyes
drawingUiElementyes
startFieldVectorFieldyes
endFieldVectorFieldyes
handlesarray<Widget>yes
handlerCurveEditorHandleryes
curveCtCurveyes
originalCtCurveyes
widthfloatyes
heightfloatyes
startXfloatyes
startYfloatyes
enabledboolyes
draggingboolyes
changedboolyes
selectedintyes
generationintyes

x infallible​

infallible fn x(float value) -> float

y infallible​

infallible fn y(float value) -> float

point infallible​

infallible fn point(float x, float y) -> string

setCurve infallible​

infallible fn setCurve(CtCurve curve, bool enabled)

syncFields infallible​

infallible fn syncFields()

paint infallible​

infallible fn paint()

begin infallible​

infallible fn begin(int handle, float x, float y)

move infallible​

infallible fn move(int generation, float x, float y)

release infallible​

infallible fn release(int generation)

cancel infallible​

infallible fn cancel()

keyDown infallible​

infallible fn keyDown(int key, int modifiers)

onTextCommitted infallible​

infallible fn onTextCommitted(Widget widget, string text)

onClick infallible​

infallible fn onClick(Widget widget)

onValueChanged infallible​

infallible fn onValueChanged(Widget widget, float value)

onValueCommitted infallible​

infallible fn onValueCommitted(Widget widget, float value)

onToggle infallible​

infallible fn onToggle(Widget widget, bool on)

onSelected infallible​

infallible fn onSelected(Widget widget, int index)

onClosed infallible​

infallible fn onClosed()

CurveEditorKeyboard​

Object

FieldTypeWritableDescription
viewCurveEditoryes

focused​

fn focused()

blurred​

fn blurred()

keyDown​

fn keyDown(int key, int modifiers)

charTyped​

fn charTyped(int codepoint)

CurveEditorLayout​

Object

FieldTypeWritableDescription
viewCurveEditoryes

uiLayoutChanged infallible​

infallible fn uiLayoutChanged(float x, float y, float width, float height)

DecisionDialog​

Object

FieldTypeWritableDescription
libUiLibyes
rootUiElementyes
cardUiElementyes
iconUiElementyes
titleUiElementyes
messageUiElementyes
detailUiElementyes
focusWidgetWidgetyes
primaryButtonWidgetyes
secondaryButtonWidgetyes
cancelButtonWidgetyes
handlerDecisionDialogHandleryes
openStateboolyes

resize infallible​

infallible fn resize(int width, int height)

setHandler infallible​

infallible fn setHandler(DecisionDialogHandler handler)

setCancelText infallible​

infallible fn setCancelText(string text)

show​

fn show(
string iconAsset,
string title,
string message,
string detail,
string primary,
int primaryTone,
string secondary,
int secondaryTone)

hide infallible​

infallible fn hide()

choosePrimary infallible​

infallible fn choosePrimary()

chooseSecondary infallible​

infallible fn chooseSecondary()

cancel infallible​

infallible fn cancel()

uiResized infallible​

infallible fn uiResized(int width, int height)

DocumentTabHandlerNothing​

Object

documentTabSelected infallible​

infallible fn documentTabSelected(int index)

documentTabClosed infallible​

infallible fn documentTabClosed(int index)

DocumentTabSlot​

Object

FieldTypeWritableDescription
rootUiElementyes
labelUiElementyes
dirtyMarkUiElementyes
activeLineUiElementyes
closeFaceUiElementyes
selectButtonWidgetyes
closeButtonWidgetyes
documentIndexintyes
dirtyboolyes

DocumentTabs​

Object

FieldTypeWritableDescription
libUiLibyes
widgetContextPanelyes
handlerDocumentTabHandleryes
rootUiElementyes
viewportUiElementyes
rowUiElementyes
scrollNextRootUiElementyes
slotsarray<DocumentTabSlot>yes
capacityintyes
countintyes
activeintyes
firstVisibleintyes
availableWidthfloatyes
tabWidthfloatyes
heightfloatyes

visibleCount infallible​

infallible fn visibleCount() -> int

overflowing infallible​

infallible fn overflowing() -> bool

clampScroll infallible​

infallible fn clampScroll()

reveal infallible​

infallible fn reveal(int index)

applyScroll infallible​

infallible fn applyScroll()

paintClose infallible​

infallible fn paintClose(int slot, bool hovered)

paintSlot infallible​

infallible fn paintSlot(int slot, bool hovered)

refresh infallible​

infallible fn refresh()

sync infallible​

infallible fn sync(array<string> titles, array<bool> dirty, int activeIndex) -> int

setActive infallible​

infallible fn setActive(int index)

setDirty infallible​

infallible fn setDirty(int index, bool dirty)

setTitle infallible​

infallible fn setTitle(int index, string title)

clear infallible​

infallible fn clear()

setHandler infallible​

infallible fn setHandler(DocumentTabHandler handler)

setTabWidth infallible​

infallible fn setTabWidth(float width)

requestSelect infallible​

infallible fn requestSelect(int slot)

requestClose infallible​

infallible fn requestClose(int slot)

scrollBy infallible​

infallible fn scrollBy(int direction)

uiLayoutChanged​

fn uiLayoutChanged(float x, float y, float width, float height)

addSlot infallible​

infallible fn addSlot()

FileExplorerNode​

Object

FieldTypeWritableDescription
namestringyes
relativePathstringyes
isDirectoryboolyes
sizeintyes
depthintyes
expandedboolyes

FileExplorer​

Object

FieldTypeWritableDescription
libUiLibyes
themeThemeyes
handlerFileExplorerHandleryes
rootUiElementyes
rowsHostUiElementyes
scrollbarTrackUiElementyes
scrollbarThumbUiElementyes
rowRootsarray<UiElement>yes
rowChevronsarray<UiElement>yes
rowIconsarray<UiElement>yes
rowLabelsarray<UiElement>yes
rowWidgetsarray<Widget>yes
refreshButtonWidgetyes
deleteButtonWidgetyes
nodesarray<FileExplorerNode>yes
rootPathstringyes
selectedPathstringyes
activePathstringyes
rootEntryCountintyes
firstintyes
rowsHeightfloatyes
scrollbarHeightfloatyes
scrollbarThumbHeightfloatyes
scrollbarDragRemainderfloatyes

setHandler infallible​

infallible fn setHandler(FileExplorerHandler handler)

entryCount infallible​

infallible fn entryCount() -> int

visibleRows infallible​

infallible fn visibleRows() -> int

indexOf infallible​

infallible fn indexOf(string relativePath) -> int

clampFirst infallible​

infallible fn clampFirst()

refreshScrollbar infallible​

infallible fn refreshScrollbar()

paintRow infallible​

infallible fn paintRow(int row, bool hovered)

refresh infallible​

infallible fn refresh()

clear infallible​

infallible fn clear()

showRoot infallible​

infallible fn showRoot(string rootPath, array<FileEntry> entries)

load​

fn load(string rootPath)

reload​

fn reload()

reloadPreservingState​

fn reloadPreservingState()

setPresentation infallible​

infallible fn setPresentation(string selectedPath, string activePath)

setSelectedPath infallible​

infallible fn setSelectedPath(string relativePath)

setActivePath infallible​

infallible fn setActivePath(string relativePath)

selectNode infallible​

infallible fn selectNode(FileExplorerNode node)

collapse​

fn collapse(int index)

populate​

fn populate(int index) -> int

expand​

fn expand(int index)

reveal​

fn reveal(string relativePath)

activateRow​

fn activateRow(int row)

requestDeleteSelected infallible​

infallible fn requestDeleteSelected()

reportFailure infallible​

infallible fn reportFailure(string relativePath, string message)

pathAtRow infallible​

infallible fn pathAtRow(int row) -> string

setRowsHeight infallible​

infallible fn setRowsHeight(float height)

scroll infallible​

infallible fn scroll(float amountY)

pageScrollbar infallible​

infallible fn pageScrollbar(float y)

beginScrollbarDrag infallible​

infallible fn beginScrollbarDrag()

dragScrollbar infallible​

infallible fn dragScrollbar(float dy)

FilePickerEntry​

Object

FieldTypeWritableDescription
namestringyes
pathstringyes
directoryboolyes
selectableboolyes

FilePicker​

Object

FieldTypeWritableDescription
libUiLibyes
themeThemeyes
rootUiElementyes
cardUiElementyes
headingUiElementyes
titleTextUiElementyes
statusUiElementyes
typeaheadTextUiElementyes
rowsHostUiElementyes
scrollbarTrackUiElementyes
scrollbarThumbUiElementyes
focusWidgetWidgetyes
locationFieldWidgetyes
currentButtonWidgetyes
openButtonWidgetyes
rowRootsarray<UiElement>yes
rowIconsarray<UiElement>yes
rowNamesarray<UiElement>yes
rowDetailsarray<UiElement>yes
rowWidgetsarray<Widget>yes
entriesarray<FilePickerEntry>yes
handlerFilePickerHandleryes
acceptFilefn(string) -> boolyes
fileDetailstringyes
preferredFileNamestringyes
targetFieldFileFieldyes
currentPathstringyes
selectedPathstringyes
typeaheadstringyes
typeaheadGenerationintyes
selectedintyes
firstintyes
rowsHeightfloatyes
scrollbarHeightfloatyes
scrollbarThumbHeightfloatyes
scrollbarDragRemainderfloatyes
cardXfloatyes
cardYfloatyes
cardWidthfloatyes
cardHeightfloatyes
surfaceWidthintyes
surfaceHeightintyes
positionedboolyes
openStateboolyes

setHandler infallible​

infallible fn setHandler(FilePickerHandler handler)

setTitle infallible​

infallible fn setTitle(string title)

setChooseText infallible​

infallible fn setChooseText(string label)

setCurrentLocationText infallible​

infallible fn setCurrentLocationText(string label)

setFileDetail infallible​

infallible fn setFileDetail(string detail)

setPreferredFileName infallible​

infallible fn setPreferredFileName(string name)

setFilter infallible​

infallible fn setFilter(fn(string) -> bool acceptFile)

visibleRows infallible​

infallible fn visibleRows() -> int

clampFirst infallible​

infallible fn clampFirst()

syncSelectedFile infallible​

infallible fn syncSelectedFile()

refreshScrollbar infallible​

infallible fn refreshScrollbar()

paintRow infallible​

infallible fn paintRow(int row, bool hovered)

refreshRows infallible​

infallible fn refreshRows()

ensureSelectionVisible infallible​

infallible fn ensureSelectionVisible()

refreshTypeaheadCaption infallible​

infallible fn refreshTypeaheadCaption()

applyTypeahead​

fn applyTypeahead()

setTypeahead infallible​

infallible fn setTypeahead(string value)

clearTypeahead infallible​

infallible fn clearTypeahead()

expireTypeahead infallible​

infallible fn expireTypeahead(int generation)

appendTypeahead infallible​

infallible fn appendTypeahead(int codepoint)

backspaceTypeahead infallible​

infallible fn backspaceTypeahead() -> bool

load​

fn load(string path)

infallible fn navigate(string path)

activateRow infallible​

infallible fn activateRow(int row)

activateSelected​

fn activateSelected()

selectBy infallible​

infallible fn selectBy(int delta)

scroll infallible​

infallible fn scroll(float amountY)

pageScrollbar infallible​

infallible fn pageScrollbar(float y)

beginScrollbarDrag infallible​

infallible fn beginScrollbarDrag()

dragScrollbar infallible​

infallible fn dragScrollbar(float dy)

goUp infallible​

infallible fn goUp()

goHome infallible​

infallible fn goHome()

goCurrent infallible​

infallible fn goCurrent()

focusList infallible​

infallible fn focusList()

present infallible​

infallible fn present(string preferredPath)

show infallible​

infallible fn show(string preferredPath)

showFor infallible​

infallible fn showFor(FileField field, string preferredPath)

bindField infallible​

infallible fn bindField(FileField field, string preferredPath)

hide infallible​

infallible fn hide()

choose​

fn choose()

cancel infallible​

infallible fn cancel()

resize infallible​

infallible fn resize(int width, int height)

placeCard infallible​

infallible fn placeCard()

moveBy infallible​

infallible fn moveBy(float dx, float dy)

uiResized infallible​

infallible fn uiResized(int width, int height)

setRowsHeight infallible​

infallible fn setRowsHeight(float height)

FlowText​

Object

FieldTypeWritableDescription
libUiLibyes
rootUiElementyes
valuestringyes
fontSizefloatyes
widthfloatyes
metricsarray<float>yes

fit infallible​

infallible fn fit()

setText infallible​

infallible fn setText(string value) -> bool

setSelectable infallible​

infallible fn setSelectable(bool selectable) -> bool

clearSelectable infallible​

infallible fn clearSelectable() -> bool

selectedText infallible​

infallible fn selectedText() -> string

uiLayoutChanged​

fn uiLayoutChanged(float x, float y, float width, float height)

FolderTreeItem​

Object

FieldTypeWritableDescription
keystringyes
namestringyes
detailstringyes
iconstringyes
searchTextstringyes
enabledboolyes

FolderTreeFolder​

Object

FieldTypeWritableDescription
namestringyes
pathstringyes
keystringyes
sortKeystringyes
parentintyes
countintyes
childrenarray<int>yes

FolderTreeIndex​

Object

FieldTypeWritableDescription
foldersarray<FolderTreeFolder>yes
folderIdsmap<string, int>yes
itemFoldersarray<int>yes
searchablearray<string>yes
sortKeysarray<string>yes
itemsarray<FolderTreeItem>yes

folder​

fn folder(int parent, string name, string key) -> int

add​

fn add(int parent, FolderTreeItem item) -> int

directory​

fn directory(int parent, string path, string keyPrefix) -> int

finish infallible​

infallible fn finish()

before infallible​

infallible fn before(int left, int right) -> bool

sort infallible​

infallible fn sort(array<int> rows)

FolderTreeRow​

Object

FieldTypeWritableDescription
entryintyes
depthintyes

FolderTree​

Object

FieldTypeWritableDescription
libUiLibyes
themeThemeyes
handlerFolderTreeHandleryes
rootUiElementyes
summaryFlowTextyes
filterFieldWidgetyes
collapseButtonWidgetyes
locationFlowTextyes
indexFolderTreeIndexyes
expandedmap<string,bool>yes
rowsHostUiElementyes
rowsWidthfloatyes
emptyStateUiElementyes
scrollbarTrackUiElementyes
scrollbarThumbUiElementyes
rowRootsarray<UiElement>yes
rowIconsarray<UiElement>yes
rowArrowsarray<UiElement>yes
rowNamesarray<UiElement>yes
rowKindsarray<UiElement>yes
rowWidgetsarray<Widget>yes
visibleNodesarray<FolderTreeRow>yes
scopestringyes
revisionintyes
titlestringyes
querystringyes
selectedintyes
firstintyes
rowsHeightfloatyes
scrollbarHeightfloatyes
scrollbarThumbHeightfloatyes
scrollbarDragRemainderfloatyes

setHandler infallible​

infallible fn setHandler(FolderTreeHandler handler)

visibleRows infallible​

infallible fn visibleRows() -> int

clampFirst infallible​

infallible fn clampFirst()

refreshScrollbar infallible​

infallible fn refreshScrollbar()

paintRow infallible​

infallible fn paintRow(int row, bool hovered)

refreshRows infallible​

infallible fn refreshRows()

rebuildFilter​

fn rebuildFilter()

isExpanded infallible​

infallible fn isExpanded(string key) -> bool

toggleFolder infallible​

infallible fn toggleFolder(int folder)

collapseAll infallible​

infallible fn collapseAll()

setQuery infallible​

infallible fn setQuery(string query)

show infallible​

infallible fn show(FolderTreeIndex index, string scope)

setSelected infallible​

infallible fn setSelected(int index)

itemAtRow infallible​

infallible fn itemAtRow(int row) -> int

activateRow infallible​

infallible fn activateRow(int row)

setRowsHeight infallible​

infallible fn setRowsHeight(float height)

scroll infallible​

infallible fn scroll(float amountY)

pageScrollbar infallible​

infallible fn pageScrollbar(float y)

beginScrollbarDrag infallible​

infallible fn beginScrollbarDrag()

dragScrollbar infallible​

infallible fn dragScrollbar(float dy)

UiAnchoredChild​

Object

FieldTypeWritableDescription
valueUiElementyes

leftToParent infallible​

infallible fn leftToParent(float inset) -> UiAnchoredChild

topToParent infallible​

infallible fn topToParent(float inset) -> UiAnchoredChild

rightToParent infallible​

infallible fn rightToParent(float inset) -> UiAnchoredChild

bottomToParent infallible​

infallible fn bottomToParent(float inset) -> UiAnchoredChild

below infallible​

infallible fn below(UiElement sibling, float gap) -> UiAnchoredChild

above infallible​

infallible fn above(UiElement sibling, float gap) -> UiAnchoredChild

rightOf infallible​

infallible fn rightOf(UiElement sibling, float gap) -> UiAnchoredChild

leftOf infallible​

infallible fn leftOf(UiElement sibling, float gap) -> UiAnchoredChild

fillParent infallible​

infallible fn fillParent(float inset) -> UiAnchoredChild

fillParentWidth infallible​

infallible fn fillParentWidth(float leftInset, float rightInset) -> UiAnchoredChild

fillParentHeight infallible​

infallible fn fillParentHeight(float topInset, float bottomInset) -> UiAnchoredChild

fixedWidth infallible​

infallible fn fixedWidth(float width) -> UiAnchoredChild

fixedHeight infallible​

infallible fn fixedHeight(float height) -> UiAnchoredChild

fixedSize infallible​

infallible fn fixedSize(float width, float height) -> UiAnchoredChild

element infallible​

infallible fn element() -> UiElement

UiFlexChild​

Object

FieldTypeWritableDescription
valueUiElementyes

grow infallible​

infallible fn grow(float factor) -> UiFlexChild

alignSelf infallible​

infallible fn alignSelf(int alignment) -> UiFlexChild

fixedWidth infallible​

infallible fn fixedWidth(float width) -> UiFlexChild

fixedHeight infallible​

infallible fn fixedHeight(float height) -> UiFlexChild

fixedSize infallible​

infallible fn fixedSize(float width, float height) -> UiFlexChild

margin infallible​

infallible fn margin(
float left,
float top,
float right,
float bottom) -> UiFlexChild

marginAll infallible​

infallible fn marginAll(float amount) -> UiFlexChild

element infallible​

infallible fn element() -> UiElement

UiFlexContainer​

Object

FieldTypeWritableDescription
valueUiElementyes

gap infallible​

infallible fn gap(float amount) -> UiFlexContainer

padding infallible​

infallible fn padding(
float left,
float top,
float right,
float bottom) -> UiFlexContainer

paddingAll infallible​

infallible fn paddingAll(float amount) -> UiFlexContainer

alignItems infallible​

infallible fn alignItems(int alignment) -> UiFlexContainer

justifyContent infallible​

infallible fn justifyContent(int justification) -> UiFlexContainer

fixedWidth infallible​

infallible fn fixedWidth(float width) -> UiFlexContainer

fixedHeight infallible​

infallible fn fixedHeight(float height) -> UiFlexContainer

fixedSize infallible​

infallible fn fixedSize(float width, float height) -> UiFlexContainer

element infallible​

infallible fn element() -> UiElement

PreviewSession​

Object

FieldTypeWritableDescription
stepschannel<UiInputStep>yes
handlerPreviewSessionHandleryes
runningboolyes
pendingboolyes
generationintyes
lastTimefloatyes

stop infallible​

infallible fn stop()

start infallible​

infallible fn start()

schedule infallible​

infallible fn schedule()

deliver infallible​

infallible fn deliver(int generation, float now)

PreviewTimeline​

Object

FieldTypeWritableDescription
rootUiElementyes
titleUiElementyes
readoutUiElementyes
rulerTimelineyes
transportPreviewTransportyes
handlerPreviewTimelineHandleryes
contextstringyes
durationfloatyes
availableboolyes

configure infallible​

infallible fn configure(
string context,
float duration,
float snap,
bool available)

sync infallible​

infallible fn sync(float time, bool playing, string detail)

timelineSeek infallible​

infallible fn timelineSeek(float time)

timelineSelect infallible​

infallible fn timelineSelect(int key)

timelineMove infallible​

infallible fn timelineMove(int key, float time, bool commit)

timelineCancelled infallible​

infallible fn timelineCancelled()

PreviewTransport​

Object

FieldTypeWritableDescription
rootUiElementyes
playWidgetyes
pauseWidgetyes
stopWidgetyes
restartWidgetyes

PreviewTimeControl​

Object

FieldTypeWritableDescription
sliderWidgetyes
readoutUiElementyes

PreviewTimeStep​

Object

FieldTypeWritableDescription
timefloatyes
finishedboolyes
wrappedboolyes

PreviewFrameStep​

Object

FieldTypeWritableDescription
frameintyes
directionintyes
remainderfloatyes
finishedboolyes

CtMotionVector​

Object

FieldTypeWritableDescription
xfloatyes
yfloatyes
zfloatyes

UiStyle​

Object

FieldTypeWritableDescription
rulesarray<UiStyleRule>yes

apply infallible​

infallible fn apply(UiElement element)

applyTo infallible​

infallible fn applyTo(UiElement element) -> UiElement

composed infallible​

infallible fn composed(UiStyle overrides) -> UiStyle

TextWordRange​

Object

FieldTypeWritableDescription
startintyes
endintyes

TextInput​

Object

FieldTypeWritableDescription
registryUiRegistryyes
faceUiElementyes
viewportUiElementyes
textUiElementyes
caretUiElementyes
selectionUiElementyes
scratcharray<float>yes
valuestringyes
cursorintyes
anchorintyes
fontSizefloatyes
insetfloatyes
rightInsetfloatyes
widthfloatyes
scrollXfloatyes
focusedboolyes
passwordboolyes
draggingboolyes
lastClickTimefloatyes
lastClickXfloatyes
lastClickYfloatyes
wordDragTextWordRangeyes

hasSelection infallible​

infallible fn hasSelection() -> bool

selectionStart infallible​

infallible fn selectionStart() -> int

selectionEnd infallible​

infallible fn selectionEnd() -> int

selectedText​

fn selectedText() -> string

displayPrefix​

fn displayPrefix(int column) -> string

pixels​

fn pixels(int column) -> float

refresh​

fn refresh()

setFocused​

fn setFocused(bool focused)

setText​

fn setText(string value)

restore​

fn restore(string value, int cursor, int anchor, float scrollX)

replaceSelection​

fn replaceSelection(string value)

pasted​

fn pasted(string value)

charTyped​

fn charTyped(int codepoint)

keyDown​

fn keyDown(int key, int modifiers)

columnAt​

fn columnAt(float x) -> int

press​

fn press(float x, float y, int modifiers, float now)

drag​

fn drag(float x, float y)

release infallible​

infallible fn release()

Color​

Object

FieldTypeWritableDescription
rfloatyes
gfloatyes
bfloatyes
afloatyes

Theme​

Object

FieldTypeWritableDescription
panelTopColoryes
panelBottomColoryes
panelBorderColoryes
titleBarFillColoryes
titleTextColoryes
textPrimaryColoryes
textDimColoryes
accentColoryes
goodColoryes
warningColoryes
dangerColoryes
widgetFillColoryes
widgetHoverColoryes
widgetActiveColoryes
widgetBorderColoryes
widgetDisabledColoryes
fieldFillColoryes
fieldBorderColoryes
chromeBorderColoryes
menuFillColoryes
menuHoverColoryes
menuActiveColoryes
menuSeparatorColoryes
titleSizefloatyes
labelSizefloatyes
valueSizefloatyes
titleHeightfloatyes
rowHeightfloatyes
padfloatyes
gapfloatyes
cornerfloatyes
panelCascadefloatyes

TimelineRange​

Object

FieldTypeWritableDescription
durationfloatyes
startfloatyes
spanfloatyes
widthfloatyes

normalize infallible​

infallible fn normalize()

usableWidth infallible​

infallible fn usableWidth() -> float

x infallible​

infallible fn x(float time) -> float

time infallible​

infallible fn time(float x) -> float

fit infallible​

infallible fn fit()

zoom infallible​

infallible fn zoom(float factor, float anchor)

pan infallible​

infallible fn pan(float seconds)

reveal infallible​

infallible fn reveal(float time)

tickStep infallible​

infallible fn tickStep() -> float

Timeline​

Object

FieldTypeWritableDescription
libUiLibyes
formPanelyes
themeThemeyes
rootUiElementyes
plotUiElementyes
playheadUiElementyes
hitWidgetyes
zoomInWidgetyes
zoomOutWidgetyes
fitWidgetyes
panWidgetyes
markersarray<Widget>yes
markerKeysarray<int>yes
ticksarray<UiElement>yes
labelsarray<UiElement>yes
rangeTimelineRangeyes
handlerTimelineHandleryes
timesarray<float>yes
selectedintyes
playTimefloatyes
snapStepfloatyes
enabledboolyes
leftfloatyes
generationintyes
dragKeyintyes
draggingboolyes
draggedboolyes
dragValidboolyes
startXfloatyes
dragOffsetfloatyes
originalTimefloatyes
dragTimefloatyes

snapped infallible​

infallible fn snapped(float time) -> float

setKeys infallible​

infallible fn setKeys(
array<float> times,
int selected,
float duration,
bool reset)

setPlaybackRange infallible​

infallible fn setPlaybackRange(float duration, bool available, bool reset)

setTime infallible​

infallible fn setTime(float time)

paintPlayhead infallible​

infallible fn paintPlayhead()

paint infallible​

infallible fn paint()

begin infallible​

infallible fn begin(int key, float x)

move infallible​

infallible fn move(int generation, float x)

release infallible​

infallible fn release(int generation)

cancel infallible​

infallible fn cancel()

deactivate infallible​

infallible fn deactivate()

zoom infallible​

infallible fn zoom(float factor, float anchor)

keyDown infallible​

infallible fn keyDown(int key, int modifiers)

TimelineContribution​

Object

FieldTypeWritableDescription
rootUiElementyes
buttonWidgetyes
lifecycleWorkspaceViewLifecycleyes

TimelineDock​

Object

FieldTypeWritableDescription
rootUiElementyes
toolbarUiElementyes
contentUiElementyes
formPanelyes
contributionsarray<TimelineContribution>yes
selectedTimelineContributionyes
visibleboolyes

add infallible​

infallible fn add(
string title,
UiElement root,
WorkspaceViewLifecycle lifecycle) -> TimelineContribution

select infallible​

infallible fn select(TimelineContribution contribution)

shown infallible​

infallible fn shown()

hidden infallible​

infallible fn hidden()

CtMotionPose​

Object

FieldTypeWritableDescription
positionCtMotionVectoryes
rotationCtMotionVectoryes
scaleCtMotionVectoryes

CtMotionKey​

Object

FieldTypeWritableDescription
timefloatyes
valueCtMotionVectoryes

CtMotionTrack​

Object

FieldTypeWritableDescription
partstringyes
propertystringyes
interpolationstringyes
quaternionboolyes
curveCtCurveyes
keysarray<CtMotionKey>yes

CtMotionClip​

Object

FieldTypeWritableDescription
versionintyes
bindingstringyes
modelstringyes
durationfloatyes
loopboolyes
tracksarray<CtMotionTrack>yes

CtHierarchyPart​

Object

FieldTypeWritableDescription
namestringyes
parentstringyes
poseCtMotionPoseyes

CtMotionRig​

Object

FieldTypeWritableDescription
restarray<CtHierarchyPart>yes
parentsarray<int>yes
orderarray<int>yes
targetsarray<int>yes
localarray<CtMotionPose>yes
worldarray<CtMotionPose>yes
animatedarray<bool>yes

VectorCanvas​

Object

FieldTypeWritableDescription
libUiLibyes
rootUiElementyes
drawingUiElementyes
widgetWidgetyes
selectionVectorCanvasSelectionyes
underlayVectorCanvasLayer?yes
contentstringyes
screenXfloatyes
screenYfloatyes
widthfloatyes
heightfloatyes
leftfloatyes
topfloatyes
scalefloatyes
boundsXfloatyes
boundsYfloatyes
boundsWidthfloatyes
boundsHeightfloatyes
travelfloatyes
fittedboolyes

paint infallible​

infallible fn paint()

setContent infallible​

infallible fn setContent(string content)

fit infallible​

infallible fn fit()

setBounds infallible​

infallible fn setBounds(float x, float y, float width, float height)

zoomAt infallible​

infallible fn zoomAt(float factor, float x, float y)

zoom infallible​

infallible fn zoom(float factor)

pan infallible​

infallible fn pan(float dx, float dy)

uiLayoutChanged infallible​

infallible fn uiLayoutChanged(float x, float y, float width, float height)

NullController​

Object

FieldTypeWritableDescription
unusedintyes

onClick infallible​

infallible fn onClick(Widget widget)

onValueChanged infallible​

infallible fn onValueChanged(Widget widget, float value)

onValueCommitted infallible​

infallible fn onValueCommitted(Widget widget, float value)

onToggle infallible​

infallible fn onToggle(Widget widget, bool on)

onTextCommitted infallible​

infallible fn onTextCommitted(Widget widget, string text)

onSelected infallible​

infallible fn onSelected(Widget widget, int index)

onClosed infallible​

infallible fn onClosed()

UiLayoutSubscription​

Object

FieldTypeWritableDescription
elementintyes
handlerUiLayoutHandleryes

KeyboardNothing​

Object

focused​

fn focused()

blurred​

fn blurred()

keyDown​

fn keyDown(int key, int modifiers)

charTyped​

fn charTyped(int codepoint)

ScrollNothing​

Object

scrolled​

fn scrolled(float amountX, float amountY)

DragNothing​

Object

moved​

fn moved(float x, float y, float dx, float dy)

released​

fn released()

PressInert​

Object

pressed​

fn pressed(Widget widget, float x, float y)

clicked​

fn clicked(Widget widget, float x, float y)

PressButton​

Object

pressed​

fn pressed(Widget widget, float x, float y)

clicked​

fn clicked(Widget widget, float x, float y)

Widget​

Object

FieldTypeWritableDescription
libUiLibyes
rootUiElementyes
faceUiElementyes
captionUiElementyes
textUiElementyes
fillUiElementyes
caretUiElementyes
markUiElementyes
tokenintyes
onboolyes
enabledboolyes
pressedboolyes
pointerButtonintyes
acceptMiddleButtonboolyes
acceptRightButtonboolyes
styledboolyes
toggleStyleboolyes
styleRoleintyes
toneintyes
valuefloatyes
minValuefloatyes
maxValuefloatyes
stepfloatyes
decimalsintyes
fontSizefloatyes
fieldKindintyes
fieldInsetfloatyes
readoutTokenintyes
inputTextInputyes
committedstringyes
pressWidgetPressyes
clickfn(Widget) -> voidyes
clickBindingUiClickBindingyes
textEditUiTextEdityes
activationintyes
hoverWidgetHoveryes
pointerMotionWidgetPointerMotionyes
scrollUiScrollHandleryes
commitFieldCommityes
panelPanelyes

setText infallible​

infallible fn setText(string value)

setSelectable infallible​

infallible fn setSelectable(bool selectable) -> bool

clearSelectable infallible​

infallible fn clearSelectable() -> bool

selectedText infallible​

infallible fn selectedText() -> string

setCaption infallible​

infallible fn setCaption(string value)

setHover infallible​

infallible fn setHover(WidgetHover hover)

setPointerMotion infallible​

infallible fn setPointerMotion(WidgetPointerMotion motion)

setScroll infallible​

infallible fn setScroll(UiScrollHandler scroll)

setPointerButton infallible​

infallible fn setPointerButton(int button)

setFieldText​

fn setFieldText(string value)

fieldText infallible​

infallible fn fieldText() -> string

ensureInput​

fn ensureInput()

pasteFieldText​

fn pasteFieldText(string text)

acceptsFieldCharacter​

fn acceptsFieldCharacter(int codepoint) -> bool

setNumberFieldValue​

fn setNumberFieldValue(float value)

stepNumberField​

fn stepNumberField(float direction)

setValue​

fn setValue(float value)

setToggle infallible​

infallible fn setToggle(bool on)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

setOnClick infallible​

infallible fn setOnClick(fn(Widget) -> void click)

setOnClickBinding infallible​

infallible fn setOnClickBinding(UiClickBinding binding)

setOnTextEdited infallible​

infallible fn setOnTextEdited(UiTextEdit textEdit)

setTone infallible​

infallible fn setTone(int tone)

setStyleRole infallible​

infallible fn setStyleRole(int role)

restyle infallible​

infallible fn restyle(bool hover)

Tabs​

Object

FieldTypeWritableDescription
panelPanelyes
buttonsarray<Widget>yes
pagesarray<UiElement>yes
activeintyes

select infallible​

infallible fn select(int index)

page infallible​

infallible fn page(int index) -> UiElement

Combo​

Object

FieldTypeWritableDescription
libUiLibyes
buttonWidgetyes
captionUiElementyes
arrowUiElementyes
arrowHostUiElementyes
popupUiElementyes
optionsarray<Widget>yes
optionTextsarray<string>yes
selectedintyes
openStateboolyes
selectionHandlerComboSelectionHandleryes

setSelectionHandler infallible​

infallible fn setSelectionHandler(ComboSelectionHandler handler)

toggleOpen​

fn toggleOpen()

close infallible​

infallible fn close()

styleOption infallible​

infallible fn styleOption(Widget option)

choose infallible​

infallible fn choose(int index)

select infallible​

infallible fn select(int index)

setOptions infallible​

infallible fn setOptions(array<string> texts, int initial)

ColorPicker​

Object

FieldTypeWritableDescription
panelPanelyes
rootUiElementyes
captionUiElementyes
previewUiElementyes
saturationValueHueUiElementyes
saturationGuideUiElementyes
valueGuideUiElementyes
hueGuideUiElementyes
alphaGradientUiElementyes
alphaGuideUiElementyes
exactUiElementyes
grayscaleboolyes
alphaEnabledboolyes
planeHeightfloatyes
saturationValueControlWidgetyes
hueControlWidgetyes
alphaControlWidgetyes
hexFieldWidgetyes
valueColoryes
huefloatyes
saturationfloatyes
brightnessfloatyes
colorChangedfn(ColorPicker, Color) -> voidyes
colorCommittedfn(ColorPicker, Color) -> voidyes
colorBindingUiColorPickerBindingyes

selectedColor infallible​

infallible fn selectedColor() -> Color

setGrayscale​

fn setGrayscale(bool grayscale)

setAlphaEnabled infallible​

infallible fn setAlphaEnabled(bool enabled)

setPlaneHeight infallible​

infallible fn setPlaneHeight(float height)

updateLayout infallible​

infallible fn updateLayout()

setOnColorChanged infallible​

infallible fn setOnColorChanged(fn(ColorPicker, Color) -> void colorChanged)

setOnColorCommitted infallible​

infallible fn setOnColorCommitted(
fn(ColorPicker, Color) -> void colorCommitted)

setOnColorBinding infallible​

infallible fn setOnColorBinding(UiColorPickerBinding binding)

notifyColorChanged​

fn notifyColorChanged()

notifyColorCommitted​

fn notifyColorCommitted()

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

owns infallible​

infallible fn owns(Widget widget) -> bool

repaint​

fn repaint()

setColor​

fn setColor(Color value)

updateColorFromHsv​

fn updateColorFromHsv()

selectSaturationValue​

fn selectSaturationValue(float saturation, float brightness)

selectHue​

fn selectHue(float hue)

selectAlpha​

fn selectAlpha(float alpha)

commitHex​

fn commitHex(string text)

commitColor​

fn commitColor()

saturationValueAt​

fn saturationValueAt(
float left,
float top,
float width,
float height,
float x,
float y)

hueAt​

fn hueAt(float top, float height, float y)

alphaAt​

fn alphaAt(float left, float width, float x)

beginSaturationValue​

fn beginSaturationValue(float x, float y)

beginHue​

fn beginHue(float x, float y)

beginAlpha​

fn beginAlpha(float x, float y)

VectorField​

Object

FieldTypeWritableDescription
rootUiElementyes
captionUiElementyes
inputsUiElementyes
componentsarray<Widget>yes
stackedboolyes

uiLayoutChanged infallible​

infallible fn uiLayoutChanged(float x, float y, float width, float height)

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

owns infallible​

infallible fn owns(Widget widget) -> bool

setComponentText infallible​

infallible fn setComponentText(int index, string value)

valueText infallible​

infallible fn valueText() -> string

SearchField​

Object

FieldTypeWritableDescription
rootUiElementyes
fieldWidgetyes
clearButtonWidgetyes

setText​

fn setText(string value)

text infallible​

infallible fn text() -> string

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

NumberField​

Object

FieldTypeWritableDescription
rootUiElementyes
fieldWidgetyes
decrementButtonWidgetyes
incrementButtonWidgetyes

setValue​

fn setValue(float value)

selectedValue infallible​

infallible fn selectedValue() -> float

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

RadioGroup​

Object

FieldTypeWritableDescription
panelPanelyes
rootUiElementyes
captionUiElementyes
optionsarray<Widget>yes
optionTextsarray<string>yes
selectedintyes
onSelectedfn(RadioGroup, int, string) -> voidyes

setOnSelected infallible​

infallible fn setOnSelected(fn(RadioGroup, int, string) -> void onSelected)

select infallible​

infallible fn select(int index)

choose​

fn choose(int index)

selectedValue infallible​

infallible fn selectedValue() -> string

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

FileField​

Object

FieldTypeWritableDescription
rootUiElementyes
pathFieldWidgetyes
chooseButtonWidgetyes
onChoosefn(FileField) -> voidyes
onSelectedfn(FileField, string) -> voidyes

setPath​

fn setPath(string path)

path infallible​

infallible fn path() -> string

setOnChoose infallible​

infallible fn setOnChoose(fn(FileField) -> void onChoose)

setOnSelected infallible​

infallible fn setOnSelected(fn(FileField, string) -> void onSelected)

selectPath​

fn selectPath(string path)

setVisible infallible​

infallible fn setVisible(bool visible)

setEnabled infallible​

infallible fn setEnabled(bool enabled)

Panel​

Object

FieldTypeWritableDescription
libUiLibyes
rootUiElementyes
titleBarUiElementyes
titleTextUiElementyes
bodyUiElementyes
controllerUiControlleryes
xfloatyes
yfloatyes
widthfloatyes
heightfloatyes

setSelectable infallible​

infallible fn setSelectable(bool selectable) -> bool

clearSelectable infallible​

infallible fn clearSelectable() -> bool

selectedText infallible​

infallible fn selectedText() -> string

fitToScreen infallible​

infallible fn fitToScreen()

show infallible​

infallible fn show(bool visible)

bringToFront infallible​

infallible fn bringToFront()

setTitle infallible​

infallible fn setTitle(string title)

moveBy infallible​

infallible fn moveBy(float dx, float dy)

label infallible​

infallible fn label(string caption) -> Widget

labelIn infallible​

infallible fn labelIn(UiElement host, string caption) -> Widget

section infallible​

infallible fn section(string caption) -> Widget

sectionIn infallible​

infallible fn sectionIn(UiElement host, string caption) -> Widget

help infallible​

infallible fn help(string caption) -> Widget

helpIn infallible​

infallible fn helpIn(UiElement host, string caption) -> Widget

status infallible​

infallible fn status(string caption) -> Widget

statusIn infallible​

infallible fn statusIn(UiElement host, string caption) -> Widget

valueRow infallible​

infallible fn valueRow(string caption, string initial) -> Widget

button infallible​

infallible fn button(string caption) -> Widget

toggle infallible​

infallible fn toggle(string caption, bool initial) -> Widget

buttonIn infallible​

infallible fn buttonIn(UiElement host, string caption) -> Widget

contentButtonIn infallible​

infallible fn contentButtonIn(UiElement host, string caption) -> Widget

toggleIn infallible​

infallible fn toggleIn(UiElement host, string caption, bool initial) -> Widget

buttonOnClick infallible​

infallible fn buttonOnClick(string caption, fn(Widget) -> void click) -> Widget

buttonOnClickIn infallible​

infallible fn buttonOnClickIn(
UiElement host,
string caption,
fn(Widget) -> void click) -> Widget

toggleOnClick infallible​

infallible fn toggleOnClick(
string caption,
bool initial,
fn(Widget) -> void click) -> Widget

toggleOnClickIn infallible​

infallible fn toggleOnClickIn(
UiElement host,
string caption,
bool initial,
fn(Widget) -> void click) -> Widget

pressableIn infallible​

infallible fn pressableIn(
UiElement host,
string caption,
WidgetPress press,
bool on,
bool toggleStyle) -> Widget

sliderIn​

fn sliderIn(
UiElement host,
string caption,
float minValue,
float maxValue,
float initial,
int decimals) -> Widget

slider​

fn slider(
string caption,
float minValue,
float maxValue,
float initial,
int decimals) -> Widget

typedTextFieldIn​

fn typedTextFieldIn(
UiElement host,
string caption,
string initial,
int fieldKind) -> Widget

textFieldIn​

fn textFieldIn(UiElement host, string caption, string initial) -> Widget

textField​

fn textField(string caption, string initial) -> Widget

passwordFieldIn​

fn passwordFieldIn(UiElement host, string caption, string initial) -> Widget

passwordField​

fn passwordField(string caption, string initial) -> Widget

urlFieldIn​

fn urlFieldIn(UiElement host, string caption, string initial) -> Widget

urlField​

fn urlField(string caption, string initial) -> Widget

telephoneFieldIn​

fn telephoneFieldIn(UiElement host, string caption, string initial) -> Widget

telephoneField​

fn telephoneField(string caption, string initial) -> Widget

timeFieldIn​

fn timeFieldIn(UiElement host, string caption, string initial) -> Widget

timeField​

fn timeField(string caption, string initial) -> Widget

searchFieldIn​

fn searchFieldIn(UiElement host, string caption, string initial) -> SearchField

searchField​

fn searchField(string caption, string initial) -> SearchField

numberStepButton infallible​

infallible fn numberStepButton(
UiElement host,
Widget field,
float direction,
string icon) -> Widget

numberFieldIn​

fn numberFieldIn(
UiElement host,
string caption,
float minValue,
float maxValue,
float step,
float initial,
int decimals) -> NumberField

numberField​

fn numberField(
string caption,
float minValue,
float maxValue,
float step,
float initial,
int decimals) -> NumberField

vectorFieldIn​

fn vectorFieldIn(
UiElement host,
string caption,
array<string> componentLabels,
array<string> initial) -> VectorField

vectorField​

fn vectorField(
string caption,
array<string> componentLabels,
array<string> initial) -> VectorField

radioGroupIn infallible​

infallible fn radioGroupIn(
UiElement host,
string caption,
array<string> options,
int initial) -> RadioGroup

radioGroup infallible​

infallible fn radioGroup(
string caption,
array<string> options,
int initial) -> RadioGroup

fileFieldIn​

fn fileFieldIn(
UiElement host,
string caption,
string initial,
string chooseCaption) -> FileField

fileField​

fn fileField(string caption, string initial, string chooseCaption) -> FileField

colorPickerIn​

fn colorPickerIn(UiElement host, string caption, Color initial) -> ColorPicker

colorPicker​

fn colorPicker(string caption, Color initial) -> ColorPicker

tabs infallible​

infallible fn tabs(array<string> titles) -> Tabs

comboIn infallible​

infallible fn comboIn(
UiElement host,
string caption,
array<string> options,
int initial) -> Combo

compactComboIn infallible​

infallible fn compactComboIn(
UiElement host,
array<string> options,
int initial) -> Combo

combo infallible​

infallible fn combo(string caption, array<string> options, int initial) -> Combo

UiLib​

Object

FieldTypeWritableDescription
registryUiRegistryyes
screenUiSurfaceyes
screenIdintyes
screenRootUiElementyes
themeThemeyes
widgetsmap<int, Widget>yes
panelsarray<Panel>yes
resizeHandlersarray<UiResizeHandler>yes
layoutHandlersarray<UiLayoutSubscription>yes
shortcutHandlersarray<UiShortcutHandler>yes
keyReleaseHandlersarray<UiKeyReleaseHandler>yes
screenChildrenarray<UiElement>yes
scratcharray<float>yes
stepschannel<UiInputStep>yes
nextTokenintyes
screenWidthintyes
screenHeightintyes
pressedTokenintyes
pressedActivationintyes
pressedButtonintyes
pointerModifiersintyes
pointerXfloatyes
pointerYfloatyes
pointerTokenintyes
scrollPointerXfloatyes
scrollPointerYfloatyes
hoverTokenintyes
focusTokenintyes
inputOwnerTokenintyes
shortcutBarrierTokenintyes
keyboardFocusTokenintyes
keyboardFocusUiKeyboardHandleryes
clipboardHandlerUiClipboardHandleryes
pendingPasteHandlerUiClipboardHandleryes
pastePendingboolyes
draggingUiDragHandleryes
cascadefloatyes

allocateToken infallible​

infallible fn allocateToken() -> int

setClipboardHandler infallible​

infallible fn setClipboardHandler(UiClipboardHandler handler)

bareWidget infallible​

infallible fn bareWidget(
Panel panel,
UiElement root,
UiElement face,
UiElement text,
WidgetPress press,
int token) -> Widget

register infallible​

infallible fn register(Widget widget)

attach infallible​

infallible fn attach(UiElement element)

onResize infallible​

infallible fn onResize(UiResizeHandler handler)

onLayout infallible​

infallible fn onLayout(UiElement element, UiLayoutHandler handler)

onShortcut infallible​

infallible fn onShortcut(UiShortcutHandler handler)

onKeyRelease infallible​

infallible fn onKeyRelease(UiKeyReleaseHandler handler)

onBrowserLocationChanged infallible​

infallible fn onBrowserLocationChanged(UiBrowserLocationHandler handler)

onWindowCloseRequested infallible​

infallible fn onWindowCloseRequested(UiWindowCloseHandler handler)

setCloseGuard infallible​

infallible fn setCloseGuard(bool guarded) -> bool

confirmClose infallible​

infallible fn confirmClose() -> bool

registerShortcut infallible​

infallible fn registerShortcut(int key, int modifiers) -> bool

unregisterShortcut infallible​

infallible fn unregisterShortcut(int key, int modifiers) -> bool

raiseElement infallible​

infallible fn raiseElement(UiElement element)

beginDrag infallible​

infallible fn beginDrag(Panel panel)

beginWidgetDrag infallible​

infallible fn beginWidgetDrag(UiDragHandler handler)

captureInputFor​

fn captureInputFor(int token)

releaseInputFor infallible​

infallible fn releaseInputFor(int token)

beginSliderDrag​

fn beginSliderDrag(Widget widget, float x)

sliderTo​

fn sliderTo(Widget widget, float trackX, float trackWidth, float x)

focusField​

fn focusField(Widget widget)

focusFieldAt​

fn focusFieldAt(Widget widget, float x)

nextTextBoundary​

fn nextTextBoundary(string text, int offset) -> int

previousTextBoundary​

fn previousTextBoundary(string text, int offset) -> int

focusKeyboard​

fn focusKeyboard(int token, UiKeyboardHandler handler)

blurKeyboard​

fn blurKeyboard()

blurField​

fn blurField(bool commit)

refreshCaret​

fn refreshCaret(Widget widget)

raise infallible​

infallible fn raise(Panel panel)

panel infallible​

infallible fn panel(
string title,
float width,
float height,
UiController controller) -> Panel

pointerDownModified​

fn pointerDownModified(
int surfaceId,
int token,
int button,
float x,
float y,
int modifiers)

pointerDown​

fn pointerDown(int surfaceId, int token, int button, float x, float y)

pointerUp​

fn pointerUp(int surfaceId, int token, int button, float x, float y)

pointerMoved​

fn pointerMoved(
int surfaceId,
int token,
float x,
float y,
float dx,
float dy)

scrolled​

fn scrolled(
int surfaceId,
int token,
float x,
float y,
float amountX,
float amountY)

keyDown​

fn keyDown(int key, int modifiers)

keyUp​

fn keyUp(int key, int modifiers)

charTyped​

fn charTyped(int codepoint)

requestClipboardPaste infallible​

infallible fn requestClipboardPaste(UiClipboardHandler recipient) -> bool

pasted​

fn pasted(string text)

surfaceResized infallible​

infallible fn surfaceResized(int surfaceId, int width, int height)

layoutChanged​

fn layoutChanged(int element, float x, float y, float width, float height)

transitionFinished infallible​

infallible fn transitionFinished(int element, int property)

WorkspaceContextMenuEntry​

Object

FieldTypeWritableDescription
labelstringyes
commandWorkspaceCommandyes

WorkspaceActionMenuEntry​

Object

FieldTypeWritableDescription
labelstringyes
keysstringyes
enabledboolyes
actionWorkspaceCommandActionyes

WorkspaceLayoutViewState​

Object

FieldTypeWritableDescription
idstringyes
openboolyes
regionintyes
orderintyes

WorkspaceLayout​

Object

FieldTypeWritableDescription
schemaintyes
leftWidthfloatyes
rightWidthfloatyes
bottomHeightfloatyes
dockTabsVisibleboolyes
activeLeftstringyes
activeDocumentstringyes
activeRightstringyes
activeBottomstringyes
viewsarray<WorkspaceLayoutViewState>yes

WorkspaceView​

Object

FieldTypeWritableDescription
idstringyes
titlestringyes
activityIconstringyes
regionintyes
orderintyes
defaultRegionintyes
defaultOrderintyes
contentUiElementyes
openboolyes
defaultOpenboolyes
availableboolyes
activityButtonWidgetyes
activityGlyphUiElementyes
tabButtonWidgetyes
tabGlyphUiElementyes
tabActiveBarUiElementyes
menuButtonWidgetyes
menuMarkUiElementyes
menuShortcutUiElementyes
lifecycleWorkspaceViewLifecycleyes
presentedboolyes

WorkspaceShell​

Object

FieldTypeWritableDescription
libUiLibyes
widgetContextPanelyes
commandHandlerWorkspaceCommandHandleryes
commandsWorkspaceCommandRegistryyes
paletteWorkspaceCommandPaletteyes
preferencesHandlerWorkspacePreferencesHandleryes
layoutHandlerWorkspaceLayoutHandleryes
rootUiElementyes
commandBarUiElementyes
menuBarUiElementyes
commandHostUiElementyes
titleTextUiElementyes
workAreaUiElementyes
leftRailUiElementyes
rightRailUiElementyes
leftDockUiElementyes
leftContentUiElementyes
leftTitleUiElementyes
leftTabHostUiElementyes
rightDockUiElementyes
rightContentUiElementyes
rightTitleUiElementyes
rightTabHostUiElementyes
centerUiElementyes
documentContentUiElementyes
documentTitleUiElementyes
documentTabHostUiElementyes
documentEmptyUiElementyes
bottomDockUiElementyes
bottomContentUiElementyes
bottomTitleUiElementyes
bottomTabHostUiElementyes
bottomActivityHostUiElementyes
leftSplitterUiElementyes
leftSplitterLineUiElementyes
rightSplitterUiElementyes
rightSplitterLineUiElementyes
bottomSplitterUiElementyes
bottomSplitterLineUiElementyes
statusBarUiElementyes
statusTextUiElementyes
statusHostUiElementyes
viewMenuUiElementyes
viewMenuItemsUiElementyes
utilityMenuUiElementyes
fileMenuButtonWidgetyes
editMenuButtonWidgetyes
viewMenuButtonWidgetyes
helpMenuButtonWidgetyes
dockTabsButtonWidgetyes
dockTabsMarkUiElementyes
resetButtonWidgetyes
resetShortcutUiElementyes
menuDismissButtonWidgetyes
utilityMenuItemsarray<WorkspaceMenuItem>yes
utilityMenuRulesarray<UiElement>yes
dockMenuItemsarray<WorkspaceMenuItem>yes
leftHideButtonWidgetyes
rightHideButtonWidgetyes
bottomHideButtonWidgetyes
viewsarray<WorkspaceView>yes
retiredViewsarray<WorkspaceView>yes
activeLeftstringyes
activeDocumentstringyes
activeRightstringyes
activeBottomstringyes
responsiveModeintyes
overlayRegionintyes
openMenuintyes
leftWidthfloatyes
rightWidthfloatyes
bottomHeightfloatyes
appliedLeftWidthfloatyes
appliedRightWidthfloatyes
appliedBottomHeightfloatyes
appliedStatusHeightfloatyes
defaultLeftWidthfloatyes
defaultRightWidthfloatyes
defaultBottomHeightfloatyes
surfaceWidthintyes
surfaceHeightintyes
activeSplitterintyes
focusedRegionintyes
dockDropTargetsarray<UiElement>yes
dockDragViewstringyes
dockDragSourceRegionintyes
dockDropRegionintyes
dockDropOrderintyes
dockDragDistancefloatyes
dockPreviewRailfloatyes
dockPreviewLeftWidthfloatyes
dockPreviewRightWidthfloatyes
dockPreviewBottomHeightfloatyes
dockDragMovedboolyes
dockDragCancelledboolyes
dockDragReordersboolyes
dockDragUsesTabsboolyes
dockTabsVisibleboolyes
projectOpenboolyes

paletteLib infallible​

infallible fn paletteLib() -> UiLib

paletteCommands infallible​

infallible fn paletteCommands() -> WorkspaceCommandRegistry

viewIndex infallible​

infallible fn viewIndex(string id) -> int

regionCount infallible​

infallible fn regionCount(int region) -> int

regionHost infallible​

infallible fn regionHost(int region) -> UiElement

regionRail infallible​

infallible fn regionRail(int region) -> UiElement

regionTabHost infallible​

infallible fn regionTabHost(int region) -> UiElement

normalizeRegionOrders infallible​

infallible fn normalizeRegionOrders(int region)

normalizeAllRegionOrders infallible​

infallible fn normalizeAllRegionOrders()

viewAtOrder infallible​

infallible fn viewAtOrder(int region, int order) -> int

syncViewHosts infallible​

infallible fn syncViewHosts()

activeId infallible​

infallible fn activeId(int region) -> string

setActiveId infallible​

infallible fn setActiveId(int region, string id)

firstOpen infallible​

infallible fn firstOpen(int region) -> string

normalizeActive infallible​

infallible fn normalizeActive(int region)

activeTitle infallible​

infallible fn activeTitle(int region) -> string

hasActive infallible​

infallible fn hasActive(int region) -> bool

dockRendered infallible​

infallible fn dockRendered(int region) -> bool

closeMenus infallible​

infallible fn closeMenus()

setViewMenu infallible​

infallible fn setViewMenu(bool visible)

setUtilityMenu infallible​

infallible fn setUtilityMenu(int menu, bool visible)

showCommandMenu infallible​

infallible fn showCommandMenu(
array<WorkspaceContextMenuEntry> entries,
float x,
float y)

showActionMenu infallible​

infallible fn showActionMenu(
array<WorkspaceActionMenuEntry> entries,
float x,
float y)

addView infallible​

infallible fn addView(
string id,
string title,
string activityIcon,
int region,
UiElement content,
bool defaultOpen) -> bool

reuseView infallible​

infallible fn reuseView(
string id,
string title,
string activityIcon,
int region,
UiElement content,
bool defaultOpen,
int order) -> bool

removeView infallible​

infallible fn removeView(string id) -> bool

setViewTitle infallible​

infallible fn setViewTitle(string id, string title) -> bool

setViewLifecycle infallible​

infallible fn setViewLifecycle(string id, WorkspaceViewLifecycle lifecycle) -> bool

setViewAvailable infallible​

infallible fn setViewAvailable(string id, bool available) -> bool

showView infallible​

infallible fn showView(string id) -> bool

hideView infallible​

infallible fn hideView(string id) -> bool

toggleView infallible​

infallible fn toggleView(string id) -> bool

hideActive infallible​

infallible fn hideActive(int region)

focusedViewId infallible​

infallible fn focusedViewId() -> string

moveViewTo infallible​

infallible fn moveViewTo(string id, int targetRegion, int targetOrder) -> bool

moveFocusedViewTo infallible​

infallible fn moveFocusedViewTo(int region) -> bool

reorderFocusedView infallible​

infallible fn reorderFocusedView(int delta) -> bool

syncDockCommands infallible​

infallible fn syncDockCommands()

layoutDockDropTargets infallible​

infallible fn layoutDockDropTargets()

paintDockDropTargets infallible​

infallible fn paintDockDropTargets(int selected, bool visible)

dockRegionAt infallible​

infallible fn dockRegionAt(float x, float y) -> int

dockOrderAt infallible​

infallible fn dockOrderAt(int region, float x, float y, bool useTabs) -> int

beginDockDrag infallible​

infallible fn beginDockDrag(
string id,
float x,
float y,
bool reorder,
bool useTabs) -> bool

updateDockDrag infallible​

infallible fn updateDockDrag(float x, float y, float dx, float dy)

cancelDockDrag infallible​

infallible fn cancelDockDrag()

finishDockDrag infallible​

infallible fn finishDockDrag()

resetLayout infallible​

infallible fn resetLayout()

setTitle infallible​

infallible fn setTitle(string title)

setStatus infallible​

infallible fn setStatus(string status)

setCommandHandler infallible​

infallible fn setCommandHandler(WorkspaceCommandHandler handler)

setLayoutHandler infallible​

infallible fn setLayoutHandler(WorkspaceLayoutHandler handler)

setDockTabsVisible infallible​

infallible fn setDockTabsVisible(bool visible)

captureLayout infallible​

infallible fn captureLayout() -> WorkspaceLayout

serializedLayout infallible​

infallible fn serializedLayout() -> string

layoutChanged infallible​

infallible fn layoutChanged()

restoreLayout infallible​

infallible fn restoreLayout(WorkspaceLayout layout) -> bool

restoreSerializedLayout​

fn restoreSerializedLayout(string serialized) -> bool

commandKeys infallible​

infallible fn commandKeys(string id) -> string

rebindCommand​

fn rebindCommand(string id, int key, int modifiers)

registerNamedCommand infallible​

infallible fn registerNamedCommand(
string id,
string title,
int key,
int modifiers,
bool enabled) -> bool

setCommandAction infallible​

infallible fn setCommandAction(string id, WorkspaceCommandAction action) -> bool

registerCommand infallible​

infallible fn registerCommand(
string id,
int key,
int modifiers,
bool enabled) -> bool

setCommandEnabled infallible​

infallible fn setCommandEnabled(string id, bool enabled) -> bool

invokeCommand infallible​

infallible fn invokeCommand(string id) -> bool

dispatchCommand infallible​

infallible fn dispatchCommand(string id)

setProjectOpen infallible​

infallible fn setProjectOpen(bool open)

setDockSizes infallible​

infallible fn setDockSizes(float left, float right, float bottom)

resetDockSize infallible​

infallible fn resetDockSize(int region)

setSplitterActive infallible​

infallible fn setSplitterActive(int region, bool active)

resizeDockBy infallible​

infallible fn resizeDockBy(int region, float dx, float dy)

chooseMode infallible​

infallible fn chooseMode(int width, int height) -> int

applyResponsive infallible​

infallible fn applyResponsive()

refresh infallible​

infallible fn refresh()

uiResized infallible​

infallible fn uiResized(int width, int height)

uiShortcut​

fn uiShortcut(int key, int modifiers) -> bool

onClick infallible​

infallible fn onClick(Widget widget)

onValueChanged infallible​

infallible fn onValueChanged(Widget widget, float value)

onValueCommitted infallible​

infallible fn onValueCommitted(Widget widget, float value)

onToggle infallible​

infallible fn onToggle(Widget widget, bool on)

onTextCommitted infallible​

infallible fn onTextCommitted(Widget widget, string text)

onSelected infallible​

infallible fn onSelected(Widget widget, int index)

onClosed infallible​

infallible fn onClosed()

WorkspaceCommand​

Object

FieldTypeWritableDescription
idstringyes
titlestringyes
defaultKeyintyes
defaultModifiersintyes
keyintyes
modifiersintyes
enabledboolyes
actionWorkspaceCommandActionyes

WorkspaceCommandRegistry​

Object

FieldTypeWritableDescription
commandsarray<WorkspaceCommand>yes
recentarray<string>yes
unknownBindingsarray<WorkspaceKeyBinding>yes
revisionintyes

index infallible​

infallible fn index(string id) -> int

find infallible​

infallible fn find(string id) -> WorkspaceCommand

add infallible​

infallible fn add(
string id,
int key,
int modifiers,
bool enabled,
WorkspaceCommandAction action) -> bool

chordOwner infallible​

infallible fn chordOwner(int key, int modifiers, string except) -> int

remove infallible​

infallible fn remove(string id) -> bool

setTitle infallible​

infallible fn setTitle(string id, string title)

remember infallible​

infallible fn remember(string id)

setEnabled infallible​

infallible fn setEnabled(string id, bool enabled) -> bool

enabled infallible​

infallible fn enabled(string id) -> bool

invoke infallible​

infallible fn invoke(string id) -> bool

invokeShortcut infallible​

infallible fn invokeShortcut(int key, int modifiers) -> bool

WorkspaceMenuItem​

Object

FieldTypeWritableDescription
widgetWidgetyes
shortcutUiElementyes

configure infallible​

infallible fn configure(
string label,
string keys,
bool enabled,
Theme theme)

hide infallible​

infallible fn hide()

Interfaces​

WorkspacePaletteHost​

Interface

paletteLib infallible​

infallible fn paletteLib() -> UiLib

paletteCommands infallible​

infallible fn paletteCommands() -> WorkspaceCommandRegistry

closeMenus infallible​

infallible fn closeMenus()

commandKeys infallible​

infallible fn commandKeys(string id) -> string

rebindCommand​

fn rebindCommand(string id, int key, int modifiers)

invokeCommand infallible​

infallible fn invokeCommand(string id) -> bool

showView infallible​

infallible fn showView(string id) -> bool

WorkspacePreferencesHandler​

Interface

preferencesChanged infallible​

infallible fn preferencesChanged()

CurveEditorHandler​

Interface

curveChanged infallible​

infallible fn curveChanged(CtCurve curve, bool commit)

curveCancelled infallible​

infallible fn curveCancelled()

DecisionDialogHandler​

Interface

decisionPrimary infallible​

infallible fn decisionPrimary()

decisionSecondary infallible​

infallible fn decisionSecondary()

decisionCancelled infallible​

infallible fn decisionCancelled()

DocumentTabHandler​

Interface

documentTabSelected infallible​

infallible fn documentTabSelected(int index)

documentTabClosed infallible​

infallible fn documentTabClosed(int index)

FileExplorerHandler​

Interface

fileExplorerSelectionChanged infallible​

infallible fn fileExplorerSelectionChanged(
string name,
string relativePath,
bool isDirectory,
int size)

fileExplorerFileActivated infallible​

infallible fn fileExplorerFileActivated(string relativePath)

fileExplorerDirectoryChanged infallible​

infallible fn fileExplorerDirectoryChanged(
string relativePath,
bool expanded,
int childCount)

fileExplorerDeleteRequested infallible​

infallible fn fileExplorerDeleteRequested(
string name,
string relativePath,
bool isDirectory)

fileExplorerFailed infallible​

infallible fn fileExplorerFailed(string relativePath, string message)

FilePickerHandler​

Interface

filePickerChosen infallible​

infallible fn filePickerChosen(string path)

filePickerCancelled infallible​

infallible fn filePickerCancelled()

FolderTreeHandler​

Interface

folderTreeSelected infallible​

infallible fn folderTreeSelected(int index)

UiInputSink​

Interface

pointerDownModified​

fn pointerDownModified(
int surfaceId,
int token,
int button,
float x,
float y,
int modifiers)

pointerUp​

fn pointerUp(int surfaceId, int token, int button, float x, float y)

pointerMoved​

fn pointerMoved(
int surfaceId,
int token,
float x,
float y,
float dx,
float dy)

scrolled​

fn scrolled(
int surfaceId,
int token,
float x,
float y,
float amountX,
float amountY)

keyDown​

fn keyDown(int key, int modifiers)

keyUp​

fn keyUp(int key, int modifiers)

charTyped​

fn charTyped(int codepoint)

pasted​

fn pasted(string text)

surfaceResized​

fn surfaceResized(int surfaceId, int width, int height)

layoutChanged​

fn layoutChanged(int element, float x, float y, float width, float height)

transitionFinished​

fn transitionFinished(int element, int property)

UiInputStep​

Interface

apply​

fn apply(UiInputSink sink)

UiBrowserLocationHandler​

Interface

browserLocationChanged infallible​

infallible fn browserLocationChanged(string location)

UiWindowCloseHandler​

Interface

windowCloseRequested infallible​

infallible fn windowCloseRequested()

PreviewSessionHandler​

Interface

previewTick infallible​

infallible fn previewTick(float elapsed)

PreviewTimelineHandler​

Interface

previewSeek infallible​

infallible fn previewSeek(float time)

previewPlay infallible​

infallible fn previewPlay()

previewPause infallible​

infallible fn previewPause()

previewStop infallible​

infallible fn previewStop()

UiStyleRule​

Interface

apply infallible​

infallible fn apply(UiElement element)

TimelineHandler​

Interface

timelineSeek infallible​

infallible fn timelineSeek(float time)

timelineSelect infallible​

infallible fn timelineSelect(int key)

timelineMove infallible​

infallible fn timelineMove(int key, float time, bool commit)

timelineCancelled infallible​

infallible fn timelineCancelled()

VectorCanvasSelection​

Interface

selected​

fn selected(float x, float y)

VectorCanvasLayer​

Interface

paint infallible​

infallible fn paint(VectorCanvas view)

UiController​

Interface

onClick infallible​

infallible fn onClick(Widget widget)

onValueChanged infallible​

infallible fn onValueChanged(Widget widget, float value)

onValueCommitted infallible​

infallible fn onValueCommitted(Widget widget, float value)

onToggle infallible​

infallible fn onToggle(Widget widget, bool on)

onTextCommitted infallible​

infallible fn onTextCommitted(Widget widget, string text)

onSelected infallible​

infallible fn onSelected(Widget widget, int index)

onClosed infallible​

infallible fn onClosed()

UiClickBinding​

Interface

invoke​

fn invoke(Widget widget)

UiTextEdit​

Interface

onTextEdited infallible​

infallible fn onTextEdited(Widget widget, string text)

UiResizeHandler​

Interface

uiResized infallible​

infallible fn uiResized(int width, int height)

UiLayoutHandler​

Interface

uiLayoutChanged​

fn uiLayoutChanged(float x, float y, float width, float height)

UiShortcutHandler​

Interface

uiShortcut​

fn uiShortcut(int key, int modifiers) -> bool

UiKeyReleaseHandler​

Interface

uiKeyReleased​

fn uiKeyReleased(int key, int modifiers)

WidgetPress​

Interface

pressed​

fn pressed(Widget widget, float x, float y)

clicked​

fn clicked(Widget widget, float x, float y)

ComboSelectionHandler​

Interface

comboSelected infallible​

infallible fn comboSelected(int index, string value)

WidgetHover​

Interface

changed​

fn changed(Widget widget, bool hovered)

WidgetPointerMotion​

Interface

moved​

fn moved(Widget widget, float x, float y)

UiKeyboardHandler​

Interface

focused​

fn focused()

blurred​

fn blurred()

keyDown​

fn keyDown(int key, int modifiers)

charTyped​

fn charTyped(int codepoint)

UiClipboardHandler​

Interface

pasted​

fn pasted(string text)

UiScrollHandler​

Interface

scrolled​

fn scrolled(float amountX, float amountY)

UiDragHandler​

Interface

moved​

fn moved(float x, float y, float dx, float dy)

released​

fn released()

FieldCommit​

Interface

committed​

fn committed(Widget widget, string text)

UiColorPickerBinding​

Interface

changed​

fn changed(ColorPicker picker, Color value)

committed​

fn committed(ColorPicker picker, Color value)

WorkspaceViewLifecycle​

Interface

shown infallible​

infallible fn shown()

hidden infallible​

infallible fn hidden()

WorkspaceLayoutHandler​

Interface

workspaceLayoutChanged infallible​

infallible fn workspaceLayoutChanged(string serialized)

WorkspaceCommandHandler​

Interface

workspaceCommand infallible​

infallible fn workspaceCommand(string id)

WorkspaceCommandAction​

Interface

execute infallible​

infallible fn execute()

Functions​

ctAnimationText​

fn ctAnimationText(yaml doc, string path, string fallback) -> string

ctRigFormat infallible​

infallible fn ctRigFormat() -> FileFormat

The .rig file format this cTurtle reads. A clip can also bind to a scene file, which is checked against the scene format instead.

ctAnimationBindingParse​

fn ctAnimationBindingParse(string source) -> CtAnimationBinding

ctAnimationBindingLoad​

fn ctAnimationBindingLoad(string path) -> CtAnimationBinding

ctAnimationBindingRest infallible​

infallible fn ctAnimationBindingRest(
CtAnimationBinding binding) -> array<CtHierarchyPart>

ctAnimationBind​

fn ctAnimationBind(CtAnimationBinding binding, CtMotionClip clip) -> CtMotionRig

workspaceCommandResults​

fn workspaceCommandResults(
WorkspaceCommandRegistry registry,
string query) -> array<string>

workspaceCommandKeys​

fn workspaceCommandKeys(WorkspaceCommand command) -> string

workspaceCommandCategory​

fn workspaceCommandCategory(string title) -> string

workspaceCommandLabel​

fn workspaceCommandLabel(string title) -> string

workspaceBindingResults​

fn workspaceBindingResults(
WorkspaceCommandRegistry registry,
string query) -> array<string>

workspaceCommandKeybindings infallible​

infallible fn workspaceCommandKeybindings() -> string

workspaceChordValid infallible​

infallible fn workspaceChordValid(int key, int modifiers) -> bool

workspacePreferencesParse​

fn workspacePreferencesParse(string text) -> WorkspaceCommandPreferences

ctCurveDefault infallible​

infallible fn ctCurveDefault() -> CtCurve

ctCurveCopy infallible​

infallible fn ctCurveCopy(CtCurve curve) -> CtCurve

ctCurveParse​

fn ctCurveParse(string text) -> CtCurve

ctCurveText infallible​

infallible fn ctCurveText(CtCurve curve) -> string

ctCurveSample infallible​

infallible fn ctCurveSample(CtCurve curve, float time) -> float

curveEditorCreateIn​

fn curveEditorCreateIn(UiLib lib, UiElement parent, Theme theme) -> CurveEditor

decisionDialogCreate infallible​

infallible fn decisionDialogCreate(UiLib lib, Panel context) -> DecisionDialog

documentTabsCreate infallible​

infallible fn documentTabsCreate(
UiLib lib,
Panel widgetContext,
int initialCapacity,
DocumentTabHandler handler) -> DocumentTabs

fileExplorerDefaultRowCapacity infallible​

infallible fn fileExplorerDefaultRowCapacity() -> int

fileExplorerPathJoin​

fn fileExplorerPathJoin(string directory, string name) -> string

fileExplorerCreate infallible​

infallible fn fileExplorerCreate(
UiLib lib,
Panel context,
int rowCapacity) -> FileExplorer

filePickerCreate​

fn filePickerCreate(UiLib lib, Panel context) -> FilePicker

flowText infallible​

infallible fn flowText(
UiLib lib,
UiElement host,
string value,
float fontSize,
Color fill) -> FlowText

folderTreeFold​

fn folderTreeFold(string value) -> string

folderTreeIndexCreate​

fn folderTreeIndexCreate() -> FolderTreeIndex

folderTreeCreate​

fn folderTreeCreate(
UiLib lib,
Panel context,
Theme theme,
string title) -> FolderTree

uiBrowserLocation​

fn uiBrowserLocation() -> string

uiBrowserPushLocation infallible​

infallible fn uiBrowserPushLocation(string location) -> bool

uiBrowserReplaceLocation infallible​

infallible fn uiBrowserReplaceLocation(string location) -> bool

uiForwardBrowserLocations​

fn uiForwardBrowserLocations(
channel<UiBrowserLocationChanged> locations,
channel<UiInputStep> steps,
UiBrowserLocationHandler handler)

uiForwardWindowCloseRequests​

fn uiForwardWindowCloseRequests(
channel<WindowCloseRequested> requests,
channel<UiInputStep> steps,
UiWindowCloseHandler handler)

uiInputChannel infallible​

infallible fn uiInputChannel() -> channel<UiInputStep>

uiApplyStep infallible​

infallible fn uiApplyStep(UiInputStep step, UiInputSink sink)

uiInputPump​

fn uiInputPump(channel<UiInputStep> steps, UiInputSink sink)

uiInputPumpForSurface​

fn uiInputPumpForSurface(
channel<UiInputStep> steps,
UiInputSink sink,
int surface)

uiInputRun​

fn uiInputRun(UiInputSink sink)

uiInputStart infallible​

infallible fn uiInputStart(
channel<UiInputStep> steps,
UiInputSink sink) -> task<void>

uiInputStartForSurface infallible​

infallible fn uiInputStartForSurface(
channel<UiInputStep> steps,
UiInputSink sink,
int surface) -> task<void>

uiAnchored infallible​

infallible fn uiAnchored(UiElement element) -> UiAnchoredChild

uiAppendAnchoredChildren infallible​

infallible fn uiAppendAnchoredChildren(
UiElement parent,
array<UiAnchoredChild> children) -> bool

uiAnchoredContainer infallible​

infallible fn uiAnchoredContainer(array<UiAnchoredChild> children) -> UiElement

uiFlexChild infallible​

infallible fn uiFlexChild(UiElement element) -> UiFlexChild

uiFlexContainer infallible​

infallible fn uiFlexContainer(
int layoutMode,
array<UiFlexChild> children) -> UiFlexContainer

uiRow infallible​

infallible fn uiRow(array<UiFlexChild> children) -> UiFlexContainer

uiColumn infallible​

infallible fn uiColumn(array<UiFlexChild> children) -> UiFlexContainer

previewSessionCreate infallible​

infallible fn previewSessionCreate(channel<UiInputStep> steps) -> PreviewSession

previewTimelineCreate​

fn previewTimelineCreate(UiLib lib, Panel context, Theme theme) -> PreviewTimeline

previewTransportCreateIn infallible​

infallible fn previewTransportCreateIn(
Panel form,
UiElement root,
Theme theme,
bool separatePause,
bool restart) -> PreviewTransport

previewTimeControlIn​

fn previewTimeControlIn(
Panel form,
UiElement root,
Theme theme,
string label,
float duration,
int decimals,
string initialText) -> PreviewTimeControl

previewTimeAdvance infallible​

infallible fn previewTimeAdvance(
float time,
float elapsed,
float duration,
float speed,
bool looping) -> PreviewTimeStep

previewFrameAdvance infallible​

infallible fn previewFrameAdvance(
int frame,
int direction,
float remainder,
float elapsed,
int count,
float duration,
string mode) -> PreviewFrameStep

ctHierarchyAbs infallible​

infallible fn ctHierarchyAbs(float x) -> float

ctHierarchySin infallible​

infallible fn ctHierarchySin(float x) -> float

ctHierarchyCos infallible​

infallible fn ctHierarchyCos(float x) -> float

uiStyle infallible​

infallible fn uiStyle(array<UiStyleRule> rules) -> UiStyle

uiStyleEmpty infallible​

infallible fn uiStyleEmpty() -> UiStyle

uiStyleFill infallible​

infallible fn uiStyleFill(Color value) -> UiStyleRule

uiStyleGradient infallible​

infallible fn uiStyleGradient(
Color first,
Color second,
bool vertical) -> UiStyleRule

uiStyleBorder infallible​

infallible fn uiStyleBorder(float width, Color value) -> UiStyleRule

uiStyleCorners infallible​

infallible fn uiStyleCorners(
float topLeft,
float topRight,
float bottomRight,
float bottomLeft) -> UiStyleRule

uiStyleRadius infallible​

infallible fn uiStyleRadius(float radius) -> UiStyleRule

uiStyleShadow infallible​

infallible fn uiStyleShadow(
float x,
float y,
float softness,
float spread,
Color value) -> UiStyleRule

uiStyleOpacity infallible​

infallible fn uiStyleOpacity(float value) -> UiStyleRule

uiStyleText infallible​

infallible fn uiStyleText(
float size,
float lineHeight,
int horizontal,
int vertical,
bool wrap) -> UiStyleRule

textEditorModifier infallible​

infallible fn textEditorModifier(int modifiers, int flag) -> bool

textEditorGlyph​

fn textEditorGlyph(int codepoint) -> string

textEditorPreviousBoundary​

fn textEditorPreviousBoundary(string line, int offset) -> int

textEditorNextBoundary​

fn textEditorNextBoundary(string line, int offset) -> int

textEditorClampBoundary​

fn textEditorClampBoundary(string line, int offset) -> int

textEditorWordKind infallible​

infallible fn textEditorWordKind(int c) -> int

textEditorWordBoundary​

fn textEditorWordBoundary(string line, int offset, int direction) -> int

textWordRange​

fn textWordRange(string line, int column) -> TextWordRange

textInputCreate​

fn textInputCreate(
UiRegistry registry,
UiElement face,
UiElement text,
UiElement caret,
float fontSize,
float inset,
float rightInset,
Color highlight) -> TextInput

color infallible​

infallible fn color(float r, float g, float b, float a) -> Color

themeDefault infallible​

infallible fn themeDefault() -> Theme

timelineAbs infallible​

infallible fn timelineAbs(float value) -> float

timelineCreate​

fn timelineCreate(UiLib lib, Panel context, Theme theme) -> Timeline

timelineDockCreate infallible​

infallible fn timelineDockCreate(UiLib lib, Panel context) -> TimelineDock

ctMotionNumber​

fn ctMotionNumber(string text) -> float

ctMotionVector​

fn ctMotionVector(string text) -> CtMotionVector

ctMotionFormat infallible​

infallible fn ctMotionFormat() -> FileFormat

The .motion file format this cTurtle reads. Format 1.x clips animate the parts of a procedural model and blend Euler rotations; format 2.x clips (the current version) animate the nodes of a rig and blend quaternion rotations.

ctMotionParseDocument​

fn ctMotionParseDocument(yaml doc) -> CtMotionClip

ctMotionParse​

fn ctMotionParse(string source) -> CtMotionClip

ctMotionLoad​

fn ctMotionLoad(string path) -> CtMotionClip

ctMotionTime infallible​

infallible fn ctMotionTime(CtMotionClip clip, float elapsed) -> float

ctMotionSample infallible​

infallible fn ctMotionSample(CtMotionTrack track, float time) -> CtMotionVector

ctMotionPose infallible​

infallible fn ctMotionPose(
CtMotionClip clip,
string part,
float time,
CtMotionPose rest) -> CtMotionPose

ctModelsFormat infallible​

infallible fn ctModelsFormat() -> FileFormat

The procedural model file (models.yaml) format this cTurtle reads.

ctHierarchyIdentity infallible​

infallible fn ctHierarchyIdentity() -> CtMotionPose

ctHierarchyRotate infallible​

infallible fn ctHierarchyRotate(
CtMotionVector v,
CtMotionVector r,
bool inverse) -> CtMotionVector

ctHierarchyCompose infallible​

infallible fn ctHierarchyCompose(
CtMotionPose parent,
CtMotionPose child) -> CtMotionPose

ctHierarchyRelative​

fn ctHierarchyRelative(CtMotionPose parent, CtMotionPose world) -> CtMotionPose

ctHierarchyFind infallible​

infallible fn ctHierarchyFind(array<CtHierarchyPart> parts, string name) -> int

ctHierarchyValidate​

fn ctHierarchyValidate(array<CtHierarchyPart> parts)

ctHierarchyWorld infallible​

infallible fn ctHierarchyWorld(
array<CtHierarchyPart> parts,
int index) -> CtMotionPose

ctMotionRigEmpty infallible​

infallible fn ctMotionRigEmpty() -> CtMotionRig

ctMotionRigCreate​

fn ctMotionRigCreate(array<CtHierarchyPart> rest, CtMotionClip clip) -> CtMotionRig

ctMotionRigSample infallible​

infallible fn ctMotionRigSample(
CtMotionRig rig,
CtMotionClip clip,
float time,
float weight)

vectorCanvasCreateIn​

fn vectorCanvasCreateIn(Panel panel, UiElement parent) -> VectorCanvas

uiEdgeLeft infallible​

infallible fn uiEdgeLeft() -> int

uiEdgeTop infallible​

infallible fn uiEdgeTop() -> int

uiEdgeRight infallible​

infallible fn uiEdgeRight() -> int

uiEdgeBottom infallible​

infallible fn uiEdgeBottom() -> int

uiAlignAuto infallible​

infallible fn uiAlignAuto() -> int

uiAlignStretch infallible​

infallible fn uiAlignStretch() -> int

uiAlignStart infallible​

infallible fn uiAlignStart() -> int

uiAlignCenter infallible​

infallible fn uiAlignCenter() -> int

uiAlignEnd infallible​

infallible fn uiAlignEnd() -> int

uiJustifyStart infallible​

infallible fn uiJustifyStart() -> int

uiJustifyCenter infallible​

infallible fn uiJustifyCenter() -> int

uiJustifyEnd infallible​

infallible fn uiJustifyEnd() -> int

uiJustifySpaceBetween infallible​

infallible fn uiJustifySpaceBetween() -> int

uiJustifySpaceAround infallible​

infallible fn uiJustifySpaceAround() -> int

uiJustifySpaceEvenly infallible​

infallible fn uiJustifySpaceEvenly() -> int

uiCursorInherit infallible​

infallible fn uiCursorInherit() -> int

uiCursorDefault infallible​

infallible fn uiCursorDefault() -> int

uiCursorPointer infallible​

infallible fn uiCursorPointer() -> int

uiCursorText infallible​

infallible fn uiCursorText() -> int

uiCursorCrosshair infallible​

infallible fn uiCursorCrosshair() -> int

uiCursorResizeEW infallible​

infallible fn uiCursorResizeEW() -> int

uiCursorResizeNS infallible​

infallible fn uiCursorResizeNS() -> int

uiCursorResizeNWSE infallible​

infallible fn uiCursorResizeNWSE() -> int

uiCursorResizeNESW infallible​

infallible fn uiCursorResizeNESW() -> int

uiCursorMove infallible​

infallible fn uiCursorMove() -> int

uiCursorNotAllowed infallible​

infallible fn uiCursorNotAllowed() -> int

uiCursorNone infallible​

infallible fn uiCursorNone() -> int

uiFieldText infallible​

infallible fn uiFieldText() -> int

uiFieldSearch infallible​

infallible fn uiFieldSearch() -> int

uiFieldPassword infallible​

infallible fn uiFieldPassword() -> int

uiFieldUrl infallible​

infallible fn uiFieldUrl() -> int

uiFieldTelephone infallible​

infallible fn uiFieldTelephone() -> int

uiFieldNumber infallible​

infallible fn uiFieldNumber() -> int

uiFieldTime infallible​

infallible fn uiFieldTime() -> int

uiFieldFile infallible​

infallible fn uiFieldFile() -> int

uiNullController infallible​

infallible fn uiNullController() -> UiController

uiClickNothing infallible​

infallible fn uiClickNothing(Widget widget)

uiClickBound​

fn uiClickBound(Widget widget)

uiColorFromHsv infallible​

infallible fn uiColorFromHsv(
float hue,
float saturation,
float brightness,
float alpha) -> Color

uiColorHex​

fn uiColorHex(Color value) -> string

uiColorFromHex​

fn uiColorFromHex(string text, float defaultAlpha) -> Color

uiLibCreate infallible​

infallible fn uiLibCreate(
UiRegistry registry,
int width,
int height,
Theme theme) -> UiLib

uiParseNumber​

fn uiParseNumber(string text) -> float

workspaceRegionLeft infallible​

infallible fn workspaceRegionLeft() -> int

workspaceRegionDocument infallible​

infallible fn workspaceRegionDocument() -> int

workspaceRegionRight infallible​

infallible fn workspaceRegionRight() -> int

workspaceRegionBottom infallible​

infallible fn workspaceRegionBottom() -> int

workspaceModeWide infallible​

infallible fn workspaceModeWide() -> int

workspaceModeMedium infallible​

infallible fn workspaceModeMedium() -> int

workspaceModeCompact infallible​

infallible fn workspaceModeCompact() -> int

workspaceModeSurvival infallible​

infallible fn workspaceModeSurvival() -> int

workspaceMenuNone infallible​

infallible fn workspaceMenuNone() -> int

workspaceMenuFile infallible​

infallible fn workspaceMenuFile() -> int

workspaceMenuEdit infallible​

infallible fn workspaceMenuEdit() -> int

workspaceMenuView infallible​

infallible fn workspaceMenuView() -> int

workspaceMenuHelp infallible​

infallible fn workspaceMenuHelp() -> int

workspaceMenuContext infallible​

infallible fn workspaceMenuContext() -> int

workspaceLayoutSchema infallible​

infallible fn workspaceLayoutSchema() -> int

workspaceModifierShift infallible​

infallible fn workspaceModifierShift() -> int

workspaceModifierControl infallible​

infallible fn workspaceModifierControl() -> int

workspaceModifierAlt infallible​

infallible fn workspaceModifierAlt() -> int

workspaceCommandOpenProject infallible​

infallible fn workspaceCommandOpenProject() -> string

workspaceCommandSave infallible​

infallible fn workspaceCommandSave() -> string

workspaceCommandSaveAll infallible​

infallible fn workspaceCommandSaveAll() -> string

workspaceCommandReloadDocument infallible​

infallible fn workspaceCommandReloadDocument() -> string

workspaceCommandCloseDocument infallible​

infallible fn workspaceCommandCloseDocument() -> string

workspaceCommandCloseAllDocuments infallible​

infallible fn workspaceCommandCloseAllDocuments() -> string

workspaceCommandUndo infallible​

infallible fn workspaceCommandUndo() -> string

workspaceCommandRedo infallible​

infallible fn workspaceCommandRedo() -> string

workspaceCommandCut infallible​

infallible fn workspaceCommandCut() -> string

workspaceCommandCopy infallible​

infallible fn workspaceCommandCopy() -> string

workspaceCommandPaste infallible​

infallible fn workspaceCommandPaste() -> string

workspaceCommandSelectAll infallible​

infallible fn workspaceCommandSelectAll() -> string

workspaceCommandFind infallible​

infallible fn workspaceCommandFind() -> string

workspaceCommandFindNext infallible​

infallible fn workspaceCommandFindNext() -> string

workspaceCommandFindPrevious infallible​

infallible fn workspaceCommandFindPrevious() -> string

workspaceCommandCloseProject infallible​

infallible fn workspaceCommandCloseProject() -> string

workspaceCommandResetLayout infallible​

infallible fn workspaceCommandResetLayout() -> string

workspaceCommandMoveViewLeft infallible​

infallible fn workspaceCommandMoveViewLeft() -> string

workspaceCommandMoveViewDocument infallible​

infallible fn workspaceCommandMoveViewDocument() -> string

workspaceCommandMoveViewRight infallible​

infallible fn workspaceCommandMoveViewRight() -> string

workspaceCommandMoveViewBottom infallible​

infallible fn workspaceCommandMoveViewBottom() -> string

workspaceCommandMoveViewPrevious infallible​

infallible fn workspaceCommandMoveViewPrevious() -> string

workspaceCommandMoveViewNext infallible​

infallible fn workspaceCommandMoveViewNext() -> string

workspaceCommandPlay infallible​

infallible fn workspaceCommandPlay() -> string

workspaceCommandStop infallible​

infallible fn workspaceCommandStop() -> string

workspaceLayoutParse​

fn workspaceLayoutParse(string text) -> WorkspaceLayout

workspaceLayoutSerialize infallible​

infallible fn workspaceLayoutSerialize(WorkspaceLayout layout) -> string

workspaceIcon infallible​

infallible fn workspaceIcon(
UiElement parent,
string asset,
float size,
float left,
float top,
Color ink) -> UiElement

workspaceClamp infallible​

infallible fn workspaceClamp(float value, float low, float high) -> float

workspaceToolbarIconSetEnabled infallible​

infallible fn workspaceToolbarIconSetEnabled(
Widget button,
Color ink,
bool enabled)

workspaceToolbarIconButton infallible​

infallible fn workspaceToolbarIconButton(
Panel context,
UiElement host,
string asset,
float iconSize,
Color ink) -> Widget

workspaceShellCreate infallible​

infallible fn workspaceShellCreate(UiLib lib, string title) -> WorkspaceShell

workspacePreferencesSerialize infallible​

infallible fn workspacePreferencesSerialize(
WorkspaceCommandRegistry registry) -> string

workspacePreferencesApply​

fn workspacePreferencesApply(
WorkspaceShell shell,
WorkspaceCommandPreferences preferences)

workspaceCommandSettings infallible​

infallible fn workspaceCommandSettings() -> string

workspaceText infallible​

infallible fn workspaceText(
UiElement parent,
string value,
float size,
Color ink,
int align) -> UiElement

workspaceStableId infallible​

infallible fn workspaceStableId(string id) -> bool