API Summary#

This contains a summary of the “public” API exposed by the project. Click on each object for full API definitions.

The public classes are:

`Button`	A button with a label and/or an image.
`CP`	A Cardinal Point.
`Canvas`	A canvas that draws a `diagram`.
`Checkbox`	A checkbox, simple boolean choice.
`CheckboxFrame`	A frame filled with checkboxes, with optional buttons for full state manipulation.
`ComboboxN`	A combobox widget, combining an entry and a listbox.
`Direction`	The direction of automatic widget layout.
`EntryMultiline`	A multiline text widget, supporting `LTML` contents.
`EntryN`	A validated `EntryRaw`.
`EntryRaw`	An entry widget, single-line text editor.
`FrameLabelled`	A frame to hold other widgets surrounded by a line, including a label.
`FramePaned`	A frame to hold other widgets, with user-controllable relative sizes.
`FrameRadio`	A frame to hold other widgets, with a radio button.
`FrameStateful`	A frame to hold other widgets, with a checkbox.
`FrameUnlabelled`	A simple frame to hold other widgets, visually invisible.
`Justification`	A text justification anchor.
`Label`	A label, can be text, image, or both.
`LabelStateful`	A stateful `Label`, where the text is controlled by a variable.
`Listbox`	A listbox widget, a list of strings.
`ListboxControl`	A listbox widget, with extra controls for a set of strings.
`Menu`	A menu widget, specified by a top-level `menu.Root`.
`Notebook`	A tabbed interface to hold other containers.
`NotebookUniform`	A tabbed interface to hold a series of uniform containers.
`Radio`	A radio button, a choice between several options.
`RadioFrameLabelled`	A labelled frame filled with radio buttons.
`RadioFrameStateful`	A stateful frame filled with radio buttons.
`RadioFrameUnlabelled`	Internal `RadioFrameLabelled`/`RadioFrameStateful` widget definition.
`RootWindow`	A root window, the toplevel widget for the entire application.
`S`	Wrap `model.Sticky` settings with some pre-baked common objects.
`Scrolled`	A proxy widget to include functional scrollbars that works for all widgets.
`ScrolledWidget`	A proxy widget to include functional scrollbars.
`SecondaryWindow`	A secondary toplevel widget, similar to a second `RootWindow`.
`Separator`	A separator, just a single line for grouping widgets.
`SpinboxN`	A spinbox widget, a numeric entry with buttons to change the value.
`Tooltip`	A tooltip widget, a specialized `SecondaryWindow` attached to a widget.
`TooltipSingleStatic`	The most basic `Tooltip`, with a static `Label`.
`TooltipValidation`	A `Tooltip`, specialized for validation uses.
`Tree`	A hierarchical multicolumn data display widget.
`varTree`	Type-Checking variable type for `Tree`.

The public functions are:

`Combobox`	Legacy wrapper for `ComboboxN`
`ComboboxMap`	Legacy wrapper for `ComboboxN`
`ComboboxRaw`	Legacy wrapper for `ComboboxN`
`Entry`	Legacy wrapper for `EntryRaw`
`LOGGING_VERBOSE`	Shows spammy modules, should be silenced by the calling application.
`RadioFrame`	Legacy wrapper for `RadioFrameLabelled`
`RadioFrame_Raw`	Legacy wrapper for `RadioFrameUnlabelled`
`ScrolledH`	Wrapper for `Scrolled`, forcing `scrollVertical` to `False`.
`ScrolledV`	Wrapper for `Scrolled`, forcing `scrollHorizontal` to `False`
`SeparatorH`	Wrapper for `Separator`, forcing `orientation` to `HORIZONTAL`
`SeparatorV`	Wrapper for `Separator`, forcing `orientation` to `VERTICAL`
`Spinbox`	Legacy wrapper for `SpinboxN`
`SpinboxNum`	Legacy wrapper for `SpinboxN`

The public variables are:

`AUTO`	Automatic Layout.
`HORIZONTAL`	Horizontal (1 row) Layout.
`MODULES_VERBOSE`	DEPRECATED.
`VERTICAL`	Vertical (1 column) Layout.
`logger__menu`	Instances of the Logger class represent a single logging channel.
`varEventBusEventType`	Type-Checking variable type for `event` in `RootWindow.register_eventbus_response`
`varOrientation`	Type-Checking variable type for `orientation` in `FramePaned`/`Separator`
`varSidSettings`	Type-Checking variable type for `RootWindow.styleIDs` mapping

This results in the following class diagram: