GuiGridListAddColumn: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(Adjustment)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function is used to create columns in grid lists.
 
{{Note|If the width of all columns exceeds 0.95 horizontal scrollbar will appear.}}


==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 )
int guiGridListAddColumn ( element gridList, string title, float width )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:addColumn}}


===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 grid list you want to add a column to
*'''argumentName:''' description
*'''title:''' Title of the column
 
*'''width:''' Column width, relative to the grid list width
<!-- 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 the column id if it was created, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a player list on the right side of the screen and fills it with the currently connected players.
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...
local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
blabhalbalhb --abababa
guiGridListAddColumn(playerList, "Player", 0.85)
--This line does this...
 
mooo
for _, player in ipairs(getElementsByType("player")) do
guiGridListAddRow(playerList, getPlayerName(player))
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:26, 2 December 2022

This function is used to create columns in grid lists.

[[{{{image}}}|link=|]] Note: If the width of all columns exceeds 0.95 horizontal scrollbar will appear.

Syntax

int guiGridListAddColumn ( element gridList, string title, float width )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:addColumn(...)


Required Arguments

  • gridList: The grid list you want to add a column to
  • title: Title of the column
  • width: Column width, relative to the grid list width

Returns

Returns the column id if it was created, false otherwise.

Example

This example creates a player list on the right side of the screen and fills it with the currently connected players. 

local playerList = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
guiGridListAddColumn(playerList, "Player", 0.85)

for _, player in ipairs(getElementsByType("player")) do
	guiGridListAddRow(playerList, getPlayerName(player))
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/GuiGridListAddColumn?oldid=75699"