godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/MarginContainer.xml

39 lines
2.0 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="MarginContainer" inherits="Container" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Simple margin container.
</brief_description>
<description>
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
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.
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
[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:
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
[codeblock]
Use safer `add_theme_constant_override()` in MarginContainer code sample Control has magic setters to set custom theme items, but using the dedicated Control methods is less prone to typos so it should be favored.
2021-03-04 16:18:51 +00:00
# This code sample assumes the current script is extending MarginContainer.
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
var margin_value = 100
Use safer `add_theme_constant_override()` in MarginContainer code sample Control has magic setters to set custom theme items, but using the dedicated Control methods is less prone to typos so it should be favored.
2021-03-04 16:18:51 +00:00
add_constant_override("margin_top", margin_value)
add_constant_override("margin_left", margin_value)
add_constant_override("margin_bottom", margin_value)
add_constant_override("margin_right", margin_value)
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
[/codeblock]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="margin_bottom" data_type="constant" type="int" default="0">
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="margin_left" data_type="constant" type="int" default="0">
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="margin_right" data_type="constant" type="int" default="0">
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="margin_top" data_type="constant" type="int" default="0">
Document MarginContainer Node
2019-06-19 08:29:35 +00:00
All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
</theme_items>
</class>