File ../../LibScriptableWidgets-1.0/LibScriptableWidgetIcon-1.0/LibScriptableWidgetIcon-1.0.lua
Functions
WidgetIcon:Del () | Delete a LibScriptableWidgetIcon object |
WidgetIcon:Draw () | Draw the image. |
WidgetIcon:GetOptions (visitor, db, callback, data) | Get an Ace3 option table. |
WidgetIcon:New (visitor, name, config, row, col, layer, errorLevel, callback, timer) | Create a new LibScriptableWidgetIcon object |
WidgetIcon:Resize (rows, cols, old_rows, old_cols) | Resize this icon. |
WidgetIcon:SetupChars () | Allocate space for this icon's special character |
WidgetIcon:Start () | Start a LibScriptableWidgetIcon |
WidgetIcon:Stop () | Stop a LibScriptableWidgetIcon |
WidgetIcon:Update () | Update icon data. |
Functions
- WidgetIcon:Del ()
-
Delete a LibScriptableWidgetIcon object
Usage:
:Del()Return value:
Nothing - WidgetIcon:Draw ()
-
Draw the image. Note that this simply calls the callback provided in the object's creation.
Usage:
:Draw()Return value:
Nothing - WidgetIcon:GetOptions (visitor, db, callback, data)
-
Get an Ace3 option table. Plug this into a group type's args.
Parameters
- visitor:
- 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`. - WidgetIcon:New (visitor, name, config, row, col, layer, errorLevel, callback, timer)
-
Create a new LibScriptableWidgetIcon 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:
WidgetIcon:New(visitor, name, config, row, col, layer, errorLevel, timer)Return value:
A new LibScriptableWidgetIcon widget - WidgetIcon:Resize (rows, cols, old_rows, old_cols)
-
Resize this icon. Note that this repositions this widget on the surface described.
Parameters
- rows: The new row height.
- cols: The new column width.
- old_rows: The old row height.
- old_cols: The new column width.
Return value:
Nothing - WidgetIcon:SetupChars ()
-
Allocate space for this icon's special character
Usage:
:SetupChars()Return value:
Nothing - WidgetIcon:Start ()
-
Start a LibScriptableWidgetIcon
Usage:
object:Start()Return value:
Nothing - WidgetIcon:Stop ()
-
Stop a LibScriptableWidgetIcon
Usage:
object:Stop()Return value:
Nothing - WidgetIcon:Update ()
-
Update icon data. This will usually just increment the icon face.
Usage:
:Update()Return value:
Nothing