summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-06-25 12:20:49 +0200
committerGitHub <noreply@github.com>2019-06-25 12:20:49 +0200
commit230eb262e239c48f20eb085424e5d45f6b785a9a (patch)
tree54c56c34db12a9cf7b53ff6d5c0fc758ec638883
parentc477cbd09db2678ffd13b07b45254fdbaabeb51c (diff)
parent9f582a7c3eb66782f4a4e3233fc17316ed43de5b (diff)
Merge pull request #30030 from zaksnet/document-margincontainer
Document MarginContainer node
-rw-r--r--doc/classes/MarginContainer.xml14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml
index 0993ed88ca..3ea3204e56 100644
--- a/doc/classes/MarginContainer.xml
+++ b/doc/classes/MarginContainer.xml
@@ -4,7 +4,15 @@
Simple margin container.
</brief_description>
<description>
- Simple margin container. Adds a left margin to anything contained.
+ Adds a top, left, bottom, and right margin to all [Control] nodes that are direct children of the container. To control the [MarginContainer]'s margin, use the [code]margin_*[/code] theme properties listed below.
+ [b]Note:[/b] Be careful, [Control] margin values are different than the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code you should use the following examples:
+ [codeblock]
+ var margin_value = 100
+ set("custom_constants/margin_top", margin_value)
+ set("custom_constants/margin_left", margin_value)
+ set("custom_constants/margin_bottom", margin_value)
+ set("custom_constants/margin_right", margin_value)
+ [/codeblock]
</description>
<tutorials>
</tutorials>
@@ -14,12 +22,16 @@
</constants>
<theme_items>
<theme_item name="margin_bottom" type="int">
+ All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels.
</theme_item>
<theme_item name="margin_left" type="int">
+ All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels.
</theme_item>
<theme_item name="margin_right" type="int">
+ All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels.
</theme_item>
<theme_item name="margin_top" type="int">
+ All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels.
</theme_item>
</theme_items>
</class>