summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMax Hilbrunner <mhilbrunner@users.noreply.github.com>2021-10-29 13:21:09 +0200
committerGitHub <noreply@github.com>2021-10-29 13:21:09 +0200
commit343414cba57043965eadcdd6456ca373d2bfe5bb (patch)
tree61427f65ce23531bea858a7555857e04c8e1c70d /doc/classes
parent75baf16bab073fb52fb0ec33f08517cfb3febaa1 (diff)
parent4c563a51c390755421b745417cd025da9b80ece1 (diff)
Merge pull request #54328 from YeldhamDev/tabbar_close_signal_rename
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">