GuiGridListGetRowCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function returns the number of rows in a GUI grid list
This fake function is for use with blah & blah and does blahblahblabhalbhl


==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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
returnType functionName ( arguments )
int guiGridListGetRowCount ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  


===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 -->
*'''theElement:''' GUI grid list element pointer
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===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 an ''int'' - the number of rows if function is successfull, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a gui grid list, fills it with server players and returns the number of rows (players) eventually
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...
function createPlayerList ()
blabhalbalhb --abababa
        --Create the grid list element
--This line does this...
        local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
mooo
        --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, player in ipairs(getElementsByType("player")) do
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )
                end
                outputChatBox ( "Number of player list rows: "..guiGridListGetRowCount ( playerList ) )
        end
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]]

Revision as of 18:00, 7 August 2007

This function returns the number of rows in a GUI grid list

Syntax

int guiGridListGetRowCount ( element theElement )

Required Arguments

  • theElement: GUI grid list element pointer

Returns

Returns an int - the number of rows if function is successfull, false otherwise.

Example

This example creates a gui grid list, fills it with server players and returns the number of rows (players) eventually 

function createPlayerList ()
        --Create the grid list element
        local 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, player in ipairs(getElementsByType("player")) do
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( player ), false, false )
                end
                outputChatBox ( "Number of player list rows: "..guiGridListGetRowCount ( playerList ) )
        end
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

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListGetRowCount?oldid=9962"