GuiGridListGetSelectionMode

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function retrieves the current selection mode of a gui gridlist.

Syntax

int guiGridListGetSelectionMode ( gui-Element gridlist )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:getSelectionMode(...)
Variable: .selectionMode


Required Arguments

  • gridlist: The gridlist you want to get the selection mode of.

Returns

Returns the ID of the current gridlist's selection mode.

  • 0: Single row selection
  • 1: Multiple row selection
  • 2: Single cell selection
  • 3: Multiple cell selection
  • 4: Nominated(First) single column selection
  • 5: Nominated(First) multiple column selection
  • 6: Single column selection
  • 7: Multiple column selection
  • 8: Nominated(First) single row selection
  • 9: Nominated(First) multiple row selection

Example

This example creates a grid list and adds the command 'getmode' which will show the gridlist selection mode. 

function clientsideResourceStart ()
    --Create a gridlist
    myGridList = guiCreateGridList ( 0.35, 0.35, 0.4, 0.1, true ) 
    --Create a column for myGridList to add rows into
	columnA = guiGridListAddColumn ( myGridList, "columnA Title", 0.3 )
	columnB = guiGridListAddColumn ( myGridList, "columnA Title", 0.3 )
	columnC = guiGridListAddColumn ( myGridList, "columnA Title", 0.3 ) 
	--Create a row for columnA
	rowA = guiGridListAddRow ( myGridList )
	rowB = guiGridListAddRow ( myGridList )
	rowC = guiGridListAddRow ( myGridList )
        --Set the text of columnA, rowA to "Hello World!"
	guiGridListSetItemText ( myGridList, rowA, columnA, "rowA ColumnA", false, false )
	guiGridListSetItemText ( myGridList, rowB, columnA, "rowB ColumnA", false, false )
	guiGridListSetItemText ( myGridList, rowC, columnA, "rowC ColumnA", false, false )
	guiGridListSetItemText ( myGridList, rowA, columnB, "rowA ColumnB", false, false )
	guiGridListSetItemText ( myGridList, rowB, columnB, "rowB ColumnB", false, false )
	guiGridListSetItemText ( myGridList, rowC, columnB, "rowC ColumnB", false, false )
	guiGridListSetItemText ( myGridList, rowA, columnC, "rowA ColumnC", false, false )
	guiGridListSetItemText ( myGridList, rowB, columnC, "rowB ColumnC", false, false )
	guiGridListSetItemText ( myGridList, rowC, columnC, "rowC ColumnC", false, false )
	showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )  

-- adds the command 'getmode' which will call the function 'getSelectionMode' when typed
function getSelectionMode ( commandName )

    local mode = guiGridListGetSelectionMode( myGridList ) -- get the selection mode from 'myGridList'
    outputChatBox ( "The current gridlist selection mode is "..tostring(mode), 230, 230, 230 ) -- shows in the chatbox the selection mode
end
addCommandHandler ( "getmode", getSelectionMode )

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/GuiGridListGetSelectionMode?oldid=63109"