File ../../LibScriptableWidgets-1.0/LibScriptableWidgetKey-1.0/LibScriptableWidgetKey-1.0.lua

Functions

WidgetKey:Del () Delete a LibScriptableWidgetKey object
WidgetKey:GetOptions (db, callback, data) Get an Ace3 option table.
WidgetKey:KeyEvent (modifier, up) A key event fired, now execute this widget's code
WidgetKey:New (visitor, name, config, errorLevel) Create a new LibScriptableWidgetKey object
WidgetKey:Start () Start a LibScriptableWidgetKey
WidgetKey:Stop () Stop a LibScriptableWidgetKey


Functions

WidgetKey:Del ()
Delete a LibScriptableWidgetKey object

Usage:

:Del()

Return value:

Nothing
WidgetKey:GetOptions (db, callback, data)
Get an Ace3 option table. Plug this into a group type's args.

Parameters

  • db: The database table
  • callback: Provide this if you want to execute the callback once an option is changed
  • data: Some data to pass when executing the callback

Usage:

:GetOptions(db, callback, data)

Return value:

An Ace3 options table -- `name.args = options`.
WidgetKey:KeyEvent (modifier, up)
A key event fired, now execute this widget's code

Parameters

  • modifier: Which key, i.e. LCTRL, RALT. Note that RALT and RALT both fire the same event.
  • up: Whether this is the button release or not

Return value:

Nothing
WidgetKey:New (visitor, name, config, errorLevel)
Create a new LibScriptableWidgetKey object

Parameters

  • visitor: An LibScriptableCore-1.0 object
  • name: A name for your key widget
  • config: This widget's parameters.
  • errorLevel: The errorLevel for this object

Usage:

WidgetKey:New(visitor, name, config, errorLevel)

Return value:

A new LibScriptableWidgetKey object
WidgetKey:Start ()
Start a LibScriptableWidgetKey

Usage:

:Start()

Return value:

Nothing
WidgetKey:Stop ()
Stop a LibScriptableWidgetKey

Usage:

:Stop()

Return value:

Nothing

Valid XHTML 1.0!