File ../../LibScriptableWidgets-1.0/LibScriptableWidgetBar-1.0/LibScriptableWidgetBar-1.0.lua

Functions

Draw() () Draw the widget.
WidgetBar:Del () Delete a LibScriptableWidgetBar object
WidgetBar:GetOptions (db, callback, data) Get an Ace3 option table.
WidgetBar:IntersectUpdate (frame) Check for frames intersecting the mouse's focus
WidgetBar:New (visitor, name, config, row, col, layer, errorLevel, callback) Create a new LibScriptableWidgetBar object
WidgetBar:Resize (rows, cols, old_rows, old_cols) Resize the widget.
WidgetBar:Start (unit) Start the widget's timer
WidgetBar:Stop () Stop the widget's timer
WidgetBar:Update () Update the widget


Functions

Draw() ()
Draw the widget. This just calls the real draw function you provided.

Usage:

object:Draw()

Return value:

Nothing
WidgetBar:Del ()
Delete a LibScriptableWidgetBar object

Usage:

object:Del()

Return value:

Nothing
WidgetBar: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

Return value:

An Ace3 options table: `name.args = options`.
WidgetBar:IntersectUpdate (frame)
Check for frames intersecting the mouse's focus

Parameters

  • frame: An optional Frame object.

Usage:

object:IntersectUpdate(bars)

Return value:

Nothing [[
WidgetBar:New (visitor, name, config, row, col, layer, errorLevel, callback)
Create a new LibScriptableWidgetBar object

Parameters

  • visitor: An LibScriptableCore-1.0 object, or provide your own
  • name:
  • config: This widget's parameters
  • row: This widget's row
  • col: This widget's column
  • layer: This widget's layer
  • errorLevel: The errorLevel for this object
  • callback: This widget's real draw function

Usage:

WidgetBar:New(visitor, name, config, row, col, layer, errorLevel, callback, data)

Return value:

A new LibScriptableWidgetBar object
WidgetBar:Resize (rows, cols, old_rows, old_cols)
Resize the widget. Note that this simply repositions this widget on your surface.

Parameters

  • rows: The new row size
  • cols: The new column size
  • old_rows: The old rows size
  • old_cols: The old cols size

Return value:

Nothing
WidgetBar:Start (unit)
Start the widget's timer

Parameters

  • unit:

Usage:

object:Start()

Return value:

Nothing
WidgetBar:Stop ()
Stop the widget's timer

Usage:

object:Stop()

Return value:

Nothing
WidgetBar:Update ()
Update the widget

Usage:

object:Update()

Return value:

Nothing

Valid XHTML 1.0!