GuiGridListAddRow: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 36379 by Et-win (talk))
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
Adds a row to a grid list.
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.  
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]].  
Look at the example, first you give the row a name with '''[[row =]]''' guiGridListAddRow ( playerList ), and then you use [[guiGridListSetItemText]]. }}


==Syntax==  
==Syntax==  
Line 10: Line 11:
int guiGridListAddRow ( element gridList )
int guiGridListAddRow ( element gridList )
</syntaxhighlight>  
</syntaxhighlight>  
{{New feature/item|3.0153|1.5.3||
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList, int/string itemText1, int/string itemText2, ... )
</syntaxhighlight>
}}


===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===

Revision as of 12:18, 3 July 2016

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 guiGridListAddRow ( element gridList, int/string itemText1, int/string itemText2, ... )

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.

function clientsideResourceStart ()
        local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
        local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
        if ( column ) then -- If the column was successfully created
                for id, playeritem in ipairs(getElementsByType("player")) do 
                --Loop through all the players, adding them to the table
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
        end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )

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