File ../../LibScriptableWidgets-1.0/LibScriptableWidgetImage-1.0/LibScriptableWidgetImage-1.0.lua

Functions

LibScriptableWidgetImage.Del () Delete a LibScriptableWidgetImage object
LibScriptableWidgetImage.Start () Start a LibScriptableWidgetImage
LibScriptableWidgetImage.Stop () Stop a LibScriptableWidgetImage
WidgetImage:GetOptions (db, callback, data) Get an Ace3 option table.
WidgetImage:New (visitor, name, config, row, col, layer, errorLevel, callback, timer) Create a new LibScriptableWidgetImage object
WidgetImage:Resize (rows, cols, old_rows, old_cols) Resize this widget.
WidgetImage:Update () Update image.


Functions

LibScriptableWidgetImage.Del ()
Delete a LibScriptableWidgetImage object

Usage:

:Del()

Return value:

Nothing
LibScriptableWidgetImage.Start ()
Start a LibScriptableWidgetImage

Usage:

object:Start()

Return value:

Nothing
LibScriptableWidgetImage.Stop ()
Stop a LibScriptableWidgetImage

Usage:

object:Stop()

Return value:

Nothing
WidgetImage: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`.
WidgetImage:New (visitor, name, config, row, col, layer, errorLevel, callback, timer)
Create a new LibScriptableWidgetImage object

Parameters

  • visitor: An LibScriptableCore-1.0 object, or provide your own
  • name: A name for this widget
  • config: This widget's settings
  • row: This widget's row
  • col: This widget's column
  • layer: This widget's layer
  • errorLevel: The errorLevel for this widget
  • callback: The draw function
  • timer: An optional timer. This should have a :Start() and :Stop().

Usage:

WidgetImage:New(visitor, name, config, row, col, layer, errorLevel, timer)

Return value:

A new LibScriptableWidgetImage widget
WidgetImage:Resize (rows, cols, old_rows, old_cols)
Resize this widget. Note that this just repositions the widget at its scaled position. It also calls :Update().

Parameters

  • rows: We'll resize to this many rows
  • cols: We'll resize to this many columns
  • old_rows: We're resizing from this many rows
  • old_cols: We're resizing from this many columns

Usage:

:Resize(rows, cols, old_rows, old_cols)

Return value:

Nothing
WidgetImage:Update ()
Update image. This will execute the image's script and process any layer index information returned by the script.

Usage:

:Update()

Return value:

Nothing

Valid XHTML 1.0!