API Functions/Widget

Function
WIDGET:AddOption(name, [value, selected, fg-color, bg-color]) = idx
WIDGET:AddOption(name, [value], [fgcolor], [bgcolor]) = idx
WIDGET:BindEvent(event_name, function_name)
WIDGET:ClearOptions()
WIDGET:EatMice(eat)
WIDGET:FinishMove()
WIDGET:FinishParam(name)
WIDGET:GetBounds(unscaled=true) = {left, top, right, bottom, [[WIDth, height}
WIDGET:GetCaption() = success
WIDGET:GetCheck() = check
WIDGET:GetChild(name or index) = child
WIDGET:GetChildCount() = count
WIDGET:GetChildIndex() = idx
WIDGET:GetClipChildren() = bool
WIDGET:GetDims([final]) = dims
WIDGET:GetDropInfo() = data, type
WIDGET:GetFosterParent() = fosterParent
WIDGET:GetFrame() = frame
WIDGET:GetId() = id
WIDGET:GetInfo() = id, name, type
WIDGET:GetInitialDims() = dims
WIDGET:GetName() = name
WIDGET:GetParam(name) = value
WIDGET:GetParent() = parent
WIDGET:GetPath() = [[WIDget_ref_path
WIDGET:GetTag() = tag
WIDGET:GetText() = text
WIDGET:GetType() = id
WIDGET:HasFocus() = bool
WIDGET:Hide([invis])
WIDGET:IsMouseEater() = bool
WIDGET:IsSelected(index) = success
WIDGET:IsVisible() = vis
WIDGET:MoveTo(dim_string, duration_s [, delay_s , smooth_type, finish?])
WIDGET:ParamTo(name, value, duration, [delay, smooth_type, finish?])
WIDGET:Query() = text, value, idx
WIDGET:QueueMove(dim_string, duration_s [, delay_s , smooth_type, finish?])
WIDGET:QueueParam(name, value, duration, [delay, smooth_type, finish?])
WIDGET:ReleaseFocus() = success
WIDGET:RemoveOption(value)
WIDGET:Select(index, selected[, fireChange]) = success
WIDGET:Select(index[, fireChange]) = success
WIDGET:SetAcceptType(string)
WIDGET:SetCaption(caption) = success
WIDGET:SetCheck(checked)
WIDGET:SetClipChildren(bool)
WIDGET:SetDims(dims ]](string or table))
WIDGET:SetFocus() = success
WIDGET:SetOption(index, name, [value, fg-color, bg-color) = success
WIDGET:SetParam(name, value)
WIDGET:SetTag(tag)
WIDGET:SetText(text)
WIDGET:SetTextColor(fg [, bg, start_pos, end_pos])
WIDGET:SetUnderline(bool)
WIDGET:Show([vis])
WIDGET:ParamTo(name, value, time, [delay, smooth_type ("smooth", "linear", "ease-in", or "ease-out"), finish?])
delay is the delay time before the change starts, smooth_type is the type of smoothing (i.e. smooth has acceleration in and acceleration out), no idea for finish
edge_in starts smooth, ends linear; edge_out starts linear, ends smooth
WIDGET:CycleParam((name, value, cycle_time, [delay, smooth_type ("smooth", "linear", "edge_in", or "edge_out"), finish?]))
same as paramTo, but keeps cycling to and from the new and old values.
Category:Addon_API