Binding Generator API

Rendered on the server from website/html/assets/docs/api.md with Parsedown. The documentation sidebar and widget hierarchy are parsed from the same generated API markdown so navigation does not drift from the current API source.

YAAA.app API Documentation

Welcome to the YAAA.app scripting API reference. YAAA.app exposes its GUI and application services through a Lua-primary binding layer: Lua is the canonical scripting surface, and other languages integrate through the same Lua-mediated boundary.

Quick links

• Getting started — see the Lua binding guide in the SDK (binding/BINDING_GUIDE.md).
• Widget reference — the full generated method reference is below, grouped by widget class.
• Capabilities — GUI actions reference capabilities, never raw native callbacks.

Conventions

• Widget classes inherit from a common Widget userdata base.
• Methods are called on their receiver: widget:method(args).
• Handlers are Lua functions or namespace-qualified symbols resolved against the Lua state; the binding layer never invokes a raw native callback supplied by a script.
• Types shown below use Lua/Python/C# notation, for example number/float/double. Widget userdata types link to their widget class sections.

Auto-generated from the YAAA.app binding specification.

Widgets

Widget

Base userdata type for GUI widgets exposed to Lua. Concrete widget classes below inherit from this scripting-facing base.

Y3A

The Y3A namespace is the YAAA.app UI runtime global (static) class containing state information and global methods for the current application.

Namespace: Y3A Base: Widget

Methods

Properties

Widget_Tracker

This class should be used to control safe widget deletion.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Label

This struct stores all information for a text or mixed graphics label.

Namespace: Y3A Base: Widget

Methods

Callback_User_Data

A class prototype that allows for additional data in callbacks.

Namespace: Y3A Base: Widget

Constructors

Adjuster

The Adjuster widget was stolen from Prisms, and has proven to be very useful for values that need a large dynamic range. <P>When you press a button and drag to the right the value increases. When you drag to the left it decreases. The largest button adjusts by 100 step(), the next by 10 step() and that smallest button by step(). Clicking on the buttons increments by 10 times the amount dragging by a pixel does. Shift + click decrements by 10 times the amount.

Namespace: Y3A Base: Valuator

Constructors

Methods

Properties

Box

This widget simply draws its box, and possibly its label.

Namespace: Y3A Base: Widget

Constructors

Methods

Group

The Group class is the main YAAA.app UI runtime container widget. It maintains an array of child widgets. These children can themselves be any widget including Group. The most important subclass of Group is Window, however groups can also be used to control radio buttons or to enforce resize behavior.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

End

This is a dummy class that allows you to end a Group in a constructor list of a class:

Namespace: Y3A Base: Widget

Constructors

Slider

The Slider widget contains a sliding knob inside a box. It is often used as a scrollbar. Moving the box all the way to the top/left sets it to the minimum(), and to the bottom/right to the maximum(). The minimum() may be greater than the maximum() to reverse the slider direction.

Namespace: Y3A Base: Valuator

Constructors

Methods

Properties

Scrollbar

The Scrollbar widget displays a slider with arrow buttons at the ends of the scrollbar. Clicking on the arrows move up/left and down/right by linesize(). Scrollbars also accept SHORTCUT events: the arrows move by linesize(), and vertical scrollbars take Page Up/Down (they move by the page size minus linesize()) and Home/End (they jump to the top or bottom).

Namespace: Y3A Base: Slider

Constructors

Methods

Properties

Image

Base class for image caching, scaling and drawing.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

RGB_Image

The RGB_Image class supports caching and drawing of full-color images with 1 to 4 channels of color information. Images with an even number of channels are assumed to contain alpha information, which is used to blend the image with the contents of the screen.

Namespace: Y3A Base: Image

Constructors

Methods

Properties

Browser

The Browser widget displays a scrolling list of text lines, and manages all the storage for the text. This is not a text editor or spreadsheet! But it is useful for showing a vertical list of named objects to the user.

Namespace: Y3A Base: Browser_

Constructors

Methods

Properties

Button

Buttons generate callbacks when they are clicked by the user.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Chart

Chart displays simple charts. It is provided for Forms compatibility.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Check_Browser

The Check_Browser widget displays a scrolling list of text lines that may be selected and/or checked by the user.

Namespace: Y3A Base: Browser_

Constructors

Methods

Properties

Light_Button

This subclass displays the "on" state by turning on a light, rather than drawing pushed in. The shape of the "light" is initially set to DOWN_BOX. The color of the light when on is controlled with selection_color(), which defaults to YELLOW.

Namespace: Y3A Base: Button

Constructors

Methods

Check_Button

YAAA.app UI runtime widget class

Namespace: Y3A Base: Light_Button

Constructors

Multi_Label

Allows a mixed text and/or graphics label to be applied to an Menu_Item or Widget.

Namespace: Y3A Base: Widget

Methods

Menu_Item

The MenuItem structure defines a single menu item that is used by the Menu class.

Namespace: Y3A Base: Widget

Methods

Properties

Choice

A button that is used to pop up a menu.

Namespace: Y3A Base: Menu_

Constructors

Methods

Properties

Clock_Output

This widget can be used to display a program-supplied time.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Clock

This widget provides a round analog clock display.

Namespace: Y3A Base: Clock_Output

Constructors

Methods

Return_Button

The Return_Button is a subclass of Button that generates a callback when it is pressed or when the user presses the Enter key. A carriage-return symbol is drawn next to the button label.

Namespace: Y3A Base: Button

Constructors

Methods

Input

This is the YAAA.app UI runtime text input widget. It displays a single line of text and lets the user edit it. Normally it is drawn with an inset box and a white background. The text may contain any characters, and will correctly display any UTF text, using ^X notation for unprintable control characters. It assumes the font can draw any characters of the used scripts, which is true for standard fonts under Windows and Mac OS X. Characters can be input using the keyboard or the character palette/map. Character composition is done using dead keys and/or a compose key as defined by the operating system. <P> <!-- DON'T use the class name in the caption, or doxygen 1.8.x will fail. --> <TABLE WIDTH="90%" BORDER="1" SUMMARY="Input keyboard and mouse bindings."> <CAPTION ALIGN="TOP">Keyboard and mouse bindings.</CAPTION> <TR><TD NOWRAP="NOWRAP" WIDTH="1%"> <B>Mouse button 1</B> </TD><TD> Moves the cursor to this point. Drag selects characters. Double click selects words. Triple click selects all line. Shift+click extends the selection. When you select text it is automatically copied to the selection buffer. </TD></TR><TR><TD NOWRAP="NOWRAP"> <B>Mouse button 2</B> </TD><TD> Insert the selection buffer at the point clicked. You can also select a region and replace it with the selection buffer by selecting the region with mouse button 2. </TD></TR><TR><TD NOWRAP="NOWRAP"> <B>Mouse button 3</B> </TD><TD> Currently acts like button 1. </TD></TR><TR><TD NOWRAP="NOWRAP"> <B>Backspace</B> </TD><TD> Deletes one character to the left, or deletes the selected region. </TD></TR><TR><TD NOWRAP="NOWRAP"> <B>Delete</B> </TD><TD> Deletes one character to the right, or deletes the selected region. Combine with Shift for equivalent of ^X (copy+cut). </TD></TR><TR><TD NOWRAP="NOWRAP"> <B>Enter </TD><TD> May cause the callback, see when(). </TD></TR></TABLE>

Namespace: Y3A Base: Input_

Constructors

Methods

Value_Input

The Value_Input widget displays a numeric value. The user can click in the text field and edit it - there is in fact a hidden Input widget with type(FLOAT_INPUT) or type(INT_INPUT) in there - and when they hit return or tab the value updates to what they typed and the callback is done.

Namespace: Y3A Base: Valuator

Constructors

Methods

Properties

Color_Chooser

The Color_Chooser widget provides a standard RGB color chooser.

Namespace: Y3A Base: Group

Constructors

Methods

Properties

Counter

Controls a single floating point value with button (or keyboard) arrows. Double arrows buttons achieve larger steps than simple arrows.

Namespace: Y3A Base: Valuator

Constructors

Methods

Properties

Preferences

Preferences store user settings between application starts.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Plugin

Plugin allows link-time and run-time integration of binary modules.

Namespace: Y3A Base: Widget

Constructors

Plugin_Manager

Plugin_Manager manages link-time and run-time plugin binaries.

Namespace: Y3A Base: Preferences

Constructors

Methods

Properties

Surface_Device

A drawing surface that's susceptible to receive graphical output. Any YAAA.app UI runtime application has at any time a current drawing surface to which all drawing requests are directed. The current surface is given by Surface_Device::surface(). When main() begins running, the current drawing surface has been set to the computer's display, an instance of the Display_Device class.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Display_Device

The computer's display. When YAAA.app UI runtime begins to access the computer's display, it creates an object of class Display_Device and makes it the current drawing surface.

Namespace: Y3A Base: Surface_Device

Methods

Properties

Dial

The Dial widget provides a circular dial to control a single floating point value. Use type() to set the type of the dial to: <UL> <LI>NORMAL_DIAL - Draws a normal dial with a knob. </LI> <LI>LINE_DIAL - Draws a dial with a line. </LI> <LI>FILL_DIAL - Draws a dial with a filled arc. </LI> </UL>

Namespace: Y3A Base: Valuator

Constructors

Methods

Properties

Bitmap

The Bitmap class supports caching and drawing of mono-color (bitmap) images. Images are drawn using the current color.

Namespace: Y3A Base: Image

Constructors

Methods

Properties

Window

This widget produces an actual window. This can either be a main window, with a border and title and all the window management controls, or a "subwindow" inside a window. This is controlled by whether or not the window has a parent().

Namespace: Y3A Base: Group

Constructors

Methods

Properties

Double_Window

The Double_Window provides a double-buffered window. It will draw the window data into an off-screen pixmap, and then copy it to the on-screen window.

Namespace: Y3A Base: Window

Constructors

Methods

Properties

File_Icon

The File_Icon class manages icon images that can be used as labels in other widgets and as icons in the FileBrowser widget.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

File_Browser

The File_Browser widget displays a list of filenames, optionally with file-specific icons.

Namespace: Y3A Base: Browser

Constructors

Methods

Properties

Menu_Button

This is a button that when pushed pops up a menu (or hierarchy of menus) defined by an array of Menu_Item objects. <P>Normally any mouse button will pop up a menu and it is lined up below the button as shown in the picture. However an Menu_Button may also control a pop-up menu. This is done by setting the type(). If type() is zero a normal menu button is produced. If it is nonzero then this is a pop-up menu. The bits in type() indicate what mouse buttons pop up the menu (see Menu_Button::popup_buttons). </P> <P>The menu will also pop up in response to shortcuts indicated by putting a '&' character in the label(). </P> <P>Typing the shortcut() of any of the menu items will cause callbacks exactly the same as when you pick the item with the mouse. The '&' character in menu item names are only looked at when the menu is popped up, however. </P>

Namespace: Y3A Base: Menu_

Constructors

Methods

Properties

Tile

YAAA.app UI runtime widget class

Namespace: Y3A Base: Group

Constructors

Methods

File_Input

This widget displays a pathname in a text input field.

Namespace: Y3A Base: Input

Constructors

Methods

Properties

File_Chooser

YAAA.app UI runtime widget class

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Fill_Dial

Draws a dial with a filled arc

Namespace: Y3A Base: Dial

Constructors

Fill_Slider

Widget that draws a filled horizontal slider, useful as a progress or value meter

Namespace: Y3A Base: Slider

Constructors

Flex

Flex is a container (layout) widget for one row or one column of widgets.

Namespace: Y3A Base: Group

Constructors

Methods

Properties

Float_Input

The Float_Input class is a subclass of Input that only allows the user to type floating point numbers (sign, digits, decimal point, more digits, 'E' or 'e', sign, digits).

Namespace: Y3A Base: Input

Constructors

Free

Emulation of the Forms "free" widget.

Namespace: Y3A Base: Widget

Constructors

Methods

Gl_Window

The Gl_Window widget sets things up so OpenGL works.

Namespace: Y3A Base: Window

Constructors

Methods

Properties

Rect

Rectangle with standard YAAA.app UI runtime coordinates (X, Y, W, H).

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Grid

Grid is a container (layout) widget with multiple columns and rows.

Namespace: Y3A Base: Group

Constructors

Methods

Properties

Pixmap

The Pixmap class supports caching and drawing of colormap (pixmap) images, including transparency.

Namespace: Y3A Base: Image

Constructors

Methods

Properties

Graphics_Driver

An abstract class subclassed for each graphics driver YAAA.app UI runtime uses. Typically, YAAA.app UI runtime applications do not use directly objects from this class. Rather, they perform drawing operations (e.g., rectf()) that operate on the current drawing surface (see Surface_Device). Drawing operations are functionally presented in drawing and as function lists in the drawings and attributes modules.

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Font_Descriptor

YAAA.app UI runtime widget class

Namespace: Y3A Base: Widget

Constructors

Scalable_Graphics_Driver

YAAA.app UI runtime widget class

Namespace: Y3A Base: Graphics_Driver

Constructors

Methods

Help_Font_Style

Help_View font stack element definition.

Namespace: Y3A Base: Widget

Constructors

Methods

Help_Font_Stack

YAAA.app UI runtime widget class

Namespace: Y3A Base: Widget

Constructors

Methods

Properties

Help_View

The Help_View widget displays HTML text. Most HTML 2.0 elements are supported, as well as a primitive implementation of tables. GIF, JPEG, and PNG images are displayed inline.

Namespace: Y3A Base: Group

Constructors

Methods

Properties