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

34 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="GridContainer" 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>
Clarify the required child node type in the GridContainer documentation This closes #41822. (cherry picked from commit 40b5331d794e16c586b9bb5a10a6d820e16be2dc)
2020-09-06 23:41:08 +00:00
Grid container used to arrange Control-derived children in a grid like layout.
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>
Clarify the required child node type in the GridContainer documentation This closes #41822. (cherry picked from commit 40b5331d794e16c586b9bb5a10a6d820e16be2dc)
2020-09-06 23:41:08 +00:00
GridContainer will arrange its Control-derived children in a grid like structure, the grid columns are specified using the [member columns] property and the number of rows will be equal to the number of children in the container divided by the number of columns. For example, if the container has 5 children, and 2 columns, there will be 3 rows in the container.
Make empty columns automatically expand in GridContainer
2019-09-08 05:20:34 +00:00
Notice that grid layout will preserve the columns and rows for every size of the container, and that empty columns will be expanded automatically.
Clarify the required child node type in the GridContainer documentation This closes #41822. (cherry picked from commit 40b5331d794e16c586b9bb5a10a6d820e16be2dc)
2020-09-06 23:41:08 +00:00
[b]Note:[/b] GridContainer only works with child nodes inheriting from Control. It won't rearrange child nodes inheriting from Node2D.
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>
Link to Container tutorial Users happening across any of the Container pages may not already know the intent of Containers, or which others are available. This commit adds a link to the existing "GUI containers" page in their tutorials sections. (cherry picked from commit 3b941ed98cfb1f72c35684f1d4d458dacd482c63)
2022-04-21 06:16:02 +00:00
<link title="GUI containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
Link to demos from within the class reference (cherry picked from commit 439be614f4706705331669a58ce03f14c34ca52f)
2020-10-01 08:34:47 +00:00
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</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>
<methods>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="columns" type="int" setter="set_columns" getter="get_columns" default="1">
Clarify the required child node type in the GridContainer documentation This closes #41822. (cherry picked from commit 40b5331d794e16c586b9bb5a10a6d820e16be2dc)
2020-09-06 23:41:08 +00:00
The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its Control-derived children to accommodate the new layout.
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
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:15:17 +00:00
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="1" />
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
</members>
<constants>
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 15:07:21 +00:00
<theme_item name="hseparation" data_type="constant" type="int" default="4">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The horizontal separation of children nodes.
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="vseparation" data_type="constant" type="int" default="4">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 18:21:21 +00:00
The vertical separation of children nodes.
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>