GuiComboBoxSetSelected

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function sets the selected item from a combobox.

Syntax

bool guiComboBoxSetSelected ( element comboBox, int itemIndex )

Required Arguments

  • comboBox: the combobox you want to select an item from
  • itemIndex: the item you want to select (item 0 is the first item). If -1 is specified, then the combo box text is set to it's caption.

Returns

Returns true if the selected item has been changed successfully, false otherwise.

Example

This example creates a GUI window with a checked and an unchecked combo box and adds a command to toggle their visibility

function drawGUI()
	guiWindow = guiCreateWindow(100,100,200,100,"ComboBox test area",false,false) -- create the container window
	local selectedBox = guiCreateComboBox(20,30,150,20,"Checked ComboBox",false,guiWindow) -- note the parameter after header, it will make the ComboBox be checked
        guiComboBoxSetSelected(selectedBox,true)
	local unselectedBox = guiCreateComboBox(20,60,150,20,"Unchecked ComboBox",false,guiWindow) -- not here though
	guiSetVisible(guiWindow,false) -- set it invisible just in case
end
addCommandHandler("combobox",function()
	if not guiWindow then -- if it hasn't been declared yet
		drawGUI() -- we draw the gui window
		guiSetVisible(guiWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper guiSetVisible, but this is needed if you want to cache a window without actually showing it
	else -- if we actually have run this function before and declared guiWindow
		guiSetVisible(guiWindow, not guiGetVisible(guiWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it	
	end
	showCursor(not isCursorShowing()) -- similar to above visibility
end)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows