From 538baea208e3a6321238e38625cc5614bdbe8de6 Mon Sep 17 00:00:00 2001 From: Michael Alexsander Date: Sun, 5 Jan 2020 18:19:08 -0300 Subject: [PATCH] Complete the SplitContainer and Tabs documentations --- doc/classes/SplitContainer.xml | 13 ++++++++----- doc/classes/Tabs.xml | 15 ++++++++++++++- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 71731f685a5..25d4546c3ab 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -4,7 +4,7 @@ Container for splitting and adjusting. - Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. + Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. @@ -13,16 +13,19 @@ + Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values. + If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled. - Determines the dragger's visibility. See [enum DraggerVisibility] for options. + Determines the dragger's visibility. See [enum DraggerVisibility] for details. + The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control]. @@ -36,13 +39,13 @@ - The split dragger is visible. + The split dragger is visible when the cursor hovers it. - The split dragger is invisible. + The split dragger is never visible. - The split dragger is invisible and collapsed. + The split dragger is never visible and its space collapsed. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 6bd7b8c2c34..04119b7cdb3 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -33,6 +33,7 @@ + Returns [code]true[/code] if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible. @@ -71,6 +72,7 @@ + Returns the number of hidden tabs offsetted to the left. @@ -179,11 +181,13 @@ If [code]true[/code], tabs can be rearranged with mouse drag. + if [code]true[/code], the mouse's scroll wheel cab be used to navigate the scroll view. - The alignment of all tabs. See enum [code]TabAlign[/code] constants for details. + The alignment of all tabs. See [enum TabAlign] for details. + Sets when the close button will appear on the tabs. See [enum CloseButtonDisplayPolicy] for details. @@ -191,36 +195,42 @@ + Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. + Emitted when a tab is right-clicked. + Emitted when switching to another tab. + Emitted when a tab is clicked, even if it is the current tab. + Emitted when a tab is closed. + Emitted when a tab is hovered by the mouse. @@ -238,10 +248,13 @@ Represents the size of the [enum TabAlign] enum. + Never show the close buttons. + Only show the close button on the currently active tab. + Show the close button on all tabs. Represents the size of the [enum CloseButtonDisplayPolicy] enum.