NComboBox

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

SetButtonBrush

NComboBox:SetButtonBrush(NormalBrush, HoveredBrush, PressedBrush)

Type	Parameter	Description
Brush	NormalBrush
Brush	HoveredBrush
Brush	PressedBrush

SetArrowBrush

NComboBox:SetArrowBrush(Brush)

Type	Parameter	Description
Brush	Brush

SetItemBrush

NComboBox:SetItemBrush(SelectorFocusedBrush, ActiveHoveredBrush, ActiveBrush, InactiveHoveredBrush, InactiveBrush)

Type	Parameter	Description
Brush	SelectorFocusedBrush
Brush	ActiveHoveredBrush
Brush	ActiveBrush
Brush	InactiveHoveredBrush
Brush	InactiveBrush

SetItemRowBrush

NComboBox:SetItemRowBrush(EvenRowBackgroundBrush, EvenRowBackgroundHoveredBrush, OddRowBackgroundBrush, OddRowBackgroundHoveredBrush)

Type	Parameter	Description
Brush	EvenRowBackgroundBrush
Brush	EvenRowBackgroundHoveredBrush
Brush	OddRowBackgroundBrush
Brush	OddRowBackgroundHoveredBrush

SetTextColor

NComboBox:SetTextColor(Color)

Type	Parameter	Description
Color	Color

AddOption

NComboBox:AddOption(Name)

Type	Parameter	Description
string	Name

RemoveOption

NComboBox:RemoveOption(Name)

Type	Parameter	Description
string	Name

GetOption

— Returns string.

local ret = NCheckBox:GetOption(Index)

Type	Parameter	Description
number	Index

GetOptionIndex

— Returns number.

local ret = NCheckBox:GetOption(Name)

Type	Parameter	Description
string	Name

RefreshOptions

NComboBox:RefreshOptions()

ClearOptions

NComboBox:ClearOptions()

SetSelectedOption

NComboBox:SetSelectedOption(Name)

Type	Parameter	Description
string	Name

SetSelectedIndex

NComboBox:SetSelectedIndex(Index)

Type	Parameter	Description
number	Index

ClearSelection

NComboBox:ClearSelection()

GetSelectedOption

— Returns string.

local ret = NCheckBox:GetSelectedOption()

IsOpen

— Returns boolean.

local ret = NCheckBox:IsOpen()

🚀 Events

On Selection Changed

Triggered when a new item is selected in the combobox

NButton.OnSelectionChanged = function(sItem, SelectInfo)
    -- On Selection Changed was called
end)

On Opening

Triggered when the combobox is opening

NButton.OnOpening = function()
    -- On Opening was called
end)

On Generate Widget

Triggered when the widget is needed for the item

NButton.OnGenerateWidget = function()
    -- On Generate Widget was called
    return Widget
end)