User Interface Reference

Table of Contents

XI. Event-related UI Builtin Functions

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.

XII. UI builtin commands

UI::SetModulename - Set Module Name

UI::GetModulename - Get the name of a Module

UI::SetLanguage - Set the language of the UI

UI::GetProductName - Get Product Name

UI::SetProductName - set Product Name

UI::SetConsoleFont - Set Console Font

UI::SetKeyboard - Set Keyboard

UI::GetLanguage - Get Language

UI::UserInput - User Input

UI::PollInput - Poll Input

UI::TimeoutUserInput - User Input with Timeout

UI::WaitForEvent - Wait for Event

UI::OpenDialog - Opens a new dialog.

UI::OpenDialog - Open a Dialog with options

UI::CloseDialog() - Close an open dialog

UI::ChangeWidget - Change widget contents

UI::QueryWidget - Query Widget contents

UI::ReplaceWidget -

UI::WizardCommand - Run a wizard command

UI::SetFocus - Set Focus to the specified widget

UI::BusyCursor - Sets the mouse cursor to the busy curso

UI::RedrawScreen - Redraws the screen

UI::NormalCursor - Sets the mouse cursor to the normal cursor

UI::MakeScreenShot - Make Screen Shot

UI::DumpWidgetTree - Debugging function

UI::RecordMacro - Record Macro into a file

UI::StopRecordingMacro - Stop recording macro

UI::PlayMacro - Play a recorded macro

UI::FakeUserInput - Fake User Input

UI::Glyph - Return a special character ( a 'glyph' )

UI::GetDisplayInfo - Get Display Info

UI::RecalcLayout - Racalculate Layout

UI::PostponeShortcutCheck - Postpone Shortcut Check

UI::CheckShortcuts - Perform an explicit shortcut check after postponing shortcut checks.

UI::WidgetExists - Check whether or not a widget with the given ID currently exists

UI::RunPkgSelection - Initialize and run the PackageSelector widget

UI::AskForExistingDirectory - Open a directory selection box and prompt the user for an existing directory.

UI::AskForExistingFile - Open a file selection box and prompt the user for an existing file.

UI::AskForSaveFileName - Open a file selection box and prompt the user for a file to save data to.

UI::SetFunctionKeys - Set the ( default ) function keys for a number of buttons.

UI::WFM/SCR - callback

UI::Recode - Recode encoding of string from or to "UTF-8" encoding.

XIII. Standard (mandatory) widgets

AAA_All-Widgets - Generic options for all widgets

ReplacePoint - Pseudo widget to replace parts of a dialog

Empty - Stretchable space for layout

HSpacing - Fixed size empty space for layout

Left - Layout alignment

Frame - Frame with label

HSquash - Layout aid: Minimize widget to its nice size

HWeight - Control relative size of layouts

HBox - Generic layout: Arrange widgets horizontally or vertically

Label - Simple static text

RichText - Static text with HTML-like formatting

LogView - scrollable log lines like "tail -f"

PushButton - Perform action on click

MenuButton - Button with popup menu

CheckBox - Clickable on/off toggle button

RadioButton - Clickable on/off toggle button for radio boxes

RadioButtonGroup - Radio box - select one of many radio buttons

TextEntry - Input field

MultiLineEdit - multiple line text edit field

SelectionBox - Scrollable list selection

MultiSelectionBox - Selection box that allows selecton of multiple items

ComboBox - drop-down list selection ( optionally editable )

Tree - Scrollable tree selection

Table - Multicolumn table widget

ProgressBar - Graphical progress indicator

Image - Pixmap image

IntField - Numeric limited range input field

PackageSelector - Complete software package selection

PkgSpecial - Package selection special - DON'T USE IT

XIV. Special (optional) widgets

HasSpecialWidget - Checks for support of a special widget type.

BarGraph - Horizontal bar graph (optional widget)

ColoredLabel - Simple static text with specified background and foreground color

DownloadProgress - Self-polling file growth progress indicator (optional widget)

DumbTab - Simplistic tab widget that behaves like push buttons

VMultiProgressMeter - Progress bar with multiple segments (optional widget)

Slider - Numeric limited range input (optional widget)

PartitionSplitter - Hard disk partition splitter tool (optional widget)

Date - Date input field

Time - Time input field

Wizard - Wizard frame - not for general use, use the Wizard:: module instead!