ui.ComboField¶

Overview¶

ui.Component -> ui.ComboField

These components allow users to select between various options, with support for filtering the displayed options based on text input, and triggering ONSELECTIONCHANGED events on selection.

Example¶

-- ComboField using explicit entry IDs
local c = ui.ComboField.new(parent)
c:SetSize(250, 50)
c.stylesheetID = combo_default
c:Add("Abcdef", 0);
c:Add("Alpha", 1);
c:Add("Beta", 2);
c:Add("Gamma", 3);
c:Add("Epsilon", 4);
c:Add("Vodka", 5);
c:Add("Lime", 6);
c:Add("Lemon", 7);
c:Subscribe(ui.Hook.ONSELECTIONCHANGED, function (comp, id, status) log("Changed selection for", id, "to", status) end)

-- And using the SetEntries API
local c = ui.ComboField.new(parent)
c:SetPos(0, 60)
c:SetSize(250, 50)
c.stylesheetID = combo_default
c:SetEntries({ "A", "B", "C", "D", "E", "F", "G" })
c:Subscribe(ui.Hook.ONSELECTIONCHANGED, function (comp, id, status) log("Changed selection for", id, "to", status) end)

Combo Entry¶

In most cases, entries must be modified through methods on the combofield itself, however you can also iterate through the combofield contents via the entries property, which returns a collection of entries. These are fairly limited and mostly provide an easy way to read the various properties for the various entries.

Methods¶

Constructor¶

function ui.ComboField.new(parent : ui.ComponentCollection, categoryID : Int?, dynamicID : Int?) -> Combo

Creates a new combofield on the specified parent.

Add¶

function ui.ComboField:Add(label : String, id : Int) -> Bool

Adds an entry to this combofield with the provided label and ID.

Remove¶

function ui.ComboField:Remove(id : Int) -> Bool

Removes the entry associated with this ID.

Clear¶

function ui.ComboField:Clear()

Removes all entries from this combo.

UnselectAll¶

function ui.ComboField:UnselectAll()

Clears the selection for this combofield.

Select¶

function ui.ComboField:Select(id : Int, triggerEvents : Bool?) -> Bool

Selects the entry associated with the provided ID, and optionally triggers the corresponding ONSELECTIONCHANGED events.

HasEntry¶

function ui.ComboField:HasEntry(id : Int) -> Bool

Returns whether or not there's an entry associated with the provided ID.

SetEntries¶

function ui.ComboField:SetEntries(entries : [String], selectedID : Int?) -> Bool
function ui.ComboField:SetEntries(entriesMap : { String -> Int }, selectedID : Int?) -> Bool

Clears existing entries from the combofield and adds all entries in the provided container to the combo, optionally selecting the one with the provided ID.

Properties¶

Custom Visuals¶

Using custom or plugin-provided sprites is supported, however the provided sprites used for the header and button must represent a spritesheet containing all of the potential states in a vertical layout using the following order - default, mouseover, dropdown open, disabled.