GuiCreateTabPanel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
This function creates a Tab Panel, which acts as a template to create Tabs upon.
This function creates a Tab Panel, which acts as a template to create Tabs upon.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element guiCreateTabPanel ( float x, float y, float width, float height, bool relative, [element parent] )
element guiCreateTabPanel ( float x, float y, float width, float height, bool relative, [element parent = nil ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===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
*'''x:''' A float of the 2D x position of the GUI label on a player's screen.  This is affected by the ''relative'' argument.
*'''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
*'''y:''' A float of the 2D y position of the GUI label on a player's screen. This is affected by the ''relative'' argument.
*'''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
*'''width:''' A float of the width of the GUI label. This is affected by the ''relative'' argument.
*'''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
*'''height:''' A float of the height of the GUI label. This is affected by the ''relative'' argument.
*'''relative:''' This is a boolean representing whether size and position will be relative to a parent element
*'''text:''' A string of the text that will be displayed by default in the edit box.
*'''relative:''' This is whether sizes and positioning are relative.  If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''parent:''' This is the parent, representing what element size and position will be relative to.
*'''parent:''' This is the parent that the gui label is attached to.  The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent.  If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
 


===Returns===
===Returns===
Line 22: Line 25:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a information window and adds two tabs to a "tabPanel" tabpanel, and adds some other gui elements to it.
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 myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
blabhalbalhb --abababa
local tabPanel = guiCreateTabPanel ( 0, 0, 2, 1, true, myWindow ) --create a tab panel which fills the whole window
--This line does this...
local tabMap = guiCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
mooo
local tabHelp = guiCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'
 
-- adds a label (text) to each tab
guiCreateLabel(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)
guiCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)
</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]]

Revision as of 14:05, 4 August 2007

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

Syntax

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

Required Arguments

  • x: A float of the 2D x position of the GUI label on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI label on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI label. This is affected by the relative argument.
  • height: A float of the height of the GUI label. This is affected by the relative argument.
  • text: A string of the text that will be displayed by default in the edit box.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

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 that the gui label is attached to. The relative argument must be true to use this. Sizes and positioning will be made relative to this parent. If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.


Returns

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

Example

This example creates a information window and adds two tabs to a "tabPanel" tabpanel, and adds some other gui elements to it. 

local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )--create a window which has "Information" in the title bar.
local tabPanel = guiCreateTabPanel ( 0, 0, 2, 1, true, myWindow ) --create a tab panel which fills the whole window
local tabMap = guiCreateTab( "Map Information", tabPanel ) -- create a tab named "Map Information" on 'tabPanel'
local tabHelp = guiCreateTab( "Help", tabPanel ) -- create another tab named "Help" on 'tabPanel'

-- adds a label (text) to each tab
guiCreateLabel(0.02,0.04,0.94,0.2,"This is information about the current map",true,tabMap)
guiCreateLabel(0.02,0.04,0.94,0.92,"This is help text.",true,tabHelp)

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/GuiCreateTabPanel?oldid=9755"