GuiGridListAddRow: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Cleaned up example)
 
(18 intermediate revisions by 13 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
{{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===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''gridList:''' The grid list you want to add a row to
*'''argumentName:''' description


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
===Optional Arguments===  
{{New feature/item|3.0153|1.5.3||
{{OptionalArg}}
*'''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).
*'''argumentName2:''' description
*'''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).
*'''argumentName3:''' description
*'''...:''' Item text for any other columns
}}


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns the row id if it has been created, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
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 does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
blabhalbalhb --abababa
guiGridListAddColumn(playerList, "Player", 0.85)
--This line does this...
 
mooo
for _, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, getPlayerName(player))
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI functions}}
{{GUI functions}}
[[Category:Incomplete]]
{{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"