Reference — User Interface

Table of Contents

UI::UserInput - Waits for user input and returns a widget ID.
UI::PollInput - Checks for pending user input. Does not wait. Returns a widget ID or nil if no input is available.
UI::TimeoutUserInput - Waits for user input and returns a widget ID. Returns ID `timeout if no input is available for timeout milliseconds.
UI::WaitForEvent - Waits for user input and returns an event map. Returns ID `timeout if no input is available for timeout milliseconds.

II. UI builtin commands

UI::AskForExistingDirectory - Opens a directory selection box and prompt the user for an existing directory.
UI::AskForExistingFile - Opens a file selection box and prompt the user for an existing file.
UI::AskForSaveFileName - Opens a file selection box and prompt the user for a file to save data to.
UI::BusyCursor - Sets the mouse cursor to the busy cursor
UI::ChangeWidget - Changes widget contents
UI::CheckShortcuts - Performs an explicit shortcut check after postponing shortcut checks.
UI::CloseDialog() - Closes an open dialog
UI::CollectUserInput - Collects the content of all input widgets in a dialog or in a container
UI::DumpWidgetTree - Debugging function
UI::FakeUserInput - Fakes User Input
UI::GetDisplayInfo - Gets Display Info
UI::GetLanguage - Gets Language
UI::GetModulename - Gets the name of a Module
UI::GetProductName - Gets Product Name
UI::Glyph - Returns a special character ( a 'glyph' )
UI::MakeScreenShot - Makes Screen Shot
UI::NormalCursor - Sets the mouse cursor to the normal cursor
UI::OpenDialog - Opens a new dialog.
UI::OpenDialog - Opens a Dialog with options
UI::PlayMacro - Plays a recorded macro
UI::PollInput - Poll Input
UI::PostponeShortcutCheck - Postpones Shortcut Check
UI::QueryWidget - Queries Widget contents
UI::RecalcLayout - Recalculates Layout
UI::Recode - Recodes encoding of string from or to "UTF-8" encoding.
UI::RecordMacro - Records Macro into a file
UI::RedrawScreen - Redraws the screen
UI::ReplaceWidget -
UI::RunPkgSelection - Initializes and run the PackageSelector widget
UI::SetConsoleFont - Sets Console Font
UI::SetFocus - Sets Focus to the specified widget
UI::SetFunctionKeys - Sets the (default) function keys for a number of buttons.
UI::SetKeyboard - Sets Keyboard
UI::SetLanguage - Sets the language of the UI
UI::SetModulename - Sets Module Name
UI::SetProductName - Sets Product Name
UI::StopRecordingMacro - Stops recording macro
UI::TimeoutUserInput - User Input with Timeout
UI::UserInput - User Input
UI::WFM/SCR - callback
UI::WaitForEvent - Waits for Event
UI::WidgetExists - Checks whether or not a widget with the given ID currently exists
UI::WizardCommand - Runs a wizard command

III. Standard (mandatory) widgets

AAA_All-Widgets - Generic options for all widgets
CheckBox - Clickable on/off toggle button
ComboBox - drop-down list selection (optionally editable)
Empty - Stretchable space for layout
Frame - Frame with label
HBox - Generic layout: Arrange widgets horizontally or vertically
HSpacing - Fixed size empty space for layout
HSquash - Layout aid: Minimize widget to its nice size
HWeight - Control relative size of layouts
Image - Pixmap image
IntField - Numeric limited range input field
Label - Simple static text
Left - Layout alignment
LogView - scrollable log lines like "tail -f"
MarginBox - Margins around one child widget
MenuButton - Button with popup menu
MinWidth - Layout minimum size
MultiLineEdit - multiple line text edit field
MultiSelectionBox - Selection box that allows selecton of multiple items
PackageSelector - Complete software package selection
PkgSpecial - Package selection special - DON'T USE IT
ProgressBar - Graphical progress indicator
PushButton - Perform action on click
RadioButton - Clickable on/off toggle button for radio boxes
RadioButtonGroup - Radio box - select one of many radio buttons
ReplacePoint - Pseudo widget to replace parts of a dialog
RichText - Static text with HTML-like formatting
SelectionBox - Scrollable list selection
Table - Multicolumn table widget
TextEntry - Input field
Tree - Scrollable tree selection

IV. Special (optional) widgets

BarGraph - Horizontal bar graph (optional widget)
ColoredLabel - Simple static text with specified background and foreground color
Date - Date input field
DownloadProgress - Self-polling file growth progress indicator (optional widget)
DumbTab - Simplistic tab widget that behaves like push buttons
HasSpecialWidget - Checks for support of a special widget type.
PartitionSplitter - Hard disk partition splitter tool (optional widget)
PatternSelector - High-level widget to select software patterns (selections)
Slider - Numeric limited range input (optional widget)
Time - Time input field
VMultiProgressMeter - Progress bar with multiple segments (optional widget)
Wizard - Wizard frame - not for general use, use the Wizard:: module instead!

A. UI Richtext


toterm		Event-related UI Builtin Functions