GuiGridListSetSelectionMode: 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__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function sets the selection mode of a gui gridlist. For example, the MTA ''server browser'' selects a whole row, while the ''Controls'' dialog selects a single cell.
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 guiGridListSetSelectionMode ( guiElement gridlist, int mode )
</syntaxhighlight>  
</syntaxhighlight>  


===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 gridlist in which you wish to set the selection mode.
*'''argumentName:''' description
*'''mode:''' The mode of the selection.  Can be the following values:
 
**'''0:''' Single row selection
<!-- Only include this section below if there are optional arguments -->
**'''1:''' Multiple row selection
===Optional Arguments===
**'''2:''' Single cell selection
{{OptionalArg}}
**'''3:''' Multiple cell selection
*'''argumentName2:''' description
**'''4:''' Nominated(First) single column selection
*'''argumentName3:''' description
**'''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


===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 if the selection mode was successfully set, false otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This page lacks an example
This example does...
<!-- 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...
--add an example here
blabhalbalhb --abababa
--This line does this...
mooo
</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]]
[[Category:Needs_Example]]

Revision as of 22:12, 25 September 2007

This function sets the selection mode of a gui gridlist. For example, the MTA server browser selects a whole row, while the Controls dialog selects a single cell.

Syntax

bool guiGridListSetSelectionMode ( guiElement gridlist, int mode )

Required Arguments

  • gridlist: The gridlist in which you wish to set the selection mode.
  • mode: The mode of the selection. Can be the following values:
    • 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

Returns

Returns true if if the selection mode was successfully set, false otherwise.

Example

This page lacks an example 

--add an example here

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/GuiGridListSetSelectionMode?oldid=12216"