GuiGridListClear: 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__  
{{Client function}}
This function clears out all the data from a GUI grid list element
__NOTOC__
This function clears all the data from a grid list.


==Syntax==  
==Syntax==  
Line 11: Line 12:


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


==Example==  
==Example==  
This example creates a grid list, puts a "Hello world" text in and clears it in 5 seconds
This example creates a grid list, puts an item with the text "Hello world" in it and clears the grid list after 5 seconds.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function test ()
-- Create the grid list element
--Create the grid list element
local testList = guiCreateGridList ( 0.45, 0.45, 0.10, 0.10, true )
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
--Create a column in the list and add a row with "Hello world" text
local column = guiGridListAddColumn( testList, "test", 0.85 )
local column = guiGridListAddColumn( testList, "test", 0.85 )
guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
guiGridListSetItemText ( testList, guiGridListAddRow ( testList ), column, "Hello World", false, false )
-- Set a timer to clear the grid list in 5 seconds
--Set a timer to clear the grid list in 5 seconds
setTimer ( guiGridListClear, 5000, 1, testList )
setTimer ( guiGridListClear, 5000, 1, testList )
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}

Revision as of 15:13, 18 August 2007

This function clears all the data from a grid list.

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 has been cleared successfully, false otherwise.

Example

This example creates a grid list, puts an item with the text "Hello world" in it and clears the grid list after 5 seconds. 

-- 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 )

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=10657"