GuiCreateTabPanel: 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 creates a Tab Panel, which acts as a template to create Tabs upon.
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 )
gui element guiCreateTabPanel ( float x, float y, float width, float height, bool relative, [element parent] )
</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 -->
*'''x:''' This is a float representing the x position on the screen. If ''relative'' is enabled this represents a float between 0 and 1 representing a fraction of the parent element width
*'''argumentName:''' description
*'''y:''' This is a float representing the y position on the screen.  If ''relative'' is enabled this represents a float between 0 and 1 representing a fraction of the parent element height
*'''width:''' This is a float representing the width of the tab panel.  If ''relative'' is enabled this represents a float between 0 and 1 representing a fraction of the screen width
*'''length:''' This is a float representing the width of the tab panel.  If ''relative'' is enabled this represents a float between 0 and 1 representing a fraction of the screen width
*'''relative:''' This is a boolean representing whether size and position will be relative to a parent element


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''argumentName2:''' description
*'''parent:''' This is the parent, representing what element size and position will be relative to.
*'''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 a GUI tab panel element if successful, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 20:17, 8 June 2007

This function creates a Tab Panel, which acts as a template to create Tabs upon.

Syntax

gui element guiCreateTabPanel ( float x, float y, float width, float height, bool relative, [element parent] )

Required Arguments

  • x: This is a float representing the x position on the screen. If relative is enabled this represents a float between 0 and 1 representing a fraction of the parent element width
  • y: This is a float representing the y position on the screen. If relative is enabled this represents a float between 0 and 1 representing a fraction of the parent element height
  • width: This is a float representing the width of the tab panel. If relative is enabled this represents a float between 0 and 1 representing a fraction of the screen width
  • length: This is a float representing the width of the tab panel. If relative is enabled this represents a float between 0 and 1 representing a fraction of the screen width
  • relative: This is a boolean representing whether size and position will be relative to a parent element

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent, representing what element size and position will be relative to.

Returns

Returns a GUI tab panel element if successful, false otherwise.

Example

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

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