GuiDeleteTab: 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 -->
{{Client function}}
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function allows for deletion of a tab from a tab panel


==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 guiDeleteTab ( element tabToDelete )
</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 -->
*'''tabToDelete:''' This is an element representing the tab that you want to delete.
*'''argumentName:''' description
 
<!-- 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'' the tab was successfully deleted, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example removes a tab panel if a user LeftCtrl+Clicks a tab panel.
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 deleteTabOnClick ()
blabhalbalhb --abababa
if ( getKeyState ( "lctrl" ) == true ) then --if he's holding down left control
--This line does this...
guiDeleteTab ( source )--delete the tab. The function wont work anyway for other types of elements so no check is required.
mooo
end
end
addEventHandler ( "onClientClick", getRootElement(), deleteTabOnClick  )--add an event handler for this
</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 16:54, 4 August 2007

This function allows for deletion of a tab from a tab panel

Syntax

bool guiDeleteTab ( element tabToDelete )

Required Arguments

  • tabToDelete: This is an element representing the tab that you want to delete.

Returns

Returns true the tab was successfully deleted, false otherwise.

Example

This example removes a tab panel if a user LeftCtrl+Clicks a tab panel. 

function deleteTabOnClick ()
	if ( getKeyState ( "lctrl" ) == true ) then --if he's holding down left control
		guiDeleteTab ( source )--delete the tab.  The function wont work anyway for other types of elements so no check is required.
	end
end
addEventHandler ( "onClientClick", getRootElement(), deleteTabOnClick  )--add an event handler for this

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/GuiDeleteTab?oldid=9801"