summaryrefslogtreecommitdiff
path: root/doc/classes/MarginContainer.xml
blob: 3f9f93a39ba6cd51ad29ce4cdb6ff027d1c5da5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MarginContainer" inherits="Container" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Simple margin container.
	</brief_description>
	<description>
		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 from the constant margin values. If you want to change the custom margin values of the [MarginContainer] by code, you should use the following examples:
		[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>
	</tutorials>
	<theme_items>
		<theme_item name="margin_bottom" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a bottom margin of [code]margin_bottom[/code] pixels.
		</theme_item>
		<theme_item name="margin_left" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a left margin of [code]margin_left[/code] pixels.
		</theme_item>
		<theme_item name="margin_right" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a right margin of [code]margin_right[/code] pixels.
		</theme_item>
		<theme_item name="margin_top" data_type="constant" type="int" default="0">
			All direct children of [MarginContainer] will have a top margin of [code]margin_top[/code] pixels.
		</theme_item>
	</theme_items>
</class>