GuiDeleteTab: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Added OOP Method Information) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool guiDeleteTab ( element tabToDelete ) | bool guiDeleteTab ( element tabToDelete, element tabPanel ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/GUI/Tab|GuiTab]]:delete}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''tabToDelete:''' This is an element representing the tab that you want to delete. | *'''tabToDelete:''' This is an element representing the tab that you want to delete. | ||
*'''tabPanel:''' This is the [[guiCreateTabPanel|tab panel]] parent that the tab is attached to. | |||
===Returns=== | ===Returns=== | ||
| Line 18: | Line 19: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function deleteTabOnClick () | function deleteTabOnClick () | ||
if ( getKeyState ( "lctrl" ) == true ) then -- if the user is holding down left control | if ( getKeyState ( "lctrl" ) == true ) and ( getElementType( source ) == "gui-tab" ) then -- if the user is holding down left control | ||
guiDeleteTab ( source ) -- delete the tab. No need to check if it was actually a tab that was clicked, as this function doesn't work on other controls anyway | guiDeleteTab ( source, getElementParent(source) ) -- delete the tab. No need to check if it was actually a tab that was clicked, as this function doesn't work on other controls anyway | ||
end | end | ||
end | end | ||
addEventHandler ( " | addEventHandler ( "onClientGUIClick", getRootElement(), deleteTabOnClick ) -- add an event handler for clicks | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{GUI functions}} | {{GUI functions}} | ||
{{GUI_events}} | |||
Latest revision as of 11:51, 7 August 2019
This function deletes a tab from a tab panel.
Syntax
bool guiDeleteTab ( element tabToDelete, element tabPanel )
OOP Syntax Help! I don't understand this!
- Method: GuiTab:delete(...)
Required Arguments
- tabToDelete: This is an element representing the tab that you want to delete.
- tabPanel: This is the tab panel parent that the tab is attached to.
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 ) and ( getElementType( source ) == "gui-tab" ) then -- if the user is holding down left control guiDeleteTab ( source, getElementParent(source) ) -- delete the tab. No need to check if it was actually a tab that was clicked, as this function doesn't work on other controls anyway end end addEventHandler ( "onClientGUIClick", getRootElement(), deleteTabOnClick ) -- add an event handler for clicks
See Also
General functions
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign
Windows
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel