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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

46 lines
2.4 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-02-14 13:18:53 +00:00
<class name="MarginContainer" inherits="Container" version="4.0" 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>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
A container that keeps a margin around its child controls.
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>
<description>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
[MarginContainer] adds an adjustable margin on each side of its child controls. The margins are added around all children, not around each individual one. To control the [MarginContainer]'s margins, use the [code]margin_*[/code] theme properties listed below.
[b]Note:[/b] The margin sizes are theme overrides, not normal properties. This is an example of how to change them in code:
Docs: Port Code Examples to C# (M, N, O, P, R) Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-31 17:54:17 +00:00
[codeblocks]
[gdscript]
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:17:40 +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:17:40 +00:00
add_theme_constant_override("margin_top", margin_value)
add_theme_constant_override("margin_left", margin_value)
add_theme_constant_override("margin_bottom", margin_value)
add_theme_constant_override("margin_right", margin_value)
Docs: Port Code Examples to C# (M, N, O, P, R) Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-31 17:54:17 +00:00
[/gdscript]
[csharp]
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:17:40 +00:00
// This code sample assumes the current script is extending MarginContainer.
Docs: Port Code Examples to C# (M, N, O, P, R) Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-31 17:54:17 +00:00
int marginValue = 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:17:40 +00:00
AddThemeConstantOverride("margin_top", marginValue);
AddThemeConstantOverride("margin_left", marginValue);
AddThemeConstantOverride("margin_bottom", marginValue);
AddThemeConstantOverride("margin_right", marginValue);
Docs: Port Code Examples to C# (M, N, O, P, R) Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-31 17:54:17 +00:00
[/csharp]
[/codeblocks]
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>
Overhaul the top sections of the class reference (GUI classes) (cherry picked from commit 151a4ba6a59f6e965bb56ce8fbc75b14d056fa79)
2023-04-30 14:26:09 +00:00
<link title="Using Containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
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
</tutorials>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +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-04 16:54:41 +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-04 16:54:41 +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-04 16:54:41 +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>