API Reference

LibQTipClick-1.1

LibQTipClick-1.1 acts as an extension of LibQTip-1.0 and as such uses its API in addition to its own unique functionality.

:OnEnter(event, cell, arg)

Explicitly runs the default OnEnter handler on the cell. This is used when the default OnEnter has been replaced and you wish to also support the default behavior.

Arguments

event
string - The event which called the handler.
cell
Frame - Cell Frame passed to the OnEnter callback handler.
arg
variable - Argument passed to the handler.

:OnLeave(event, cell, arg)

Explicitly runs the default OnLeave handler on the cell. This is used when the default OnLeave has been replaced and you wish to also support the default behavior.

Arguments

event
string - The event which called the handler.
cell
Frame - Cell Frame passed to the OnEnter callback handler.
arg
variable - Argument passed to the handler.

:OnMouseDown(event, cell, arg, button)

Explicitly runs the default OnMouseDown handler on the cell. This is used when the default OnMouseDown has been replaced and you wish to also support the default behavior.

Arguments

event
string - The event which called the handler.
cell
Frame - Cell Frame passed to the OnEnter callback handler.
arg
variable - Argument passed to the handler.
button
string - Value passed to handler which indicates which mouse button was pressed.

.LabelProvider

.LabelProvider is a built-in CellProvider used by default to create the tooltip cells.

Tooltip

Each tooltip is a proper Frame instance with all Frame methods, the methods supplied by LibQTip-1.0, and the following methods:

:SetCallback(event, callback)

Designates the callback function to be used by the specified tooltip when the appointed event occurs.

Arguments

event
string - event to which the callback responds. Valid events are "OnMouseDown", "OnEnter", and "OnLeave"
callback
function - handler function for the event.

:AddNormalLine([column1Value, column2Value, ...])

Add a new line at the bottom of the tooltip. As the name implies, this is a "normal" line which is not mouse-aware and is functionally equivalent to LibQTip-1.0's tooltip:AddLine().

:AddNormalHeader([col1Value, col2Value, ...])

Add a new header line at the bottom of the tooltip. Works as AddNormalLine but using the header font. Functionally equivalent to LibQTip-1.0's tooltip:AddHeader().

:SetNormalCell(lineNum, colNum, value[, font][, justification][, colSpan][, provider, ...])

Add or replace a cell at the given line and column indexes. The additional arguments override the tooltip defaults. Functionally equivalent to LibQTip-1.0's tooltip:SetCell()


Comments

Posts Quoted:
Reply
Clear All Quotes