GuiComboBoxGetSelected: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added example)
(Added OOP Syntax)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int guiComboBoxGetSelected ( element comboBox )
int guiComboBoxGetSelected ( element comboBox )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Combobox|GuiComboBox]]:getSelected|selected|guiComboBoxSetSelected}}


===Required Arguments===  
===Required Arguments===  

Revision as of 23:03, 29 December 2015

This function returns the index of the selected combobox item.

Syntax

int guiComboBoxGetSelected ( element comboBox )

OOP Syntax Help! I don't understand this!

Method: GuiComboBox:getSelected(...)
Variable: .selected
Counterpart: guiComboBoxSetSelected


Required Arguments

  • comboBox: the combobox you want to know the selected item index of

Returns

Returns the index of the selected item if the specified combobox is valid and has a selected item, -1 if no item is selected, false or nil otherwise.

Example

This example outputs selected item's text and ID to the chat. 

addCommandHandler("getSelected",
function (command)

local item = guiComboBoxGetSelected(comboBox)
local text = guiComboBoxGetItemText(comboBox, item)

outputChatBox("Currently selected item with ID: " .. tostring(item) .. " and with text: " .. text)

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

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiComboBoxGetSelected?oldid=46275"