GuiGridListInsertRowAfter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Fix incorrect return.)
 
(14 intermediate revisions by 12 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
This allows you to insert a new row after a specified row, and simultaneously set text. Good for inserting new rows in the middle of existing rows. To insert at the top use -1 as row index.


==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 -->
<!-- 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
returnType functionName ( arguments )
int guiGridListInsertRowAfter ( element gridList, int rowIndex )
</syntaxhighlight>  
</syntaxhighlight>  
{{New feature/item|3.0153|1.5.3||
<syntaxhighlight lang="lua">
int guiGridListInsertRowAfter ( element gridList [, int rowIndex, int/string itemText1, int/string itemText2, ... ] )
</syntaxhighlight>
}}
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:insertRowAfter}}


===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
*'''rowIndex:''' Row ID of the row you want to insert the '''new row''' after.


<!-- 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 ''row id'' if the row was successfully added, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example would create a gridlist then add the current players in the server and if anyone joins, it would insert a row at the bottom.
This example does...
<syntaxhighlight lang="lua">gridlist = guiCreateGridList(100,100,200,100,false)
<!-- 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 -->
guiGridListAddColumn(gridlist,"Players",0.50)
<syntaxhighlight lang="lua">
for i,v in ipairs(getElementsByType("player"))do
--This line does...
guiGridListSetItemText(gridlist,guiGridListAddRow(gridlist),1,getPlayerName(v),false,false)
blabhalbalhb --abababa
end
--This line does this...
addEventHandler("onClientPlayerJoin",root,function()
mooo
guiGridListSetItemText(gridlist,guiGridListInsertRowAfter(gridlist,guiGridListGetRowCount(gridlist)),1,getPlayerName(source),false,false)--Add row at the bottom of the gridlist and name it the players name
end)
</syntaxhighlight>
</syntaxhighlight>


Line 37: Line 45:
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- 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 06:27, 16 January 2023

This allows you to insert a new row after a specified row, and simultaneously set text. Good for inserting new rows in the middle of existing rows. To insert at the top use -1 as row index.

Syntax

int guiGridListInsertRowAfter ( element gridList, int rowIndex )

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

OOP Syntax Help! I don't understand this!

Method: GuiGridList:insertRowAfter(...)


Required Arguments

  • gridList: The grid list you want to add a row to
  • rowIndex: Row ID of the row you want to insert the new row after.

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 row id if the row was successfully added, false otherwise.

Example

This example would create a gridlist then add the current players in the server and if anyone joins, it would insert a row at the bottom. 

gridlist = guiCreateGridList(100,100,200,100,false)
guiGridListAddColumn(gridlist,"Players",0.50)
for i,v in ipairs(getElementsByType("player"))do
	guiGridListSetItemText(gridlist,guiGridListAddRow(gridlist),1,getPlayerName(v),false,false)
end
addEventHandler("onClientPlayerJoin",root,function()
	guiGridListSetItemText(gridlist,guiGridListInsertRowAfter(gridlist,guiGridListGetRowCount(gridlist)),1,getPlayerName(source),false,false)--Add row at the bottom of the gridlist and name it the players name
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/GuiGridListInsertRowAfter?oldid=76028"