diff options
author | Chris verBurg <cheetomonster@gmail.com> | 2022-04-20 23:16:02 -0700 |
---|---|---|
committer | Chris verBurg <cheetomonster@gmail.com> | 2022-04-28 00:22:43 -0700 |
commit | 3b941ed98cfb1f72c35684f1d4d458dacd482c63 (patch) | |
tree | 40ee899b8475c1e15be0d47a77174941bba97e4f /doc/classes | |
parent | f4b0c7a1ea8d86c1dfd96478ca12ad1360903d9d (diff) |
Link to Container tutorial
Users happening across any of the Container pages may not already know the intent of Containers, or which others are available. This commit adds a link to the existing "GUI containers" page in their tutorials sections.
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/AspectRatioContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/BoxContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/CenterContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/Container.xml | 1 | ||||
-rw-r--r-- | doc/classes/GridContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/HBoxContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/HSplitContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/MarginContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/PanelContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/ScrollContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/SplitContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/TabContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/VBoxContainer.xml | 1 | ||||
-rw-r--r-- | doc/classes/VSplitContainer.xml | 1 |
14 files changed, 14 insertions, 0 deletions
diff --git a/doc/classes/AspectRatioContainer.xml b/doc/classes/AspectRatioContainer.xml index 742a7276d4..e7847ba05c 100644 --- a/doc/classes/AspectRatioContainer.xml +++ b/doc/classes/AspectRatioContainer.xml @@ -7,6 +7,7 @@ Arranges child controls in a way to preserve their aspect ratio automatically whenever the container is resized. Solves the problem where the container size is dynamic and the contents' size needs to adjust accordingly without losing proportions. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <members> <member name="alignment_horizontal" type="int" setter="set_alignment_horizontal" getter="get_alignment_horizontal" enum="AspectRatioContainer.AlignmentMode" default="1"> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index 92fccaa884..c76a178368 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -7,6 +7,7 @@ Arranges child [Control] nodes vertically or horizontally, and rearranges them automatically when their minimum size changes. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="add_spacer"> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml index 08cdf64cea..f5f32bd325 100644 --- a/doc/classes/CenterContainer.xml +++ b/doc/classes/CenterContainer.xml @@ -7,6 +7,7 @@ CenterContainer keeps children controls centered. This container keeps all children to their minimum size, in the center. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <members> <member name="use_top_left" type="bool" setter="set_use_top_left" getter="is_using_top_left" default="false"> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 11b20b5654..900997d119 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -8,6 +8,7 @@ A Control can inherit this to create custom container classes. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="_get_allowed_size_flags_horizontal" qualifiers="virtual const"> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml index 59777ffb79..27095c7f72 100644 --- a/doc/classes/GridContainer.xml +++ b/doc/classes/GridContainer.xml @@ -9,6 +9,7 @@ [b]Note:[/b] GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> </tutorials> <members> diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml index 0af9f7a0f4..21267215eb 100644 --- a/doc/classes/HBoxContainer.xml +++ b/doc/classes/HBoxContainer.xml @@ -7,6 +7,7 @@ Horizontal box container. See [BoxContainer]. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <theme_items> <theme_item name="separation" data_type="constant" type="int" default="4"> diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml index f240718176..8137e26b8c 100644 --- a/doc/classes/HSplitContainer.xml +++ b/doc/classes/HSplitContainer.xml @@ -7,6 +7,7 @@ Horizontal split container. See [SplitContainer]. This goes from left to right. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <theme_items> <theme_item name="autohide" data_type="constant" type="int" default="1"> diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml index 3f9f93a39b..3b2ace8475 100644 --- a/doc/classes/MarginContainer.xml +++ b/doc/classes/MarginContainer.xml @@ -26,6 +26,7 @@ [/codeblocks] </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <theme_items> <theme_item name="margin_bottom" data_type="constant" type="int" default="0"> diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml index 1bb26045d9..fff30e0dc0 100644 --- a/doc/classes/PanelContainer.xml +++ b/doc/classes/PanelContainer.xml @@ -7,6 +7,7 @@ Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> <link title="2D Role Playing Game Demo">https://godotengine.org/asset-library/asset/520</link> </tutorials> <members> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 95255ed79f..658793c4c0 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -9,6 +9,7 @@ Works great with a [Panel] control. You can set [code]EXPAND[/code] on the children's size flags, so they will upscale to the ScrollContainer's size if it's larger (scroll is invisible for the chosen dimension). </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="ensure_control_visible"> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index b2fcd46731..f2bc65f8df 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -7,6 +7,7 @@ Container for splitting two [Control]s vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="clamp_split_offset"> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 011b716dfc..10b5f730ad 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -9,6 +9,7 @@ [b]Note:[/b] The drawing of the clickable tabs themselves is handled by this node. Adding [TabBar]s as children is not needed. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <methods> <method name="get_current_tab_control" qualifiers="const"> diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml index 4821791f50..a345668f91 100644 --- a/doc/classes/VBoxContainer.xml +++ b/doc/classes/VBoxContainer.xml @@ -7,6 +7,7 @@ Vertical box container. See [BoxContainer]. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> <link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link> </tutorials> <theme_items> diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml index 32b7637c7e..b933fb2805 100644 --- a/doc/classes/VSplitContainer.xml +++ b/doc/classes/VSplitContainer.xml @@ -7,6 +7,7 @@ Vertical split container. See [SplitContainer]. This goes from top to bottom. </description> <tutorials> + <link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link> </tutorials> <theme_items> <theme_item name="autohide" data_type="constant" type="int" default="1"> |