WidgetIcon

Functions

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

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

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

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

<tr>
<td class="name" nowrap><a href="#WidgetIcon:SetupChars">WidgetIcon:SetupChars</a>&nbsp;()</td>
<td class="summary">Allocate space for this icon's special character </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetIcon:Start">WidgetIcon:Start</a>&nbsp;()</td>
<td class="summary">Start a LibScriptableWidgetIcon </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetIcon:Stop">WidgetIcon:Stop</a>&nbsp;()</td>
<td class="summary">Stop a LibScriptableWidgetIcon </td>
</tr>

<tr>
<td class="name" nowrap><a href="#WidgetIcon:Update">WidgetIcon:Update</a>&nbsp;()</td>
<td class="summary">Update icon data.</td>
</tr>

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:New (visitor, name, config, row, col, layer, errorLevel, callback, timer)

Create a new LibScriptableWidgetIcon object

Parameters

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

<li>
  name: A name for this widget
</li>

<li>
  config: This widget's settings
</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 widget
</li>

<li>
  callback: The draw function
</li>

<li>
  timer: An optional timer. This should have a :Start() and :Stop().
</li>

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

<li>
  rows: The new row height.
</li>

<li>
  cols: The new column width.
</li>

<li>
  old_rows: The old row height.
</li>

<li>
  old_cols: The new column width.
</li>

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