GuiGridListGetItemText: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function | This function retrieves the text from a specific grid list item. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theElement:''' the gridlist you | *'''theElement:''' the gridlist containing the item you're interested in | ||
*'''rowIndex:''' row id | *'''rowIndex:''' row id of the item | ||
*'''columnIndex:''' column id | *'''columnIndex:''' column id of the item | ||
===Returns=== | ===Returns=== | ||
Returns | Returns the text of the item if the arguments are right, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example creates a player list on resource start, clicking on it will output the selected player name to chatbox | This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local playerList | |||
function createPlayerList () | function createPlayerList () | ||
--Create the grid list | -- Create the grid list | ||
playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) | playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) | ||
--Create a players column in the list | -- Create a players column in the list | ||
local column = guiGridListAddColumn( playerList, "Player", 0.85 ) | local column = guiGridListAddColumn( playerList, "Player", 0.85 ) | ||
if ( column ) then --If the column has been created, fill it with players | if ( column ) then -- If the column has been created, fill it with players | ||
for id, | for id, playeritem in ipairs(getElementsByType("player")) do | ||
local row = guiGridListAddRow ( playerList ) | local row = guiGridListAddRow ( playerList ) | ||
guiGridListSetItemText ( playerList, row, column, getPlayerName ( | guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false ) | ||
end | end | ||
addEventHandler ( "onClientClick", | addEventHandler ( "onClientClick", playerList, click ) | ||
end | end | ||
end | end | ||
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList ) | addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList ) | ||
function click ( button, state, sx, sy, x, y, z, | |||
-- if state is down ( not to trigger the function twice on | function click ( button, state, sx, sy, x, y, z, elem, gui ) | ||
-- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list | |||
if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then | if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then | ||
-- | -- get the player name from the selected row, first column | ||
local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 ) | local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 ) | ||
outputChatBox ( playerName ) --output it to chat box | outputChatBox ( playerName ) -- output it to chat box | ||
end | end | ||
end | end | ||
Revision as of 16:14, 18 August 2007
This function retrieves the text from a specific grid list item.
Syntax
string guiGridListGetItemText ( element theElement, int rowIndex, int columnIndex )
Required Arguments
- theElement: the gridlist containing the item you're interested in
- rowIndex: row id of the item
- columnIndex: column id of the item
Returns
Returns the text of the item if the arguments are right, false otherwise.
Example
This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.
local playerList
function createPlayerList ()
-- Create the grid list
playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
-- Create a players column in the list
local column = guiGridListAddColumn( playerList, "Player", 0.85 )
if ( column ) then -- If the column has been created, fill it with players
for id, playeritem in ipairs(getElementsByType("player")) do
local row = guiGridListAddRow ( playerList )
guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
end
addEventHandler ( "onClientClick", playerList, click )
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )
function click ( button, state, sx, sy, x, y, z, elem, gui )
-- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
-- get the player name from the selected row, first column
local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
outputChatBox ( playerName ) -- output it to chat box
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