summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMichael Alexsander <michaelalexsander@protonmail.com>2021-10-27 19:39:13 -0300
committerMichael Alexsander <michaelalexsander@protonmail.com>2021-10-28 13:10:44 -0300
commit4c563a51c390755421b745417cd025da9b80ece1 (patch)
tree03d31f5cf9ed410b408edf3c82f047c16f2e5303 /doc/classes
parent8508f9396d2a063885798593c0cef18265b4c87a (diff)
Rename `TabBar`'s `tab_closed` signal to `tab_close_pressed`
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/TabBar.xml13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/classes/TabBar.xml b/doc/classes/TabBar.xml
index 3ca124bb58..612f8fb740 100644
--- a/doc/classes/TabBar.xml
+++ b/doc/classes/TabBar.xml
@@ -235,10 +235,19 @@
Emitted when a tab is clicked, even if it is the current tab.
</description>
</signal>
- <signal name="tab_closed">
+ <signal name="tab_close_pressed">
<argument index="0" name="tab" type="int" />
<description>
- Emitted when a tab is closed.
+ Emitted when a tab's close button is pressed.
+ [b]Note:[/b] Tabs are not removed automatically once the close button is pressed, this behaviour needs to be programmed manually. For example:
+ [codeblocks]
+ [gdscript]
+ $TabBar.tab_close_pressed.connect($TabBar.remove_tab)
+ [/gdscript]
+ [csharp]
+ GetNode&lt;TabBar&gt;("TabBar").TabClosePressed += GetNode&lt;TabBar&gt;("TabBar").RemoveTab;
+ [/csharp]
+ [/codeblocks]
</description>
</signal>
<signal name="tab_hovered">