GuiGridListClear: 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 clears out all the data from a GUI grid list element
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">
bool guiGridListClear ( element gridList )
bool guiGridListClear ( element gridList )
Line 10: Line 8:


===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 element to be cleared
*'''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 ''true'' if the grid list element is valid and it has been cleared successfully, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a grid list, puts a "Hello world" text in and clears it in 5 seconds
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 test ()
blabhalbalhb --abababa
--Create the grid list element
--This line does this...
local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )
mooo
--Create a column in the list and add a row with "Hello world" text
local column = guiGridListAddColumn( testList, "test", 0.85 )
guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
--Set a timer to clear the grid list in 5 seconds
setTimer ( guiGridListClear, 5000, 1, testList )
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 19:59, 30 July 2007

This function clears out all the data from a GUI grid list element

Syntax

bool guiGridListClear ( element gridList )

Required Arguments

  • gridList: The grid list element to be cleared

Returns

Returns true if the grid list element is valid and it has been cleared successfully, false otherwise.

Example

This example creates a grid list, puts a "Hello world" text in and clears it in 5 seconds 

function test ()
	--Create the grid list element
	local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )
	--Create a column in the list and add a row with "Hello world" text
	local column = guiGridListAddColumn( testList, "test", 0.85 )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
	--Set a timer to clear the grid list in 5 seconds
	setTimer ( guiGridListClear, 5000, 1, testList )
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/GuiGridListClear?oldid=9452"