GuiGridListGetSelectedItem: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Changed syntax) |
||
(8 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{{Client function}} | {{Client function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function returns the row and column indexes of the selected item in a grid list. First selected row and column is (0, 0). | |||
This function returns the row | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int guiGridListGetSelectedItem ( element gridList ) | int, int guiGridListGetSelectedItem ( element gridList ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getSelectedItem}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
Line 14: | Line 13: | ||
===Returns=== | ===Returns=== | ||
Returns the row | Returns the row and column indexes of the selected item if the specified grid list is valid and has a selected item, (-1, -1) if no item is selected, ''false'' otherwise. | ||
==Example== | ==Example== | ||
<section class="client" name="Client" show="true"> | |||
This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box. | This code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | addEventHandler('onClientResourceStart', resourceRoot, function() | ||
local playerList = guiCreateGridList(0.8, 0.1, 0.15, 0.6, true) | |||
-- Create a players column in the list | |||
local column = guiGridListAddColumn(playerList, 'Player', 0.85) | |||
-- If the column has been created, fill it with players | |||
if not column then return end | |||
for id, playeritem in ipairs(getElementsByType('player')) do | |||
local row = guiGridListAddRow ( playerList ) | |||
guiGridListSetItemText(playerList, row, column, getPlayerName(playeritem), false, false) | |||
end | |||
addEventHandler('onClientGUIClick', playerList, function() | |||
local row, column = guiGridListGetSelectedItem(playerList) | |||
outputChatBox(guiGridListGetItemText(playerList, row, column)) | |||
end) | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{GUI functions}} | {{GUI functions}} | ||
{{GUI_events}} |
Latest revision as of 19:05, 19 June 2024
This function returns the row and column indexes of the selected item in a grid list. First selected row and column is (0, 0).
Syntax
int, int guiGridListGetSelectedItem ( element gridList )
OOP Syntax Help! I don't understand this!
- Method: GuiGridList:getSelectedItem(...)
Required Arguments
- gridList: the grid list you want to know the selected row index of
Returns
Returns the row and column indexes of the selected item if the specified grid list is valid and has a selected item, (-1, -1) if no item is selected, false otherwise.
Example
Click to collapse [-]
ClientThis code creates a grid list and fills it with the names of the connected players. When the user selects an item, its text (the player name) will be output in the chat box.
addEventHandler('onClientResourceStart', resourceRoot, function() local playerList = guiCreateGridList(0.8, 0.1, 0.15, 0.6, true) -- Create a players column in the list local column = guiGridListAddColumn(playerList, 'Player', 0.85) -- If the column has been created, fill it with players if not column then return end for id, playeritem in ipairs(getElementsByType('player')) do local row = guiGridListAddRow ( playerList ) guiGridListSetItemText(playerList, row, column, getPlayerName(playeritem), false, false) end addEventHandler('onClientGUIClick', playerList, function() local row, column = guiGridListGetSelectedItem(playerList) outputChatBox(guiGridListGetItemText(playerList, row, column)) end) end
See Also
General functions
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign
Windows
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel