GuiGridListSetSortingEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(OOP syntax)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Client function}}
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function allows the disabling or enabling of ''sorting'' within a gridlist.  Sorting is achieved by clicking a column header.  Gridlist items will be sorted according to the clicked column. By default, gridlists have sorting enabled.  This function will allow you to toggle this.
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 )
bool guiGridListSetSortingEnabled ( element guiGridlist, bool enabled )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:setSortingEnabled|sortingEnabled}}


===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 -->
*'''guiGridlist:''' The GUI gridlist you wish to toggle the sorting of.
*'''argumentName:''' description
*'''enabled:''' A boolean representing whether the sorting is enabled, or disabled.
 
<!-- 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 sorting was successfully toggled., ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
 
This example does...
'''Example 1:''' This example creates a gridlist, fills it with players connected to the server and disables the sorting for that gridlist
<!-- 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 createGridList ()
blabhalbalhb --abababa
--Create the grid list element
--This line does this...
local newGridlist = guiCreateGridList ( 0.50, 0.50, 0.20, 0.30, true )
mooo
--Create a new grid list
        local column = guiGridListAddColumn( newGridlist, "Players", 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 ( newGridlist )
guiGridListSetItemText ( newGridlist, row, column, getPlayerName ( player ), false, false )
end
end
guiGridListSetSortingEnabled ( newGridlist, false )
        --Disable sorting for the gridlist
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]]
{{GUI_events}}

Latest revision as of 21:21, 7 November 2018

This function allows the disabling or enabling of sorting within a gridlist. Sorting is achieved by clicking a column header. Gridlist items will be sorted according to the clicked column. By default, gridlists have sorting enabled. This function will allow you to toggle this.

Syntax

bool guiGridListSetSortingEnabled ( element guiGridlist, bool enabled )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:setSortingEnabled(...)
Variable: .sortingEnabled


Required Arguments

  • guiGridlist: The GUI gridlist you wish to toggle the sorting of.
  • enabled: A boolean representing whether the sorting is enabled, or disabled.

Returns

Returns true if sorting was successfully toggled., false otherwise.

Example

Example 1: This example creates a gridlist, fills it with players connected to the server and disables the sorting for that gridlist 

function createGridList ()
	--Create the grid list element
	local newGridlist = guiCreateGridList ( 0.50, 0.50, 0.20, 0.30, true )
	--Create a new grid list
        local column = guiGridListAddColumn( newGridlist, "Players", 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 ( newGridlist )
			guiGridListSetItemText ( newGridlist, row, column, getPlayerName ( player ), false, false )
		end
	end
	guiGridListSetSortingEnabled ( newGridlist, false )
        --Disable sorting for the gridlist
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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListSetSortingEnabled?oldid=60532"