virtualx-engine/doc/classes/MarginContainer.xml
Yuri Sizov cc0eebd9d8 Validate code tags for class and member references
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00

45 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="MarginContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A container that keeps a margin around its child controls.
</brief_description>
<description>
[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:
[codeblocks]
[gdscript]
# This code sample assumes the current script is extending MarginContainer.
var margin_value = 100
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)
[/gdscript]
[csharp]
// This code sample assumes the current script is extending MarginContainer.
int marginValue = 100;
AddThemeConstantOverride("margin_top", marginValue);
AddThemeConstantOverride("margin_left", marginValue);
AddThemeConstantOverride("margin_bottom", marginValue);
AddThemeConstantOverride("margin_right", marginValue);
[/csharp]
[/codeblocks]
</description>
<tutorials>
<link title="Using Containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
</tutorials>
<theme_items>
<theme_item name="margin_bottom" data_type="constant" type="int" default="0">
Offsets towards the inside direct children of the container by this amount of pixels from the bottom.
</theme_item>
<theme_item name="margin_left" data_type="constant" type="int" default="0">
Offsets towards the inside direct children of the container by this amount of pixels from the left.
</theme_item>
<theme_item name="margin_right" data_type="constant" type="int" default="0">
Offsets towards the inside direct children of the container by this amount of pixels from the right.
</theme_item>
<theme_item name="margin_top" data_type="constant" type="int" default="0">
Offsets towards the inside direct children of the container by this amount of pixels from the top.
</theme_item>
</theme_items>
</class>