GuiGridListSetScrollBars: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP syntax)
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Client function}}
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function allows a gridlist's scrollbar to be forced '''on''', or returned to default.
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 guiGridListSetScrollBars ( element guiGridlist, bool horizontalBar, bool verticalBar )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:setScrollBars}}


===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 -->
*'''guiGridlist:''' The GUI gridlist you wish to change the state of scrollbars
*'''argumentName:''' description
*'''horizontalBar:''' A bool where ''true'' forces the horizontal scrollbar on, and ''false'' returns them to default.
 
*'''verticalBar:''' A bool where ''true'' forces the verical scrollbar on, and ''false'' returns them to default.
<!-- 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 scrollbars were successfully set, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a gridlist and checks if it's created then sets the scroll bars. (TESTED!)
This example does...
<syntaxhighlight lang="lua">gridlist = guiCreateGridList(332,195,286,249,false)
<!-- 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">
if(gridlist)then
--This line does...
guiGridListSetScrollBars(gridlist,true,true)
blabhalbalhb --abababa
end
--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]]
{{GUI_events}}
[[Category:Needs_Syntax]]

Latest revision as of 21:19, 7 November 2018

This function allows a gridlist's scrollbar to be forced on, or returned to default.

Syntax

bool guiGridListSetScrollBars ( element guiGridlist, bool horizontalBar, bool verticalBar )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:setScrollBars(...)


Required Arguments

  • guiGridlist: The GUI gridlist you wish to change the state of scrollbars
  • horizontalBar: A bool where true forces the horizontal scrollbar on, and false returns them to default.
  • verticalBar: A bool where true forces the verical scrollbar on, and false returns them to default.

Returns

Returns true if the scrollbars were successfully set, false otherwise.

Example

This example creates a gridlist and checks if it's created then sets the scroll bars. (TESTED!) 

gridlist = guiCreateGridList(332,195,286,249,false)

if(gridlist)then
	guiGridListSetScrollBars(gridlist,true,true)
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/GuiGridListSetScrollBars?oldid=60529"