🔽 ComboBox

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

This class shares methods and events from Base Widget.

🦠 Functions

SetStyleSheet

MyComboBox:SetStyleSheet(ComboBoxStyle)

Type	Parameter	Description
ComboBoxStyle	ComboBoxStyle

GetStyleSheet

— Returns ComboBoxStyle.

local ret = MyComboBox:GetStyleSheet()

SetText

MyComboBox:SetText(Text)

Type	Parameter	Description
string	Text

SetCustomMenu

MyComboBox:SetCustomMenu(Widget)

Type	Parameter	Description
BaseWidget	Widget

GetCustomMenu

— Returns BaseWidget.

local ret = MyComboBox:GetCustomMenu()

---

AddOption

MyComboBox:AddOption(Option)

Type	Parameter	Description
string	Option

RemoveOption

MyComboBox:RemoveOption(Option)

Type	Parameter	Description
string	Option

SetOptions

MyComboBox:SetOptions(Options)

Type	Parameter	Description
table<integer, string>	Options

GetOptions

— Returns table<integer, string>.

local ret = MyComboBox:GetOptions()

---

RefreshOptions

MyComboBox:RefreshOptions()

---

AddSelectedOption

MyComboBox:AddSelectedOption(Option)

Type	Parameter	Description
string	Option

RemoveSelectedOption

MyComboBox:RemoveSelectedOption(Option)

Type	Parameter	Description
string	Option

GetSelectedOptions

— Returns table<integer, string>.

local ret = MyComboBox:GetSelectedOptions()

---

SetMultiSelect

MyComboBox:SetMultiSelect(MultiSelect)

Type	Parameter	Description
boolean	MultiSelect

GetMultiSelect

— Returns boolean.

local ret = MyComboBox:GetMultiSelect()

---

SetFont

MyComboBox:SetFont(FontName?, Typeface?, FontSize?)

Type	Parameter	Description
string	FontName?
string	Typeface?
integer	FontSize?

GetFont

— Returns table.

local ret = MyComboBox:GetFont()

---

SetTextColor

MyComboBox:SetTextColor(Color)

Type	Parameter	Description
Color	Color

🚀 Events

On Menu Refresh

Triggered when the menu needs to refresh.

MyComboBox:BindDispatcher("OnMenuRefresh", function()
    -- On Menu Refresh was called
end)

---

On Selection Changed

Triggered when the selection changed

MyComboBox:BindDispatcher("OnSelectionChanged", function(self, SelectedOption)
    -- On Selection Changed was called
end)

Type	Parameter	Description
string	SelectedOption