ClassOverview : Class / Object / Element / Area / Frame

Implements inner and outer borders and the element's inner padding.

• Border [IG] (table)

  An array of four thicknesses (in pixels) for the element's outer border, in the order left, right, top, bottom. If unspecified during initialization, the class' default outer border thicknesses are used.

• BorderRegion [G] (Region)

  Region object holding the outline of the element's outer border

• BorderClass [G] (Class)

  Border class used for the element's outer border, loaded from the directory tek/ui/border.

• BorderStyle [IG] (string)

  Name of a style used for an element's outer border, which corresponds to the name of a border class (e.g. "recess"), used to create the element's border during initialization. If unspecified, the class' default outer border style is used.

• IBorder [IG] (table)

  An array of four thicknesses in pixels for the element's inner border, in the order left, right, top, bottom. If unspecified during initialization, the class' default inner border thicknesses are used.

• IBorderClass [G] (Class)

  Class used for the element's inner border, loaded from the directory tek/ui/border.

• IBorderStyle [IG] (string)

  Name of a style used for an element's inner border, which corresponds to the name of a border class (e.g. "button"), used to create the element's border during initialization. If unspecified, the class' default inner border style is used.

• Padding [IG] (table)

  An array of four offsets for the element's inner padding in the order left, right, top, bottom [pixels]. If unspecified during initialization, the class' default paddings are used.

• Frame:drawBorder() - Draws the element's outer border
• Frame:getBorder() - Returns the element's outer border
• Frame:getIBorder() - Returns the element's inner border
• Frame:onFocus() - Handler for Focus

• Area:askMinMax()
• Element:cleanup()
• Area:draw()
• Area:hide()
• Object.init()
• Area:layout()
• Area:markDamage()
• Class.new()
• Area:punch()
• Area:refresh()
• Element:setup()
• Area:show()

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

This class implements a directory lister.

• Path [IG] (string)

  Directory in the file system

• Location [IG] (string)

  The entry currently selected, may be a file or directory

• Selection [G] (table)

  An array of selected entries

• Status [G] (string)

  Status of the 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

• Style [IG] (string)

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

  • "requester" - for being used as a standalone file requester
  • "lister" - for being used as a lister component
  • "simple" - without accompanying user interface elements

• SelectMode [IG] (String)

  Mode of selection:

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

• DirList:ShowDirectory() - Reads and shows a directory
• DirList:goParent() - Goes to the parent of the current directory
• DirList:abortScan() - Abort scanning

• Class.new()

ClassOverview : Class / Family / Application

This class implements the framework's entrypoint and main loop.

• Author [IG]

  Name of the application's author

• Copyright [IG]

  Copyright notice applying to the application

• ProgramName [IG]

  Name of the application

• Status [G]

  Status of the application, can be: "connected", "connecting", "disconnected", "disconnecting", "initializing", "error", "running"

• Theme [IG]

  Optional custom theme object; if unspecified, a default theme will be created

• Title [IG]

  Title of the application, which will be inherited by windows; if unspecified, ProgramName will be used

• Application:addCoroutine() - adds a coroutine to the application
• Application:connect() - connects children recursively
• Application:getElementById() - returns an element by Id
• Application:run() - runs the application
• Application:suspend() - suspends the caller's coroutine
• Application:requestFile() - opens a file requester

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

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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

• SelectedEntry [ISG] (number)

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

• PopList:onSelectEntry() - Handler for the SelectedEntry attribute

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

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

Specialization of a Text for placing checkmarks.

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

ClassOverview : Class / Object / Family

This class implements a container for child object.

• Children [IG] (table)

  Array of child objects

• Family:addMember()
• Family:remMember()

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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:relayout()
• Area:setState()
• Element:setup()
• Area:show()

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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 / Display

This class manages a display device.

• Theme [IG] (Theme)

  Theme object; if none is supplied during initialization, one is created.

• Display:closeFont() - Close font
• Display:getFontAttrs() - Get font attributes
• Display:getTime() - Get system time
• Display:openFont() - Open a named font
• Display:openVisual() - Open a visual
• Display:sleep() - Sleep for a period of time
• Display:getTextSize() - Get size of text rendered with a given font
• Display:wait() - Wait for a list of visuals

• Class.new()

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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.

• PageNumber [IG] (number)

  Number of the page that is initally selected. [Default: 1]

• Area:askMinMax()
• Area:getElement()
• Area:getElementByXY()
• Area:hide()
• Area:layout()
• Area:markDamage()
• Class.new()
• Area:passMsg()
• Area:punch()
• Area:refresh()
• Area:relayout()
• Area:show()

ClassOverview : Class / Object / Border

This is the base class of all border classes. Border classes are located in the directory tek/ui/border.

• Border:draw() - Draw a border
• Border:getBorder() - Get a border class' border thicknesses
• Border:getRegion() - Get a region representing the border outline
• Border.loadClass() - Load a border class

ClassOverview : Class / Object / Element / Area / FloatText

Implements a scrollable text display. This class is normally the direct child of a Canvas

• BGPen [IG]

  Pen for filling the background

• FGPen [IG]

  Pen for rendering the text

• FontSpec [IG]

  Font specifier; see Text for a format description

• Text [ISG]]

  The text to be displayed

• FloatText:onSetText() - Handler called when Text is changed

• Area:askMinMax()
• Element:cleanup()
• Object.init()
• Area:layout()
• Class.new()
• Area:setState()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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 / Gadget / Text / PopItem / MenuItem

This class implements the basic items for window menus and popups. In particular, it displays a PopItem's Shortcut attribute and an arrow to indicate that there is a sub menu.

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

ClassOverview : Class / Object / Drawable

This class implements a graphical context which can be painted on.

• Drawable:fillRect() - Draws a filled rectangle
• Drawable:drawRect() - Draws an unfilled rectangle
• Drawable:drawText() - Renders text
• Drawable:drawLine() - Draws a line
• Drawable:drawPlot() - Draws a point
• Drawable:setFont() - Sets a font
• Drawable:getTextSize() - Determines the width and height of text
• Drawable:getMsg() - Gets the next pending input message
• Drawable:pushClipRect() - Push a new cliprect on the drawable
• Drawable:popClipRect() - Pop the topmost cliprect
• Drawable:setShift() - Add coordinate displacement
• Drawable:getShift() - Get current displacement
• Drawable:copyArea() - Copy area

• Object.init()

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

This gadget implements text rendering.

• FGPen [IG] (userdata)

  A colored pen for rendering the foreground of the element

• FontSpec [IG] (string)

  A font specification in the form

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

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

  • "__fixed": The default fixed font
  • "__main": The default main font, e.g. for buttons and menus
  • "__small": The default small font, e.g. for group captions
  • "__large": The default 'large' font
  • "__huge": The default 'huge' font

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

• KeepMinHeight [IG] (boolean)

  After the initial size calculation, keep the minimal height of the element and do not rethink the layout in regard 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 regard to a possible new minimal width (e.g. resulting from a newly set text).

• ShortcutMark [IG] (string)

  The initiatory character for keyboard shortcuts in the Text, used during initial text setup. The first character following the marker will be used as the gadget's KeyCode attribute (see also Gadget). By setting this attribute to false, the text is left unmodified and no attempts are made for extracting a keyboard shortcut. [Default: "_"]

• 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.

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

  The text's horizontal alignment, which will be used in Text:makeTextRecords(). If false during initialization, the class' default will be used. [Default: "center"]

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

  The text's vertical alignment, which will be used in Text:makeTextRecords(). If false during initialization, the class' default will be used. [Default: "center"]

• Text:getTextSize() - Get total size of text records
• Text:makeTextRecords() - Break text into multiple text records
• Text:onSetText() - handler for the Text attribute

• Area:askMinMax()
• Object.init()
• Element:setup()
• Element:cleanup()
• Element:show()
• Element:hide()
• Area:setState()

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

Implements a handle to drag around in the group, thus reassigning widths (or heights) to its neighbours elements.

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

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

This class implements a slider for adjusting a numerical value.

• Child [IG] (Gadget)

  A gadget for being used as the slider's knob. By default, an internal knob gadget is used.

• ForceInteger [IG] (boolean)

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

• Orientation [IG] (string)

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

• Range [ISG] (number)

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

• Style [IG] (string)

  Style of the slider:

  • "scrollbar" - for scrollbars
  • "number" - for adjusting numbers
  • "normal" - unspecified

  Default: "normal"

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

OVERRIDES:

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

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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

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

ClassOverview : Class / Object / Element / Area

This class implements an outer margin, layouting and drawing.

• BGPen [G] (userdata)

  A colored pen for painting the background of the element

• DamageRegion [G] (Region)

  see TrackDamage

• Disabled [ISG] (boolean)

  If true, the element is in disabled state. This attribute is not handled by Area; see Gadget

• Focus [ISG] (boolean)

  If true, the element has the input focus. This attribute is not handled by Area; see Frame

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

  Horizontal alignment of the element in its group [default: "left"]

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

  Height of the element, in pixels, or

  • false - unspecified; during initialization, the class' default will be used
  • "auto" - Reserves the minimal height needed for the element.
  • "free" - Allows the element's height to grow to any size.
  • "fill" - Completely fills up the height that other elements in the same group have left, but does not claim more.

  Note: Normally, "fill" is useful only once per group.

• Hilite [ISG] (boolean)

  If true, the element is in highlighted state. This attribute is not handled by Area; see Gadget

• Margin [IG] (table)

  An array of four offsets for the element's outer margin in the order left, right, top, bottom [pixels]. If unspecified during initialization, the class' default margins are used.

• MaxHeight [IG] (number)

  Maximum height of the element, in pixels [default: ui.HUGE]

• MaxWidth [IG] (number)

  Maximum width of the element, in pixels [default: ui.HUGE]

• MinHeight [IG] (number)

  Minimum height of the element, in pixels [default: 0]

• MinWidth [IG] (number)

  Minimum width of the element, in pixels [default: 0]

• Selected [ISG] (boolean)

  If true, the element is in selected state. This attribute is not handled by Area; see Gadget

• TrackDamage [IG] (boolean)

  If true, the element gathers intra-area damages in a Region named DamageRegion, which can be used by class writers for implementing minimally invasive redrawing. [Default: false, the element is redrawn in its entirety.)

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

  Vertical alignment of the element in its group [default: "top"]

• Weight [ISG] (number)

  Determines the weight that is attributed to the element, relative to its siblings in its group. Invokes the Area:onSetWeight() method. Area:onSetWeight() recalculates all weights in the group and possibly causes relayouting and redrawing it. Note: By recommendation, the weights set in a group should sum up to 0x10000.

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

  Width of the element, in pixels, or

  • false - unspecified; during initialization, the class' default will be used
  • "auto" - Reserves the minimal width needed for the element.
  • "free" - Allows the element's width to grow to any size.
  • "fill" - Completely fills up the width that other elements in the same group have left, but does not claim more.

  Note: Normally, "fill" is useful only once per group.

• Area:askMinMax() - Query minimum and maximum dimensions
• Area:checkFocus() - Check if the element can receive the focus
• Area:draw() - Draws the element
• Area:getElement() - Returns an element's neighbours
• Area:getElementByXY() - Check if the element covers a coordinate
• Area:hide() - Removes an Area from its Display and Drawable
• Area:layout() - Layout the element into a rectangle
• Area:markDamage() - Pass a damage rectangle to an element
• Area:onSetWeight() - Handler called when Area's weight is changed
• Area:passMsg() - Filters an input message
• Area:punch() - Subtract Element from a Region
• Area:refresh() - Redraws an element
• Area:relayout() - Search and relayouts an element
• Area:rethinkLayout() - Causes relayout of the Area and its group
• Area:setState() - Sets the Background attribute of an element.
• Area:show() - Passes an Area a Display and Drawable

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

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

This class implements interactivity.

• Active [SG] (boolean)

  Signifies a change of the Gadget's activation state. While active, the position of the mouse pointer is being verified (which is also reflected by the Hover attribute). When the Active state changes, the Gadget's behavior depends on its Mode attribute:

  • in "button" mode, the Selected attribute is set to the value of the Hover attribute. The Pressed attribute is set to the value of the Active attribute, if it caused a change of the Selected state.
  • in "toggle" mode, the Selected attribute of the Gadget is logically toggled, and the Pressed attribute is set to true.
  • in "touch" mode, the Selected and Pressed attributes are set to true, if the Gadget wasn't selected already.

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

• DblClick [SG] (boolean)

  Signifies that the element was doubleclicked; is is set to true when the element was doubleclicked and is still being held, and false when it was doubleclicked and then released. This attribute usually needs to get a notification handler attached to it before it is useful.

• Disabled [ISG] (boolean)

  Signifies a change of the Gadget's ability to interact with the user. Invokes the Gadget:onDisable() method. When an element is getting disabled, it loses its focus, too.

• Hilite [SG] (boolean)

  Signifies a change of the Gadget's highligting state. Invokes Gadget:onHilite().

• Hold [SG] (boolean)

  Signifies that the element is being held. Invokes Gadget:onHold().

• Hover [SG] (boolean)

  Signifies a change of the Gadget being hovered by the pointing device. Invokes Gadget:onHover().

• KeyCode [IG] (string)

  If set, the keyboard equivalent that can be used to activate the element while it is shown [default: false]. See also PopItem for a discussion of denoting qualifiers, which applies to the KeyCode attribute as well.

• Mode [IG] (string)

  Interaction mode of the Gadget; can be

  • "inert": The element does not react to input,
  • "toggle": The element does not rebound at all and keeps its Selected state; it can't be unselected by the user.
  • "touch": The element rebounds immediately and acts as a strobe, submitting always true for Pressed and Selected.
  • "button": The element sets the Pressed attribute only if the mouse pointer is released when hovering it. See also Active.

• Pressed [SG] (boolean)

  Signifies that a button was pressed or released. Invokes Gadget:onPress().

• Selected [ISG] (boolean)

  Signifies a change of the gadget's selection state. Invokes Gadget:onSelect().

• Style [IG] (string)

  Visual style of the element; can be

  • "normal": The element is a normal gadget
  • "knob": The element is being used as a knob for a Slider

• Gadget:onActivate() - Handler for Active
• Gadget:onDisable() - Handler for Disabled
• Gadget:onHilite() - Handler for Hilite
• Gadget:onHold() - Handler for Hold
• Gadget:onHover() - Handler for Hover
• Gadget:onPress() - Handler for Pressed
• Gadget:onSelect() - Handler for Selected

• Area:checkFocus()
• Element:cleanup()
• Area:hide()
• Object.init()
• Area:passMsg()
• Element:setup()
• Area:setState()
• Area:show()

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

Specialization of a CheckMark to implement mutually exclusive 'radio buttons'; they really make sense only if more than one of their kind are grouped together.

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

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

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

• Canvas [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 ListGadget 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 ListGadget 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()
• Area:refresh()
• Area:relayout()
• Element:setup()

ClassOverview : Class / Object / Element / Area / Frame / Gadget / 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 Gadget.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"

  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".

• Element:cleanup()
• Object.init()
• Gadget:onPress()
• Area:passMsg()
• Element:setup()