WidgetBar

Functions

<tr>
<td class="name" nowrap><a href="#Draw()">Draw()</a>&nbsp;()</td>
<td class="summary">Draw the widget.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:Del">WidgetBar:Del</a>&nbsp;()</td>
<td class="summary">Delete a LibScriptableWidgetBar object </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:GetOptions">WidgetBar:GetOptions</a>&nbsp;(db, callback, data)</td>
<td class="summary">Get an Ace3 option table.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:IntersectUpdate">WidgetBar:IntersectUpdate</a>&nbsp;(frame)</td>
<td class="summary">Check for frames intersecting the mouse's focus </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:New">WidgetBar:New</a>&nbsp;(visitor, name, config, row, col, layer, errorLevel, callback)</td>
<td class="summary">Create a new LibScriptableWidgetBar object </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:Resize">WidgetBar:Resize</a>&nbsp;(rows, cols, old_rows, old_cols)</td>
<td class="summary">Resize the widget.</td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:Start">WidgetBar:Start</a>&nbsp;(unit)</td>
<td class="summary">Start the widget's timer </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:Stop">WidgetBar:Stop</a>&nbsp;()</td>
<td class="summary">Stop the widget's timer </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetBar:Update">WidgetBar:Update</a>&nbsp;()</td>
<td class="summary">Update the widget </td>
</tr>

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

<li>
  db: The database table
</li>

<li>
  callback: Provide this if you want to execute the callback once an option is changed
</li>

<li>
  data: Some data to pass when executing the callback
</li>

Return value:

An Ace3 options table: `name.args = options`.

WidgetBar:IntersectUpdate (frame)

Check for frames intersecting the mouse's focus

Parameters

<li>
  frame: An optional Frame object.
</li>

Usage:

object:IntersectUpdate(bars)

Return value:

Nothing [[

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

Create a new LibScriptableWidgetBar object

Parameters

<li>
  visitor: An LibScriptableCore-1.0 object, or provide your own
</li>

<li>
  name: 
</li>

<li>
  config: This widget's parameters
</li>

<li>
  row: This widget's row
</li>

<li>
  col: This widget's column
</li>

<li>
  layer: This widget's layer
</li>

<li>
  errorLevel: The errorLevel for this object
</li>

<li>
  callback: This widget's real draw function
</li>

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

<li>
  rows: The new row size
</li>

<li>
  cols: The new column size
</li>

<li>
  old_rows: The old rows size
</li>

<li>
  old_cols: The old cols size
</li>

Return value:

Nothing

WidgetBar:Start (unit)

Start the widget's timer

Parameters

<li>
  unit: 
</li>

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