Add vertical property to GridContainers

[RLCcar]

Grid Containers could only set a fixed number of vertical columns, which restricts its use on shorter, wider screens, compared to other containers with Horizontal/Vertical counterparts.

By adding a vertical property to Grid Containers, the user can choose to fix the number of rows OR columns in the grid.

Bugsquad edit:

• Closes Add a vertical property to GridContainer godot-proposals#10234

[RLCcar]

I'm trying to fix some formatting issues in the .xml and .svg files to meet the static style checks, but processing the new .svg files gives me this error:

\ No newline at end of file

I used svgcleaner to optimize the files, and I checked the line endings. Is there a style guide or is something missing?

[ydeltastar]

The new line message is just verbose. The output shows a diff with the correct format which moves the parameters in <svg ...>.

-<svg height="16" width="16" xmlns="http://www.w3.org/2000/svg"><path fill="#8eef97" d="m3 1c-1.1045695 0-2 .8954305-2 2v10c0 1.104569.8954305 2 2 2h10c1.104569 0 2-.895431 2-2v-10c0-1.1045695-.895431-2-2-2zm0 2h2v4h-2zm4 0h2v4h-2zm4 0h2v4h-2zm-8 6h2v4h-2zm4 0h2v4h-2zm4 0h2v4h-2z"/></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16"><path fill="#8eef97" d="m3 1c-1.1045695 0-2 .8954305-2 2v10c0 1.104569.8954305 2 2 2h10c1.104569 0 2-.895431 2-2v-10c0-1.1045695-.895431-2-2-2zm0 2h2v4h-2zm4 0h2v4h-2zm4 0h2v4h-2zm-8 6h2v4h-2zm4 0h2v4h-2zm4 0h2v4h-2z"/></svg>

The optimizer should be doing it. Looks like they switched from svgcleaner to svgo but didn't change it in https://docs.godotengine.org/en/latest/contributing/development/editor/creating_icons.html.

[RLCcar]

It appears Static checks and Linux / Editor w/ Mono have contradicting complaints with the XML documentation.

Static checks required that the HGridContainer and the VGridContainer XML contained definitions for the rows and columns variables, but Linux / Editor w/ Mono demands I remove them.

Is it a deeper issue with how the variables are configured, or an issue with Linux Mono?

[Calinou]

The CI log says:

Running --doctool to see if this changes the public API without updating the documentation.
If a diff is shown, it means that your code/doc changes are incomplete and you should update the class reference with --doctool.

Compile a Godot binary locally and run the --doctool command line argument on it to update the class reference XML locally. After doing this, git commit -a --amend your changes.

[RLCcar]

It appears Static checks and Linux / Editor w/ Mono have contradicting complaints with the XML documentation.

Static checks required that the HGridContainer and the VGridContainer XML contained definitions for the rows and columns variables, but Linux / Editor w/ Mono demands I remove them.

I've ran the --doctool command and pushed my new changes, but the original problem still stands: Static Checks and Linux / Editor w/ Mono contradict each other.

I'm trying to figure out why Static Checks demands that HBoxContainer and VGridContainer must include GridContainer properties in the documentation, even though it doesn't for other classes with horizontal/vertical variants. Am I missing something for the new classes?

[adamscott]

It appears Static checks and Linux / Editor w/ Mono have contradicting complaints with the XML documentation.
Static checks required that the HGridContainer and the VGridContainer XML contained definitions for the rows and columns variables, but Linux / Editor w/ Mono demands I remove them.

I've ran the --doctool command and pushed my new changes, but the original problem still stands: Static Checks and Linux / Editor w/ Mono contradict each other.

I'm trying to figure out why Static Checks demands that HBoxContainer and VGridContainer must include GridContainer properties in the documentation, even though it doesn't for other classes with horizontal/vertical variants. Am I missing something for the new classes?

I just found out. That's because the checks think that you refer to members {H,V}BoxContainer.{rows,columns}, but they don't exist. You need to specify that the member is from another class. Here's the diff to correct your issues:

diff --git a/doc/classes/HGridContainer.xml b/doc/classes/HGridContainer.xml
index 09f113035f..8a7cf007be 100644
--- a/doc/classes/HGridContainer.xml
+++ b/doc/classes/HGridContainer.xml
@@ -4,7 +4,7 @@
 		A container that arranges its child controls in a grid layout horizontally.
 	</brief_description>
 	<description>
-		A variant of [GridContainer] that can only arrange its child controls horizontally, with a set number of [member rows], and a changing number of [member columns].
+		A variant of [GridContainer] that can only arrange its child controls horizontally, with a set number of [member GridContainer.rows], and a changing number of [member GridContainer.columns].
 		Child controls are rearranged automatically when their minimum size changes.
 	</description>
 	<tutorials>
diff --git a/doc/classes/VGridContainer.xml b/doc/classes/VGridContainer.xml
index 5eb54b4cbf..fb86b3e41a 100644
--- a/doc/classes/VGridContainer.xml
+++ b/doc/classes/VGridContainer.xml
@@ -4,7 +4,7 @@
 		A container that arranges its child controls in a grid layout vertically.
 	</brief_description>
 	<description>
-		A variant of [GridContainer] that can only arrange its child controls vertically, with a set number of [member columns], and a changing number of [member rows].
+		A variant of [GridContainer] that can only arrange its child controls vertically, with a set number of [member GridContainer.columns], and a changing number of [member GridContainer.rows].
 		Child controls are rearranged automatically when their minimum size changes.
 	</description>
 	<tutorials>

[adamscott]

The diff should be good now. It included too much stuff from when I was experimenting at first. Sorry.

[Mickeon]

I understand it's there for consistency with existing containers, but is there actually a need for H and V versions of GridContainer too?

[RLCcar]

I understand it's there for consistency with existing containers, but is there actually a need for H and V versions of GridContainer too?

It's there mainly for consistency with the other containers. Plus, the H and V versions make it clearer how the GridContainer is being used.

[RLCcar]

For some reason, Git is preventing me from changing the line endings of the following SVG files from CRLF to LF:

• HGridContainer.svg
• VGridContainer.svg

There is no newline at the end of the file, so it fails the first test. Can I get some help fixing these?

[Calinou]

You need to add a LF line ending at the end of each file (currently, there is none). I suggest configuring your editor to always use LF line endings, then modifying the SVGs in question.

Many editors also have a "Ensure final newline on save" setting I suggest enabling too.