GuiGridListAddRow: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Cleaned up example)
 
(16 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function is used to add rows to grid lists.
Adds a row to a grid list, and optionally add simple text items with your rows.  Use [[guiGridListSetItemText]] to add row headers.
 
{{Deprecated feature|3.0153|1.5.2|
ATTENTION: Without [[guiGridListSetItemText]] there is no row added to the grid.  
Look at the example, first you give the row a name with '''[[row =]]''' guiGridListAddRow ( playerList ), and then you use [[guiGridListSetItemText]]. }}


==Syntax==  
==Syntax==  
{{New feature/item|3.0153|1.5.3||
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList )
int guiGridListAddRow ( element gridList [, int/string itemText1, int/string itemText2, ... ] )
</syntaxhighlight>  
</syntaxhighlight>
}}
 
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:addRow}}


===Required Arguments===  
===Required Arguments===  
*'''gridList:''' The grid list you want to add a row to
*'''gridList:''' The grid list you want to add a row to
===Optional Arguments===
{{New feature/item|3.0153|1.5.3||
*'''itemText1:''' The text for the first column item in the row.  Either a string or a number can be passed (use numbers for sorting purposes).
*'''itemText2:''' The text for the second column item in the row.  Either a string or a number can be passed (use numbers for sorting purposes).
*'''...:''' Item text for any other columns
}}


===Returns===
===Returns===
Line 17: Line 32:
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function createPlayerList ()
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
-- Create the grid list
guiGridListAddColumn(playerList, "Player", 0.85)
local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
 
-- Create a 'players' column in the list
for _, player in ipairs(getElementsByType("player")) do
local column = guiGridListAddColumn( playerList, "Player", 0.85 )
guiGridListAddRow(playerList, getPlayerName(player))
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
end
end
end
</syntaxhighlight>
</syntaxhighlight>
Line 33: Line 42:
==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 22:01, 1 September 2018

Adds a row to a grid list, and optionally add simple text items with your rows. Use guiGridListSetItemText to add row headers.

Syntax

int guiGridListAddRow ( element gridList [, int/string itemText1, int/string itemText2, ... ] )


OOP Syntax Help! I don't understand this!

Method: GuiGridList:addRow(...)


Required Arguments

  • gridList: The grid list you want to add a row to

Optional Arguments

  • itemText1: The text for the first column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
  • itemText2: The text for the second column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
  • ...: Item text for any other columns

Returns

Returns the row id if it has been created, false otherwise.

Example

This example creates a player list on the right side of the screen and fills it with the names of the connected players. 

local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "Player", 0.85)

for _, player in ipairs(getElementsByType("player")) do
	guiGridListAddRow(playerList, getPlayerName(player))
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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListAddRow?oldid=58790"