tekUI

ClassOverview : Class

This module implements inheritance and the creation of objects from classes.

• Class:getClass() - Returns the class of an object, or the super class of a class
• Class:getClassName() - Returns the class name of an object or class
• Class:getSuper() - Returns the super class of an object or class
• Class:instanceOf() - Checks if an object descends from a class
• Class.new() - Creates and returns a new object
• Class.newClass() - Creates a child class from a super class
• Class:setClass() - Changes the class of an object, or the super class of a class

ClassOverview : Class / List

This class implements a list container.

• List:addItem() - Adds an item to the list
• List:changeItem() - Replaces an item in the list
• List:clear() - Removes all items from the list
• List:getItem() - Returns the item at the specified position
• List:getN() - Returns the number of items in the list
• List:remItem() - Removes an item from the list

• Items [I] (table)

  Table of initial list items, indexed numerically

• Class.new()

ClassOverview : Class / Markup

This class implements a markup parser and converter for producing feature-rich XHTML 1.0 from plain text with special formattings.

• Markup.new()
• Markup:run()

ClassOverview : Class / Object

This class implements notifications.

• Object.addClassNotifications - Collects class notifications
• Object:addNotify() - Adds a notification to an object
• Object:doNotify() - Invokes a notification in the addressed object
• Object.init() - (Re-)initializes an object
• Object:remNotify() - Removes a notification from an object
• Object:setValue() - Sets an attribute, triggering notifications

• Class.new()

ClassOverview : Class / UTF8String

This class supports the manipulation of UTF-8 encoded strings.

• UTF8String:byte() - Returns Unicode character codes
• UTF8String.char() - Returns UTF8-encoded character sequences
• UTF8String.chars() - Iterator over a string's Unicode character codes
• UTF8String:erase() - Removes substring
• UTF8String:find() - Find an UTF-8-encoded string
• UTF8String:get() - Returns the string in UTF-8 encoded form
• UTF8String:insert() - Inserts a string at a given position
• UTF8String:len() - Returns the length in characters
• UTF8String:overwrite() - Overwrites string
• UTF8String:set() - Sets a string
• UTF8String:sub() - Returns a substring of a string

• UTF8String.new() - Creates an UTF-8 string object from a string

This library implements an argument parser.

A string is parsed into an array of arguments according to a format template. Arguments in the template are separated by commas. Each argument in the template consists of a keyword, optionally followed by one or more aliases delimited by equal signs, and an optional set of modifiers delimited by slashes. Modifiers denote the expected data type, if the argument is mandatory and whether a keyword must precede its value to form a valid argument. Example argument template:

SOURCE=-s/A/M,DEST=-d/A/K

This template requires one or more arguments to satisfy SOURCE, and exactly one argument to satisfy DEST. Neither can be omitted. Either -d (or its alias DEST) must precede the value to be accepted as the second argument. Example command lines:

SOURCE one two three DEST foo	valid
DEST foo -s one	valid
DEST foo	rejected; source argument missing
one two three foo	rejected; keyword missing
one two dest foo	valid, keys are case insensitive
one two three -d="foo" four	valid, "four" added to SOURCE

An option without modifiers represents an optional string argument. Available modifiers are:

• /S - Switch; considered a boolean value. When the keyword is present, true will be written into the respective slot in the results array.
• /N - Number; the value will be converted to a number.
• /K - Keyword; the keyword (or an alias) must precede its value.
• /A - Always required; This argument cannot be omitted.
• /M - Multiple; Any number of strings will be accepted, and all values that cannot be assigned to other arguments will show up in this argument. No more than one /M modifier may appear in a template.
• /F - Fill; literal rest of line. If present, this must be the last argument.

Quoting and escaping: Double quotes can be used to enclose arguments containing equal signs and spaces.

• args.read() - Parses a string or table through an argument template

Backslashes for escaping quotes, spaces and themselves

Debug library - implements debug output and debug levels:

2	TRACE	used for trace messages
4	INFO	informational messages, notices
5	WARN	something unexpected happened
10	ERROR	something went wrong, e.g. resource unavailable
20	FAIL	something went wrong that cannot be coped with

The default debug level is WARN. To set the debug level globally, e.g.:

db = require "tek.lib.debug"
db.level = db.INFO

The default debug output stream is stderr. To override it globally, e.g.:

db = require "tek.lib.debug"
db.out = io.open("logfile", "w")

• debug.console() - Enters the debug console
• debug.dump() - Dumps a table recursively
• debug.error() - Prints a text in the ERROR debug level
• debug.execute() - Executes a function in the specified debug level
• debug.fail() - Prints a text in the FAIL debug level
• debug.info() - Prints a text in the INFO debug level
• debug.print() - Prints a text in the specified debug level
• debug.stacktrace() - Prints a stacktrace in the specified debug level
• debug.trace() - Prints a text in the TRACE debug level
• debug.warn() - Prints a text in the WARN debug level
• debug.wrout() - Output function

• level - Debug level, default 5 (WARN)
• out - Output stream, default io.stderr

This library implements the management of regions, which are collections of non-overlapping rectangles.

• Region:andRect() - Ands a rectangle to a region
• Region:andRegion() - Ands a region to a region
• Region:checkIntersect() - Checks if a rectangle intersects a region
• Region:forEach() - Calls a function for each rectangle in a region
• Region.intersect() - Returns the intersection of two rectangles
• Region:isEmpty() - Checks if a Region is empty
• Region.new() - Creates a new Region
• Region:orRect() - Ors a rectangle to a region
• Region:orRegion() - Ors a region to a region
• Region:setRect() - Resets a region to the given rectangle
• Region:shift() - Displaces a region
• Region:subRect() - Subtracts a rectangle from a region
• Region:subRegion() - Subtracts a region from a region
• Region:xorRect() - Exclusive Ors a rectangle to a region

This module is the user interface toolkit's base library. It implements a class loader and support functions, and it provides a central place for various constants and defaults. To invoke the class loader, simply aquire a class from the tek.ui table, e.g. this will load the tek.ui.class.application class, as well as all subsequently needed classes:

local ui = require "tek.ui"
ui.Application:new { ...

• ui.createHook() - Creates a hook object
• ui.destroyHook() - Destroys a hook object
• ui.getStockImage() - Gets a stock image object
• ui.extractKeyCode() - Extracts a keycode from a string
• ui.getLocale() - Gets a locale catalog
• ui.loadClass() - Loads a named class
• ui.loadImage() - Retrieves an image (possibly from an image cache)
• ui.loadLibrary() - Loads a library
• ui.loadStyleSheet() - Loads and parses a style sheet file
• ui.loadTable() - Loads a table from some standard path
• ui.require() - Loads an user interface class
• ui.resolveKeyCode() - Converts a keycode into keys and qualifiers

• HUGE

  • This constant is used to express a 'huge' spatial extent on a given axis, e.g. Width = ui.HUGE indicates that you wish no specific size limit on the X axis.

• DBLCLICKJITTER

  • Maximum sum of squared delta mouse positions (dx² + dy²) for a pair of mouse clicks to be accepted as a double click. The default is 70. Large touchscreens may require a much larger value.

• DBLCLICKTIME

  • Maximum number of microseconds between mouse clicks to be recognized as a double click. Default: 32000. Use a larger value for touchscreens.

• MSG_CLOSE

  • Message sent when a window was closed

• MSG_FOCUS

  • A window has been activated or deactivated

• MSG_INTERVAL

  • 50Hz Timer interval message

• MSG_KEYDOWN

  • Key pressed down

• MSG_KEYUP

  • Key released

• MSG_MOUSEBUTTON

  • Mousebutton pressed or released

• MSG_MOUSEMOVE

  • Mouse pointer moved

• MSG_MOUSEOVER

  • Mouse pointer has entered or left the window

• MSG_NEWSIZE

  • A window has been resized

• MSG_REFRESH

  • A window needs a (partial) refresh

• MSG_USER

  • User message

• NOTIFY_ALWAYS - see Object
• NOTIFY_VALUE - see Object
• NOTIFY_TOGGLE - see Object
• NOTIFY_FORMAT - see Object
• NOTIFY_SELF - see Object
• NOTIFY_OLDVALUE - see Object
• NOTIFY_FUNCTION - see Object
• NOTIFY_WINDOW - see Object, defined in Element
• NOTIFY_APPLICATION - see Object, defined in Element
• NOTIFY_ID - see Object, defined in Element
• NOTIFY_COROUTINE - see Object, defined in Element

• ClassOverview

ClassOverview : Class / Family / Application

This class implements tekUI's application, entrypoint and main loop.

A tekUI application can be written in a single, nested expression:

local ui = require "tek.ui"
ui.Application:new {
  Children = {
    ui.Window:new {
      Children = {
        ui.Button:new { Text = "Hello World" }
      }
    }
  }
}:run()

• ApplicationId [IG] (string)

  Name of the application, normally used as an unique identifier in combination with the Domain attribute. Default is "unknown".

• Author [IG] (string)

  Names of the application's authors. Default: "unknown"

• AuthorStyles [IG] (string)

  A string containing style sheet notation, overlaying all other properties, including those retrieved using the AuthorStyleSheets attribute.

• AuthorStyleSheets [IG] (string)

  A string containing the names of author style sheet files overlaying user and user agent styles. Multiple style sheets are separated by spaces. The last style sheet has the highest precedence, e.g. "desktop texture" would load the style sheets desktop.css and texture.css, placing texture.css on top of the cascade.

• Copyright [IG] (string)

  Copyright notice applying to the application, default "unknown"

• Display [IG] (Display)

  An initial Display. By default, the application creates a new one during Application.new().

• Domain [IG] (string)

  An uniquely identifying domain name of the vendor, organization or author manufacturing the application (preferrably without domain parts like "www." if they are not significant for identification). Default is "unknown".

• GCControl [IG] (boolean or string)

  The application can perform a garbage collection of the specified type directly before getting suspended waiting for input. If set to false, no explicit garbage collection is initiated. If the value is true or "step", the application performs a single garbage collection step. Other values (e.g. "collect") are passed unmodified to collectgarbage(). Default: true

• ProgramName [IG] (string)

  Name of the application, as displayed to the user. This is also the fallback for the Title attribute in windows. If unset, the default will be "tekUI".

• Status [G] (string)

  Status of the application, can be "init", "error", "run", "quit".

• Vendor [IG] (string)

  Name of the vendor or organization responsible for producing the application, as displayed to the user. Default "unknown".

The Domain and ApplicationId attributes are UTF-8 encoded strings, so any international character sequence is valid for them. Anyhow, it is recommended to avoid too adventurous symbolism, as its end up in a hardly decipherable, UTF-8 plus URL-encoded form in the file system, e.g. for loading catalog files from tek/ui/locale/<domain>/<applicationid>.

• Application:addCoroutine() - Adds a coroutine to the application
• Application:addInputHandler() - Adds input handler to the application
• Application:connect() - Connects children recursively
• Application:easyRequest() - Opens a message box
• Application:getById() - Returns an element by Id
• Application:getChildren() - Returns the application's children
• Application:getGroup() - Returns the application's group
• Application:getLocale() - Returns a locale for the application
• Application:quit() - Quits the application
• Application:remInputHandler() - Removes a registered input handler
• Application:requestFile() - Opens a file requester
• Application:run() - Runs the application
• Application:suspend() - Suspends the caller's coroutine

• Family:addMember()
• Object.init()
• Class.new()
• Family:remMember()

ClassOverview : Class / Object / Element / Area

This is the base class of all visible user interface elements. It implements an outer margin, layouting, drawing, and the relationships to its neighbour elements.

• AutoPosition [ISG] (boolean)

  When the element receives the focus, this flag instructs it to automatically position itself into the visible area of any Canvas that may contain it. An affected Canvas must have its AutoPosition attribute enabled as well for this option to take effect (but unlike the Area class, in a Canvas it is disabled by default).

• BGPen [G] (color specification)

  The current color (or texture) for painting the element's background. This value is set in Area:setState(), where it is derived from the element's current state and the background-color style property. Valid are color names (e.g. "detail", "fuchsia", see also Display for more), a hexadecimal RGB specification (e.g. "#334455", "#f0f"), or an image URL in the form "url(...)".

• DamageRegion [G] (Region)

  see TrackDamage

• Disabled [ISG] (boolean)

  If true, the element is in disabled state and loses its ability to interact with the user. This state variable is handled in the Widget class.

• EraseBG [ISG] (boolean)

  If true, the element's background is painted automatically using the Area:erase() method. Set this attribute to false if you intend to paint the background yourself in Area:draw().

• Flags [SG] (Flags field)

  This attribute holds various status flags:

  • FL_SETUP - Set in Area:setup() and cleared in Area:cleanup()
  • FL_LAYOUT - Set in Area:layout(), cleared in Area:cleanup()
  • FL_SHOW - Set in Area:show(), cleared in Area:hide()
  • FL_REDRAW - Set in Area:layout(), Area:damage(), Area:setState() and possibly other places to indicate that the element needs to be repainted. Cleared in Area:draw().
  • FL_REDRAWBORDER - To indicate a repaint of the element's borders. Handled in the Frame class.
  • FL_CHANGED - This flag indicates that the contents of an element have changed, i.e. when children were added to a group, or when setting a new text or image should cause a recalculation of its size.
  • FL_POPITEM - Used to identify elements in popups, handled in PopItem.

• Focus [SG] (boolean)

  If true, the element has the input focus. This state variable is handled by the Widget class. Note: This attribute represents only the current state. If you want to place the initial focus on an element, use the InitialFocus attribute in the Widget class.

• HAlign [IG] ("left", "center", "right")

  Horizontal alignment of the element in its group. This attribute can be controlled using the halign style property.

• Height [IG] (number, false, "fill", "free")

  Height of the element, in pixels, or

  • false - unspecified; during initialization, the class' default will be used
  • "free" - Allows the element's height to grow to any size.
  • "fill" - To fill up the height that other elements in the same group have claimed, without claiming more.

  This attribute can be controlled using the height style property.

• Hilite [SG] (boolean)

  If true, the element is in highlighted state. This state variable is handled by the Widget class.

• MaxHeight [IG] (number)

  Maximum height of the element, in pixels [default: ui.HUGE]. This attribute is controllable via the max-height style property.

• MaxWidth [IG] (number)

  Maximum width of the element, in pixels [default: ui.HUGE]. This attribute is controllable via the max-width style property.

• MinHeight [IG] (number)

  Minimum height of the element, in pixels [default: 0]. This attribute is controllable via the min-height style property.

• MinWidth [IG] (number)

  Minimum width of the element, in pixels [default: 0]. This attribute is controllable via the min-width style property.

• Selected [ISG] (boolean)

  If true, the element is in selected state. This state variable is handled by the Widget class.

• TrackDamage [ISG] (boolean)

  If true, the element collects intra-area damages in a Region named DamageRegion, which can be used by class writers to implement minimally invasive repaints. Default: false, the element is repainted in its entirety.

• VAlign [IG] ("top", "center", "bottom")

  Vertical alignment of the element in its group. This attribute can be controlled using the valign style property.

• Weight [IG] (number)

  Specifies the weight that is attributed to the element relative to its siblings in the same group. By recommendation, the weights in a group should sum up to 0x10000.

• Width [IG] (number, false, "fill", "free")

  Width of the element, in pixels, or

  • false - unspecified; during initialization, the class' default will be used
  • "free" - Allows the element's width to grow to any size
  • "fill" - To fill up the width that other elements in the same group have claimed, without claiming more.

  This attribute can be controlled using the width style property.

Note that repainting elements with a "fixed" background-attachment can be expensive. This variant should be used sparingly, and some classes may implement it incompletely or incorrectly.

• Area:askMinMax() - Queries the element's minimum and maximum size
• Area:checkFocus() - Checks if the element can receive the input focus
• Area:checkHover() - Checks if the element can be hovered over
• Area:damage() - Notifies the element of a damage
• Area:draw() - Paints the element
• Area:drawBegin() - Prepares the rendering context
• Area:drawEnd() - Reverts the changes made in drawBegin()
• Area:erase() - Erases the element's background
• Area:focusRect() - Makes the element fully visible, if possible
• Area:getBG() - Gets the element's background properties
• Area:getBGElement() - Gets the element's background element
• Area:getChildren() - Gets the element's children
• Area:getByXY() - Checks if the element covers a coordinate
• Area:getGroup() - Gets the element's group
• Area:getMargin() - Gets the element's margin
• Area:getMinMax() - Gets the element's calculated min/max sizes
• Area:getNext() - Gets the element's successor in its group
• Area:getPadding() - Gets the element's paddings
• Area:getParent() - Gets the element's parent element
• Area:getPrev() - Gets the element's predecessor in its group
• Area:getRect() - Returns the element's layouted coordinates
• Area:getSiblings() - Gets the element's siblings
• Area:hide() - Gets called when the element is about to be hidden
• Area:layout() - Layouts the element into a rectangle
• Area:passMsg() - Passes an input message to the element
• Area:punch() - Subtracts the outline of the element from a Region
• Area:rethinkLayout() - Causes a relayout of the element and its group
• Area:setState() - Sets the background attribute of an element
• Area:show() - Gets called when the element is about to be shown

• Element:cleanup()
• Object.init()
• Class.new()
• Element:onSetStyle()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / Button

The Button class implements a Text element with a button mode (behavior) and button class (appearance). In addition to that, it enables the initialization of a possible keyboard shortcut from a special initiatory character (by default an underscore) preceding a letter in the element's Text attribute.

This class adds redundancy, because it differs from the Text class only in that it specifies a few attributes differently in its new() method. To avoid this overhead, use the Text class directly, or create a Button factory like this:

function newButton(text)
  return ui.Text:new { Mode = "button", Class = "button",
    Text = text, KeyCode = true }
end

ClassOverview : Class / Object / Element / Area / Frame / Canvas

This class implements a scrollable area acting as a managing container for a child element. Currently, this class is used exclusively for child objects of the ScrollGroup class.

• AutoPosition [IG] (boolean)

  See Area

• AutoHeight [IG] (boolean)

  The height of the canvas is automatically adapted to the height of the region it is layouted into. Default: false

• AutoWidth [IG] (boolean)

  The width of the canvas is automatically adapted to the width of the canvas it is layouted into. Default: false

• CanvasHeight [ISG] (number)

  The height of the canvas in pixels

• CanvasLeft [ISG] (number)

  Left visible offset of the canvas in pixels

• CanvasTop [ISG] (number)

  Top visible offset of the canvas in pixels

• CanvasWidth [ISG] (number)

  The width of the canvas in pixels

• Child [ISG] (object)

  The child element being managed by the Canvas

• KeepMinHeight [IG] (boolean)

  Report the minimum height of the Canvas's child object as the Canvas' minimum display height

• KeepMinWidth [IG] (boolean)

  Report the minimum width of the Canvas's child object as the Canvas' minimum display width

• UnusedRegion [G] (Region)

  Region of the Canvas which is not covered by its Child

• UseChildBG [IG] (boolean)

  If true, the Canvas borrows its background properties from its child for rendering its UnusedRegion. If false, the Canvas' own background properties are used. Default: true

• VScrollStep [IG] (number)

  Vertical scroll step, used e.g. for mouse wheels

• Canvas:damageChild() - Damages a child object where it is visible
• Canvas:onSetChild() - Handler called when Child is set
• Canvas:updateUnusedRegion() - Updates region not covered by Child

• Object.addClassNotifications()
• Area:askMinMax()
• Element:cleanup()
• Element:connect()
• Area:damage()
• Element:decodeProperties()
• Element:disconnect()
• Area:draw()
• Area:drawBegin()
• Area:drawEnd()
• Element:erase()
• Area:focusRect()
• Area:getBG()
• Area:getBGElement()
• Area:getChildren()
• Area:getByXY()
• Area:hide()
• Object.init()
• Area:layout()
• Area:passMsg()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / CheckMark

Specialization of the Text class, implementing a toggle button with a graphical check mark.

• Image [IG] (Image)

  Image to be displayed when the CheckMark element is unselected.

• SelectImage [IG] (Image)

  Image to be displayed when the CheckMark element is selected.

• Area:askMinMax()
• Area:draw()
• Object.init()
• Area:layout()
• Class.new()
• Area:setState()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / DirList

This class implements a directory lister.

• AutoWidth [IG] (boolean)

  Tells the directory lister to adapt its contents dynamically to the width of the element. By default, the column widths remain adjusted to the initial width.

• FocusElement [I] (string)

  What element to focus initially: "path", "location", "list". Default: "list"

• Kind [IG] (string)

  The visual appearance (or purpose) of the lister, which will determine the presence and arrangement of some interface elements:

  • "requester" - for a standalone file requester
  • "lister" - for a directory lister component
  • "simple" - for the use without accompanying elements

  The default kind is "lister".

• Location [IG] (string)

  The currently selected entry (may be a file or directory)

• Path [IG] (string)

  Directory in the file system

• Selection [G] (table)

  An array of selected entries

• SelectMode [IG] (String)

  Selection mode:

  • "single" - allows selections of one entry at a time
  • "multi" - allows selections of multiple entries

• SelectText [IG] (String)

  The text to display on the selection button. Default: "Open" (or its equivalent in the current locale)

• Status [G] (string)

  Status of the directory lister:

  • "running" - the lister is currently being shown
  • "selected" - the user has selected one or more entries
  • "cancelled" - the lister has been cancelled by the user

• DirList:abortScan() - Aborts scanning
• DirList:getCurrentDir() - Gets the current directory
• DirList:getDirIterator() - Gets an iterator over a directory
• DirList:getFileStat() - Examines a file entry
• DirList:goParent() - Goes to the parent of the current directory
• DirList:onSelectEntry() - Handler invoked on selection of an entry
• DirList:showDirectory() - Reads and shows a directory
• DirList:scanEntry() - Scans a single entry in a directory
• DirList:showDirectory() - Starts scanning and displays a directory
• DirList:splitPath() - Splits a filename

• Class.new()

ClassOverview : Class / Object / Display

This class manages a display.

• AspectX [IG] (number)

  • X component of the display's aspect ratio

• AspectY [IG] (number)

  • Y component of the display's aspect ratio

• Display:closeFont() - Closes font
• Display.createPixMap() - Creates a pixmap from picture file data
• Display:getFontAttrs() - Gets font attributes
• Display.getPixmap() - Gets a a pixmap from the cache
• Display:colorToRGB() - Converts a color specification to RGB
• Display:getTime() - Gets system time
• Display.loadPixmap() - Loads a pixmap from the file system
• Display:openFont() - Opens a named font
• Display:openVisual() - Opens a visual
• Display:sleep() - Sleeps for a period of time

• font
• font-fixed
• font-huge
• font-large
• font-menu
• font-small
• rgb-active
• rgb-active-detail
• rgb-background
• rgb-border-focus
• rgb-border-legend
• rgb-border-rim
• rgb-border-shadow
• rgb-border-shine
• rgb-cursor
• rgb-cursor-detail
• rgb-dark
• rgb-detail
• rgb-disabled
• rgb-disabled-detail
• rgb-disabled-detail-shine
• rgb-fill
• rgb-focus
• rgb-focus-detail
• rgb-group
• rgb-half-shadow
• rgb-half-shine
• rgb-hover
• rgb-hover-detail
• rgb-list
• rgb-list-active
• rgb-list-active-detail
• rgb-list-detail
• rgb-list-alt
• rgb-menu
• rgb-menu-active
• rgb-menu-active-detail
• rgb-menu-detail
• rgb-outline
• rgb-shadow
• rgb-shine
• rgb-user1
• rgb-user2
• rgb-user3
• rgb-user4

• Class.new()

ClassOverview : Class / Object / Element

This class implements the connection to a global environment and the registration by Id.

• Application [G] (Application)

  The Application the element is registered with. This attribute is set during Element:setup().

• Class [ISG] (string)

  The name of the element's style class, which can be referenced in a style sheet. Multiple classes can be specified by separating them with spaces, e.g. "button knob warn". Setting this attribute invokes the Element:onSetClass() method.

• Id [IG] (string)

  An unique Id identifying the element. If present, this Id will be registered with the Application during Element:setup().

• Parent [G] (object)

  Parent object of the element. This attribute is set during Element:connect().

• Properties [G] (table)

  A table of properties, resulting from element and user style classes, overlaid with individual and direct formattings, and finally from hardcoded element properties. This table is initialized in Element:decodeProperties().

• Style [ISG] (string)

  Direct style formattings of the element, overriding class-wide formattings in a style sheet. Example:

  "background-color: #880000; color: #ffff00"
  

  Setting this attribute invokes the Element:onSetStyle() method.

• Window [G] (Window)

  The Window the element is registered with. This attribute is set during Element:setup().

• Element:addStyleClass() - Appends a style class to an element
• Element:cleanup() - Unlinks the element from its environment
• Element:connect() - Connects the element to a parent element
• Element:decodeProperties() - Decodes the element's style properties
• Element:disconnect() - Disconnects the element from its parent
• Element:getAttr() - Gets a named attribute from an element
• Element:getById() - Gets a registered element by Id
• Element:onSetClass() - Gets invoked on changes of Class
• Element:onSetStyle() - Gets invoked on changes of Style
• Element:setup() - Links the element to an Application and Window

• Object.addClassNotifications()
• Object.init()

ClassOverview : Class / Object / Family

This class implements a container for child objects.

• Children [IG] (table)

  Array of child objects

• Family:addMember() - Adds an element to a Family
• Family:remMember() - Removed an element from a Family

ClassOverview : Class / Object / Element / Area / FloatText

This class implements a scrollable display of text. An object of this class is normally the immediate child of a Canvas.

• FGPen [IG] (userdata)

  Pen for rendering the text. This attribute is controllable via the color style property.

• Font [IG] (string)

  Font specifier; see Text for a format description. This attribute is controllable via the font style property.

• Preformatted [IG] (boolean)

  Boolean, indicating that the text is already formatted and should not be reformatted to fit the element's width.

• Text [ISG]] (string)

  The text to be displayed

• FloatText:appendLine() - Append a line of text
• FloatText:onSetText() - Handler called when Text is changed

• Object.addClassNotifications()
• Area:askMinMax()
• Element:cleanup()
• Area:damage()
• Area:draw()
• Area:hide()
• Object.init()
• Area:layout()
• Area:setState()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame

This class implements an element's borders. The default border class handles up to three sub borders:

• The main border is the innermost of the three sub borders. It is used to render the primary border style, which can be inset, outset, ridge, groove, or solid. This border has priority over the other two.
• The rim border separates the two other borders and may give the composition a more contrastful look. This border has the lowest priority.
• The focus border (in addition to the element's focus highlighting style) can be used to visualize that the element is currently receiving the input. This is the outermost of the three sub borders. When the element is in unfocused state, this border often appears in the same color as the surrounding group, making it indistinguishable from the surrounding background.

Border classes do not have to implement all sub borders; these properties are all handled by the default border class internally, and more (and other) sub borders and properties may be defined and implemented in the future (or in other border classes). As the Frame class has no notion of sub borders, their respective widths are subtracted from the Element's total border width, leaving only the remaining width for the main border.

• BorderRegion [G] (Region)

  Region object holding the outline of the element's border

• Legend [IG] (string)

  Border legend text

• Frame:drawBorder() - Draws the element's border
• Frame:getBorder() - Queries the element's border

• Element:cleanup()
• Area:damage()
• Area:draw()
• Area:getByXY()
• Area:getMargin()
• Area:layout()
• Class.new()
• Element:onSetStyle()
• Area:punch()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Numeric / Gauge

This class implements a gauge for the visualization of numerical values.

• Area:askMinMax()
• Element:cleanup()
• Area:draw()
• Area:hide()
• Object.init()
• Area:layout()
• Numeric:onSetValue()
• Area:setState()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group

This class implements a container for child elements and various layouting options.

• Children [IG] (table)

  A table of the object's children

• Columns [IG] (number)

  Grid width, in number of elements [Default: 1, not a grid]

• FreeRegion [G] (Region)

  Region inside the group that is not covered by child elements

• Layout [IG] (string or Layout)

  The name of a layouter class (or a Layouter object) used for layouting the element's children. Default: "default"

• Orientation [IG] (string)

  Orientation of the group; can be

  • "horizontal" - The elements are layouted horizontally
  • "vertical" - The elements are layouted vertically

  Default: "horizontal"

• Rows [IG] (number)

  Grid height, in number of elements. [Default: 1, not a grid]

• SameSize [IG] (boolean, "width", "height")

  true indicates that the same width and height should be reserved for all elements in the group; the keywords "width" and "height" specify that only the same width or height should be reserved, respectively. Default: false

• Group:addMember() - See Family:addMember()
• Group:remMember() - See Family:remMember()

• Area:askMinMax()
• Element:cleanup()
• Area:damage()
• Element:decodeProperties()
• Area:draw()
• Area:erase()
• Area:getBGElement()
• Area:getByXY()
• Area:getChildren()
• Area:getGroup()
• Area:hide()
• Object.init()
• Area:layout()
• Area:passMsg()
• Area:punch()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Handle

Implements a handle that can be dragged along the axis of the Group's orientation. It reassigns Weights to its flanking elements.

• Area:askMinMax()
• Area:checkFocus()
• Area:draw()
• Object.init()
• Widget:onHover()
• Area:passMsg()
• Area:setState()
• Area:show()

ClassOverview : Class / Layout

A layouter implements a group's layouting strategy. The "default" layouter implements a dynamic, scalable layout, which adapts to the free space available to the group.

• Layout:layout() - Layouts the group
• Layout:askMinMax() - Queries the group's minimum and maximum size requirements

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / Lister

This class implements a scrollable list or table. Each item in the list is a table consisting of the following elements:

{ { "column1", "column2", ... }, userdata, selected, ... }

Description:

• entry[1] is a table containing the text of each column;
• entry[2] is a userdata field which can be used at will;
• entry[3] is a boolean indicating that the line is selected.

The following fields are reserved for internal use by the Lister; you should never rely on their contents or modify them.

• AlignColumn [IG] (number)

  A column number to align the right edge of the list to. [Default: unspecified]

• AlignElement [IG] (Object)

  The object determining the right edge of the list, which is an information needed for the AlignColumn attribute. By default, the Lister's parent Canvas is used, but by use of this attribute it is possible to align the Lister to something else.

• BGAlt [IG] (userdata)

  A colored pen for painting the background of alternating lines

• ColumnPadding [IG] (number)

  The padding between columns, in pixels. By default, the Lister's Font is used to determine a reasonable offset.

• CursorBorderClass [IG] (string)

  Name of the border class used to implement this element's cursor border. Default: "default"

• CursorLine [ISG] (number)

  The line number of the Lister's cursor; this value may be 0, in which case the cursor is invisible. Changing this value will invoke the Lister:onSetCursor() method.

• Font [IG] (string)

  Font specifier for determining the font used for list entries. See Text for details on its format.

• HeaderGroup [IG] (Group)

  A group of elements used for the table header. The Lister may take these elements into account for determining the initial column widths.

• ListObject [IG] (List)

  The List object the Lister operates on; if none is specified, the Lister creates an empty one.

• NumSelectedLines [G] (number)

  The number of lines currently selected.

• SelectedLines [G] (table)

  This attribute is a (sparse) table containing the numbers of selected lines in the list. Use pairs() to iterate it. See also Lister:getSelectedLines() for retrieving a numerically indexed list.

• SelectedLine [ISG] (number)

  The Lister's current selected line; this value reflects only the line that was most recently selected or unselected - for locating all currently selected lines, you will also need the SelectedLines attribute. Setting this value will invoke the Lister:onSelectLine() method.

• SelectMode [IG] (string)

  The Lister's selection mode, which can be "none", "single", or "multi".

• Lister:addItem() - Adds an item to the list
• Lister:changeItem() - Overwrite item in the list
• Lister:changeSelection() - Changes selection of the list
• Lister:clear() - Removes all items from the list
• Lister:damageLine() - Marks line for repainting
• Lister:getItem() - Returns the item at the specified line
• Lister:getN() - Returns the number of entries in the list
• Lister:getSelectedLines() - Returns a table of selected entries
• Lister:onSelectLine() - Handler invoked for SelectedLine
• Lister:onSetCursor() - Handler invoked for CursorLine
• Lister:repaint() - Relayouts and repaints the list
• Lister:remItem() - Removes an item from the list
• Lister:setList() - Sets a new list object

• background-color2

• Area:askMinMax()
• Element:cleanup()
• Element:connect()
• Area:draw()
• Area:hide()
• Object.init()
• Area:layout()
• Frame:onFocus()
• Area:passMsg()
• Area:setState()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / ListView

This class implements a Group containing a ScrollGroup and optionally a group of column headers; its main purpose is to automate the somewhat complicated setup of multi-column lists with headers, but it can be used for single-column lists and lists without column headers as well.

• Headers [I] (table)

  An array of strings containing the captions of column headers. [Default: unspecified]

• HSliderMode [I] (string)

  This attribute is passed on the ScrollGroup - see there.

• VSliderMode [I] (string)

  This attribute is passed on the ScrollGroup - see there.

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / PopItem / MenuItem

This class implements basic, recursive items for window and popup menus with a typical menu look; in particular, it displays the PopItem's Shortcut string and an arrow to indicate the presence of a sub menu.

• Area:askMinMax()
• Area:draw()
• Object.init()
• Area:layout()
• Class.new()
• Area:setState()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Numeric

This class implements the management of numerical values. Without further specialization it has hardly any real-life use and may be considered an abstract class. See also Gauge and Slider for some of its child classes.

• Default [IG] (number)

  The default for Value, which can be revoked using the Numeric:reset() method.

• Max [ISG] (number)

  Maximum acceptable Value. Setting this value invokes the Numeric:onSetMax() method.

• Min [ISG] (number)

  Minimum acceptable Value. Setting this value invokes the Numeric:onSetMin() method.

• Step [ISG] (number)

  Default step value [Default: 1]

• Value [ISG] (number)

  The current value represented by this class. Setting this value causes the Numeric:onSetValue() method to be invoked.

• Numeric:decrease() - Decreases Value
• Numeric:increase() - Increases Value
• Numeric:onSetMax() - Handler for the Max attribute
• Numeric:onSetMin() - Handler for the Min attribute
• Numeric:onSetValue() - Handler for the Value attribute
• Numeric:reset() - Resets Value to the Default value

• Object.addClassNotifications()
• Element:cleanup()
• Object.init()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / PageGroup

Implements a group whose children are layouted in individual pages.

• PageCaptions [IG] (table)

  An array of strings containing captions for each page in the group. If false, no page captions will be displayed. [Default: false]

• PageNumber [ISG] (number)

  Number of the page that is initially selected. [Default: 1] Setting this attribute invokes the PageGroup:onSetPageNumber() method.

• PageGroup:disablePage() - Enables a Page
• PageGroup:onSetPageNumber() - Handler for PageNumber

• Element:cleanup()
• Object.init()
• Class.new()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / PopItem

This class provides an anchorage for popups. This also works recursively, i.e. elements of the PopItem class may contain other PopItems as their children. The most notable child class of the PopItem is the MenuItem.

• Children [I] (table)

  Array of child objects - will be connected to the application while the popup is open.

• Shortcut [IG] (string)

  Keyboard shortcut for the object; unlike Widget.KeyCode, this shortcut is also enabled while the object is invisible. By convention, only combinations with a qualifier should be used here, e.g. "Alt+C", "Shift+Ctrl+Q". Qualifiers are separated by "+" and must precede the key. Valid qualifiers are:

  • "Alt", "LAlt", "RAlt"
  • "Shift", "LShift", "RShift"
  • "Ctrl", "LCtrl", "RCtrl"
  • "IgnoreCase" - pseudo-qualifier; ignores the Shift key
  • "IgnoreAltShift" - pseudo-qualifier, ignores the Shift and Alt keys

  Alias names for keys are

  • "F1" ... "F12" (function keys),
  • "Left", "Right", "Up", "Down" (cursor keys)
  • "BckSpc", "Tab", "Esc", "Insert", "Overwrite", "PageUp", "PageDown", "Pos1", "End", "Print", "Scroll", and "Pause"}}.

• Object.addClassNotifications()
• Element:cleanup()
• Element:getAttr()
• Object.init()
• Widget:onClick()
• Area:passMsg()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / PopItem / PopList

This class is a specialization of a PopItem allowing the user to choose an item from a list.

• ListObject [IG] (List)

  List object

• SelectedLine [ISG] (number)

  Number of the selected entry, or 0 if none is selected. Changing this attribute invokes the PopList:onSelectLine() method.

• PopList:onSelectLine() - Handler for the SelectedLine attribute
• PopList:setList() - Sets a new list object

• Area:askMinMax()
• Area:cleanup()
• Area:draw()
• Object.init()
• Class.new()
• Area:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / Window / PopupWindow

This class specializes a Window for the use by a PopItem.

• Object.init()
• Area:show()
• Area:passMsg()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / CheckMark / RadioButton

Specialization of a CheckMark to implement mutually exclusive 'radio buttons'.

• Object.init()
• Widget:onSelect()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / ScrollBar

Implements a group containing a Slider and arrow buttons.

• AcceptFocus [IG] (boolean)

  If false, the elements inside the scrollbar (slider, arrows) abstain from receiving the input focus, which means that they can only be operated with the mouse. Default: true

• Integer [IG] (boolean)

  If true, integer steps are enforced. By default, the slider moves continuously.

• Max [ISG] (number)

  The maximum value the slider can accept. Setting this value invokes the ScrollBar:onSetMax() method.

• Min [ISG] (number)

  The minimum value the slider can accept. Setting this value invokes the ScrollBar:onSetMin() method.

• Orientation [IG] (string)

  The orientation of the scrollbar, which can be "horizontal" or "vertical"

• Range [ISG] (number)

  The range of the slider, i.e. the size it represents. Setting this value invokes the ScrollBar:onSetRange() method.

• Value [ISG] (number)

  The value of the slider. Setting this value invokes the ScrollBar:onSetValue() method.

• ScrollBar:onSetMax() - Handler for the Max attribute
• ScrollBar:onSetMin() - Handler for the Min attribute
• ScrollBar:onSetRange() - Handler for the Range attribute
• ScrollBar:onSetValue() - Handler for the Value attribute

• Object.addClassNotifications()
• Element:cleanup()
• Class.new()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / ScrollGroup

This class implements a group containing a scrollable container and accompanying elements such as horizontal and vertical ScrollBars.

• AcceptFocus [IG] (boolean)

  This attribute is passed to the scrollbar elements inside the scroll group. See ScrollBar

• Child [IG] (Canvas)

  Specifies the Canvas which encapsulates the scrollable area and children.

• HSliderMode [IG] (string)

  Specifies when the horizontal ScrollBar should be visible:

  • "on" - The horizontal scrollbar is displayed
  • "off" - The horizontal scrollbar is not displayed
  • "auto" - The horizontal scrollbar is displayed when the Lister is wider than the currently visible area.

  Note: The use of the "auto" mode is currently (v8.0) discouraged.

• VSliderMode [IG] (string)

  Specifies when the vertical ScrollBar should be visible:

  • "on" - The vertical scrollbar is displayed
  • "off" - The vertical scrollbar is not displayed
  • "auto" - The vertical scrollbar is displayed when the Lister is taller than the currently visible area.

  Note: The use of the "auto" mode is currently (v8.0) discouraged.

• Element:cleanup()
• Area:layout()
• Class.new()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Numeric / Slider

This class implements a slider for adjusting a numerical value.

• AutoFocus [IG] (boolean)

  If true and the slider is receiving the focus, it reacts on keyboard shortcuts instantly; otherwise, it must be selected first (and deselected afterwards). Default: false

• Child [IG] (Widget)

  A Widget object for being used as the slider's knob. By default, a knob widget of the style class "knob" is created internally.

• Integer [IG] (boolean)

  If true, integer steps are enforced. By default, the slider knob moves continuously.

• Kind [IG] (string)

  Kind of the slider:

  • "scrollbar" - for scrollbars. Sets the additional style class "knob-scrollbar".
  • "number" - for adjusting numbers. Sets the additional style class "knob-number".

  Default: false, the kind is unspecified.

• Orientation [IG] (string)

  Orientation of the slider, which can be "horizontal" or "vertical". Default: "horizontal"

• Range [ISG] (number)

  The size of the slider, i.e. the range that it represents. Setting this value invokes the Slider:onSetRange() method.

• Slider:onSetRange() - Handler for the Range attribute

OVERRIDES:

• Object.addClassNotifications()
• Element:cleanup()
• Area:draw()
• Area:hide()
• Object.init()
• Area:layout()
• Area:passMsg()
• Widget:onFocus()
• Widget:onHold()
• Area:setState()
• Element:setup()
• Area:show()
• Numeric:onSetMax()
• Numeric:onSetValue()

ClassOverview : Class / Object / Element / Area / Frame / Spacer

This class implements a separator that helps to arrange elements in a group.

• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text

This class implements widgets with text.

• KeepMinHeight [IG] (boolean)

  After the initial size calculation, keep the minimal height of the element and do not rethink the layout in response to a possible new minimal height (e.g. resulting from a newly set text).

• KeepMinWidth [IG] (boolean)

  After the initial size calculation, keep the minimal width of the element and do not rethink the layout in response to a possible new minimal width (e.g. resulting from a newly set text).

• Text [ISG] (string)

  The text that will be displayed on the element; it may span multiple lines (see also Text:makeTextRecords()). Setting this attribute invokes the Text:onSetText() method.

A font is specified in the form

"[fontname1,fontname2,...][:][size]"

Font names, if specified, will be probed in the order of their occurrence in the string; the first font that can be opened will be used. For the font names, the following predefined named are supported:

• ui-fixed - The default fixed font
• ui-main (or an empty string) - The default main font, e.g. for buttons and menus
• ui-small - The default small font, e.g. for group captions
• ui-large - The default 'large' font
• ui-huge - The default 'huge' font

If no font name is specified, the main font will be used. The size specification (in pixels) is optional as well; if absent, the respective font's default size will be used.

• Text:getTextSize() - Gets the total extents of all text records
• Text:makeTextRecords() - Breaks text into multiple line records
• Text:onSetText() - Handler for changes of the Text attribute

• Object.addClassNotifications()
• Area:askMinMax()
• Element:cleanup()
• Area:draw()
• Object.init()
• Element:onSetStyle()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Text / TextInput

This class implements a widget for entering and editing text.

• Enter [SG] (string)

  The text that is being entered (by pressing the Return key) into the input field. Setting this value causes the invocation of the TextInput:onEnter() method.

• EnterNext [IG] (boolean)

  Indicates that by pressing the Return key, the focus should advance to the next element that can receive input.

• TabEnter [IG] (boolean)

  Indicates that leaving the element by pressing the Tab key should set the Enter attribute and invoke the respective handler.

• cursor-background-color
• cursor-color

• TextInput:addChar() - Perform character addition
• TextInput:backSpace() - Perform 'Backspace' function
• TextInput:delChar() - Perform 'Del' function
• TextInput:getChar() - Get character under cursor or at position
• TextInput:getCursor() - Get cursor position
• TextInput:moveCursorLeft() - Move the cursor one step to the left
• TextInput:moveCursorRight() - Move the cursor one step to the right
• TextInput:onEnter() - Handler invoked when Enter ist set
• TextInput:setCursor() - Set cursor position

• Area:askMinMax()
• Element:cleanup()
• Area:draw()
• Element:hide()
• Object.init()
• Frame:onFocus()
• Widget:onSelect()
• Text:onSetText()
• Area:passMsg()
• Area:setState()
• Element:setup()
• Element:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget

This class implements interactions with the user.

• Active [SG] (boolean)

  The Widget's activation state. While true, the position of the pointing device is being verified (which is also reflected by the Hover attribute, see below). When the Active state variable changes, the Widget's behavior depends on its Mode attribute (see below):

  • in button mode, the Selected attribute is set to the value of the Hover attribute. When the Selected state changes, the Pressed attribute is set to the value of the Active attribute.
  • in toggle mode, the Selected attribute is inverted logically, and the Pressed attribute is set to true.
  • in touch mode, the Selected and Pressed attributes are set to true, if the Widget was not selected already.

  Changing this attribute invokes the Widget:onActivate() method.

• DblClick [SG] (boolean)

  Signifies that the element is or has been double-clicked; it is set to true when the element was double-clicked and is still being held, and false when the second press has been released. Changes to this attribute cause the invocation of the Widget:onDblClick() method.

• FGPen [IG] (color specification)

  A color specification for rendering the foreground details of the element. This attribute is controllable via the color style property.

• Hold [SG] (boolean)

  Signifies that the element is being pressed for an extended period. While being held, the value is repeatedly set to true in intervals of n/50 seconds, with n taken from the Window's HoldTickRepeat attribute. When the element is released, this attribute is set to false. Changes to this attribute cause the invocation of the Widget:onHold() method.

• Hover [SG] (boolean)

  Signifies a change of the element being hovered by the pointing device. Changes to this state variable invoke Widget:onHover().

• InitialFocus [IG] (boolean)

  Specifies that the element should receive the focus initially. If true, the element will set the element's Focus attribute to true upon invocation of the show method.

• KeyCode [IG] (string or boolean)

  If set, a keyboard equivalent for activating the element. See PopItem for a discussion of denoting keyboard qualifiers. The Text class allows setting this attribute to true, in which case the element's Text will be examined during setup for an initiatory character (by default an underscore), and if found, the KeyCode attribute will be replaced by the character following this marker.

• Mode [ISG] (string)

  The element's interaction mode:

  • "inert": The element does not react on input
  • "touch": The element does not rebound and keeps its Selected state; it cannot be unselected by the user and always submits true for the Pressed and Selected attributes.
  • "toggle": The element does not rebound immediately and keeps its Selected state until the next activation.
  • "button": The element rebounds when the pointing device over it is being released, or when it is no longer hovering it.

  See also the Active attribute.

• Pressed [SG] (boolean)

  Signifies that a button was pressed or released. Changes to this state variable invoke Widget:onPress().

A possible name for the effect-class property is "ripple". As its name suggests, it can paint various ripple effects (e.g. for slider knobs and bar handles). Effect hooks are loaded from tek.ui.hook and may define their own style properties.

• Widget:onActivate() - Handler for Active
• Widget:onClick() - Gets called when the element has been clicked
• Widget:onDblClick() - Handler for DblClick
• Widget:onDisable() - Handler for Disabled
• Widget:onFocus() - Handler for Focus
• Widget:onHilite() - Handler for Hilite
• Widget:onHold() - Handler for Hold
• Widget:onHover() - Handler for Hover
• Widget:onPress() - Handler for Pressed
• Widget:onSelect() - Handler for Selected

• Object.addClassNotifications()
• Area:checkFocus()
• Area:checkHover()
• Element:cleanup()
• Object.init()
• Area:layout()
• Area:passMsg()
• Area:setState()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Widget / Group / Window

This class implements a Group which fills up a window on the Display.

• Center [IG] (boolean)

  Instructs the Window to open centered.

• DblClickJitter [IG] (number)

  Maximum sum of squared pixel deltas (dx² + dy²) between mouse positions to be tolerated for a double click. The default is 70. Large touchscreens require a much larger value.

• DblClickTimeout [IG] (number)

  Maximum number of microseconds between events to be recognized as a double click. Default: 32000. Use a larger value for touchscreens.

• FullScreen [IG] (boolean)

  Instructs the Window to open borderless and in fullscreen mode.

• HideOnEscape [IG] (boolean)

  Instructs the window to invoke the Window:onHide() method when the Escape key is pressed. Default: false

• Left [IG] (number)

  The window's left offset on the display, in pixels

• Modal [IG] (boolean)

  Instructs all other windows to reject input while this window is open.

• MouseX [G] (number)
• MouseY [G] (number)

  The current window coordinates of the pointing device.

• Status [ISG] (string)

  Status of the Window, which can be:

  • "initializing" - The window is initializing
  • "hide" - The window is hidden or about to hide; if you initialize the Window with this value, it will be created in hidden state.
  • "opening" - The window is about to open.
  • "show" - The window is shown.
  • "closing" - The Window is about to hide.

  Changing this attribute invokes the Window:onChangeStatus() method.

• Title [IG] (string)

  The window's title

• Top [IG] (number)

  The window's top offset on the display, in pixels

• Window:addInputHandler() - Adds an input handler to the window
• Window:addInterval() - Adds an interval timer to the window
• Window:checkDblClickTime() - Checks a time for a doubleclick event
• Window:clickElement() - Simulates a click on an element
• Window:onChangeStatus() - Handler for Status
• Window:onHide() - Handler for when the window is about to be closed
• Window:postMsg() - Post an user message in the Window's message queue
• Window:remInputHandler() - Removes an input handler from the window
• Window:remInterval() - Removes an interval timer from the window
• Window:setActiveElement() - Sets the window's active element
• Window:setDblClickElement() - Sets the window's doubleclick element
• Window:setFocusElement() - Sets the window's focused element
• Window:setHiliteElement() - Sets the window's hover element
• Window:setMovingElement() - Sets the window's moving element

• Object.addClassNotifications()
• Area:hide()
• Object.init()
• Area:layout()
• Area:passMsg()
• Area:rethinkLayout()
• Element:setup()
• Area:show()

ClassOverview : Class / Layout / DefaultLayout

This class implements a Group's default layouting strategy. The standard strategy is to adapt a Group's contents dynamically to the free space available. It takes into account an element's HAlign, VAlign, Width, and Height attributes.

• Layout:askMinMax()
• Layout:layout()
• Class.new()

ClassOverview : Class / Layout / DefaultLayout

This class implements a Group's default layouting strategy. The standard strategy is to adapt a Group's contents dynamically to the free space available. It takes into account an element's HAlign, VAlign, Width, and Height attributes.

• Layout:askMinMax()
• Layout:layout()
• Class.new()

ClassOverview : Class / Layout / FixedLayout

This class implements a Group's fixed layouting strategy. Using the fixed layouter, the size and position of individual elements in a group is predetermined by the contents of their fixed style property, with the coordinates of the rectangle in the order left, top, right, bottom, e.g.:

ui.Window:new {
  Layout = "fixed", Width = 400, Height = 400,
  Children = {
    ui.Button:new {
      Style = "fixed: 10 280 60 320"
    }
  }
}

• Layout:askMinMax()
• Layout:layout()

Document generated on Mon Mar 15 16:44:09 2010