GuiGridListGetItemText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
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 gets the text from a given grid list item row+column
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">
string guiGridListGetItemText ( element gridList, int rowIndex, int columnIndex )
string guiGridListGetItemText ( element theElement, int rowIndex, int columnIndex )
</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:''' the gridlist you want to get item text of
*'''argumentName:''' description
*'''rowIndex:''' row id
 
*'''columnIndex:''' column id
<!-- 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 ''string'' - the text in the item if the arguments are right, ''false'' if not.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a player list on resource start, clicking on it will output the selected player name to chatbox
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...
        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
                addEventHandler ( "onClientClick", getRootElement(), click )
        end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )
function click ( button, state, sx, sy, x, y, z, element, gui )
        -- if state is down ( not to trigger the function twice on click up/down), clicked gui and the element is our player list
        if ( ( state == "down ) and ( gui == true ) and ( source == playerList ) ) then
                -- we get the player name from the selected row, first column
                local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                outputChatBox ( playerName ) --output it to chat box
        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:07, 9 August 2007

This function gets the text from a given grid list item row+column

Syntax

string guiGridListGetItemText ( element theElement, int rowIndex, int columnIndex )

Required Arguments

  • theElement: the gridlist you want to get item text of
  • rowIndex: row id
  • columnIndex: column id

Returns

Returns string - the text in the item if the arguments are right, false if not.

Example

This example creates a player list on resource start, clicking on it will output the selected player name to chatbox 

function createPlayerList ()
        --Create the grid list element
        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
                addEventHandler ( "onClientClick", getRootElement(), click )
        end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )
function click ( button, state, sx, sy, x, y, z, element, gui )
        -- if state is down ( not to trigger the function twice on click up/down), clicked gui and the element is our player list
        if ( ( state == "down ) and ( gui == true ) and ( source == playerList ) ) then
                -- we get the player name from the selected row, first column 
                local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                outputChatBox ( playerName ) --output it to chat box
        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/GuiGridListGetItemText?oldid=10002"