GuiGridListSetSortingEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP syntax)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Client function}}
__NOTOC__  
__NOTOC__  
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 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.
Line 5: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiGridListSetSortingEnabled ( element guiGridlist, bool enabled )
bool guiGridListSetSortingEnabled ( element guiGridlist, bool enabled )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:setSortingEnabled|sortingEnabled}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 17:


==Example==  
==Example==  
This page lacks an example
 
'''Example 1:''' This example creates a gridlist, fills it with players connected to the server and disables the sorting for that gridlist
 
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--add an example here.
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
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
[[Category:Needs_Example]]
{{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"