GuiGridListAutoSizeColumn: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Client function}}
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This fake function is for use with blah & blah and does blahblahblabhalbhl
This allows you to automatically size a column to display everything in it correctly, with the most minimal width.


==Syntax==  
==Syntax==  
Line 7: Line 8:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiGridListAutoSizeColumn ( element gridList, int columnIndex )
bool guiGridListAutoSizeColumn ( element gridList, int columnIndex )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:autoSizeColumn}}


===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 -->
<!-- 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 -->
*'''argumentName:''' description
*'''gridList:''' The [[Element/GUI/Gridlist|grid list]] element where the column is located.
 
*'''columnIndex:''' The ID of the column you want to be auto-sized.
<!-- 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 the column was auto-sized, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a random list of numbers of various lengths. This function is used to adjust the width to display them all.
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...
function clientsideResourceStart ()
blabhalbalhb --abababa
    local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) --Create a gridlist
--This line does this...
    local column = guiGridListAddColumn( numberList, "Column Title", 0.85 ) --Create a column on the gridlist
mooo
    if ( column ) then --If the column was created successfully
</syntaxhighlight>
        local count = 0 -- Set the varible 'count' to the value 0
        while count <= 10 do --Loop through 10 times adding random numbers in rows for the column
            local row = guiGridListAddRow ( numberList )
            guiGridListSetItemText ( numberList, row, column, tostring(math.random(0, 10) ^ 100), false, false )
            count = count + 1
        end
        guiGridListAutoSizeColumn ( numberList, column ) --After the numbers are added in rows, perform auto sizing on the column
    end
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )</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 -->
<!-- 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:07, 7 November 2018

This allows you to automatically size a column to display everything in it correctly, with the most minimal width.

Syntax

bool guiGridListAutoSizeColumn ( element gridList, int columnIndex )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:autoSizeColumn(...)


Required Arguments

  • gridList: The grid list element where the column is located.
  • columnIndex: The ID of the column you want to be auto-sized.

Returns

Returns true if the column was auto-sized, false otherwise.

Example

This example creates a random list of numbers of various lengths. This function is used to adjust the width to display them all. 

function clientsideResourceStart ()
    local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) --Create a gridlist
    local column = guiGridListAddColumn( numberList, "Column Title", 0.85 ) --Create a column on the gridlist
    if ( column ) then --If the column was created successfully
        local count = 0 -- Set the varible 'count' to the value 0
        while count <= 10 do --Loop through 10 times adding random numbers in rows for the column
            local row = guiGridListAddRow ( numberList )
            guiGridListSetItemText ( numberList, row, column, tostring(math.random(0, 10) ^ 100), false, false )
            count = count + 1
        end
        guiGridListAutoSizeColumn ( numberList, column ) --After the numbers are added in rows, perform auto sizing on the column
    end
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )


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/GuiGridListAutoSizeColumn?oldid=60505"