GuiGridListClear: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax)
(6 intermediate revisions by 5 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 function clears all the data from a grid list.


==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 )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:clear}}


===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 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 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds.
This example does...
<syntaxhighlight lang="lua">function clientsideResourceStart ()
<!-- 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 -->
        -- Create the grid list element
<syntaxhighlight lang="lua">
local testList = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )
--This line does...
        -- Create a column in the list and add 2 rows displaying "Hello" text and "world" text
blabhalbalhb --abababa
local column = guiGridListAddColumn( testList, "test", 0.85 )
--This line does this...
guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello", false, false )
mooo
guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )
</syntaxhighlight>
        -- Set a timer to call the guiGridListClear function to clear the grid list items in 5 seconds
setTimer ( guiGridListClear, 5000, 1, testList )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )</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]]
{{GUI_events}}

Revision as of 21:08, 7 November 2018

This function clears all the data from a grid list.

Syntax

bool guiGridListClear ( element gridList )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:clear(...)


Required Arguments

  • gridList: The grid list element to be cleared

Returns

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

Example

This example creates a grid list, puts 2 items in to display the text "Hello" and "world" and clears the grid list after 5 seconds. 

function clientsideResourceStart ()
        -- Create the grid list element
	local testList = guiCreateGridList ( 0.45, 0.45, 0.15, 0.15, true ) 
        -- Create a column in the list and add 2 rows displaying "Hello" text and "world" text
	local column = guiGridListAddColumn( testList, "test", 0.85 ) 
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello", false, false )
	guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "World", false, false )
        -- Set a timer to call the guiGridListClear function to clear the grid list items in 5 seconds
	setTimer ( guiGridListClear, 5000, 1, testList ) 
end
addEventHandler ( "onClientResourceStart", resourceRoot, 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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListClear?oldid=60506"