api/lib-scriptable-widgets-1-0/LibScriptableWidgetBar-1.0

Draw()()

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

Return value

Nothing

Usage

object:Draw()


WidgetBar.IntersectUpdate(bars)

Check for frames intersecting the mouse's focus

Parameters

bars
A list of WidgetBar objects

Return value

Nothing

Usage

object:IntersectUpdate(bars)


WidgetBar:Del()

Delete a LibScriptableWidgetBar object

Return value

Nothing

Usage

object:Del()


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

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
data
Some data to pass back through the draw function

Return value

A new LibScriptableWidgetBar object

Usage

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


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()

Start the widget's timer

Return value

Nothing

Usage

object:Start()


WidgetBar:Stop()

Stop the widget's timer

Return value

Nothing

Usage

object:Stop()


WidgetBar:Update()

Update the widget

Return value

Nothing

Usage

object:Update()



Comments

Posts Quoted:
Reply
Clear All Quotes