Add support for multiline cells to `Tree` #61714

dalexeev · 2022-06-05T11:16:35Z

Confirming a change to a multiline cell is done with Ctrl+Enter instead of Enter.

My tree CSV editor

Test project: gd4-tree-multiline-items.zip

Closes godotengine/godot-proposals#3632.

KoBeWi · 2022-06-05T11:31:11Z

Confirming a change to a multiline cell is done with Ctrl+Enter instead of Enter.

Should be the opposite.

reduz · 2022-08-06T21:54:34Z

@KoBeWi this is up to you to decide what to do

dalexeev · 2022-08-14T14:22:06Z

Confirming a change to a multiline cell is done with Ctrl+Enter instead of Enter.

Should be the opposite.

Fixed.

@KoBeWi this is up to you to decide what to do

@KoBeWi If you are going to rewrite Tree in the near future, then this PR can probably be closed. Just don't forget about multiline cells, please.

KoBeWi · 2022-09-08T14:23:40Z

Needs rebase.
Also the text changes should likely be reviewed by @bruvzg

bruvzg

Changes seems fine. It's probably should additionally expose TextServer::AutowrapMode for the cell to have more control.

doc/classes/TreeItem.xml

KoBeWi · 2022-09-09T21:52:38Z

I tested this and:

~~newline should be Shift+Enter not Ctrl+Enter (it's common in different apps, mainly chat)~~ EDIT: Ah it uses an existing action. I'd change it, but technically it's unrelated, so should be done in another PR.
multiline cells are unusable with default settings:

The size is too small. Maybe scroll_fit_content_height property is enough to fix that. Or at least docs should mention how to make the cell higher.

scene/gui/tree.cpp

scene/gui/tree.h

KoBeWi · 2022-09-09T22:27:25Z

scene/gui/tree.cpp

@@ -1722,7 +1739,7 @@ void Tree::draw_item_rect(TreeItem::Cell &p_cell, const Rect2i &p_rect, const Co

 	if (rtl) {
 		Point2 draw_pos = rect.position;
-		draw_pos.y += Math::floor((rect.size.y - p_cell.text_buf->get_size().y) / 2.0);
+		draw_pos.y += Math::floor(p_draw_ofs.y) - _get_title_button_height();


Should this really use title height? It's a method for drawing cells (I think) and titles can be disabled, making their height 0.

EDIT:
Seems to work correctly though, so idk.

The title height is used for the initial drawing offset. If the title is hidden, then there is no offset. Perhaps this value is already taken into account in some variable, but I could not fix the offset error until I used this function. The Tree class is very large and needs to be refactored.

doc/classes/TreeItem.xml

scene/gui/tree.h

dalexeev · 2022-09-10T13:04:35Z

multiline cells are unusable with default settings

The height of the editor is equal to the height of the line. If all cells are empty, Tree draws a line with a very small height. Perhaps this is a Tree problem? Maybe we need Tree to draw empty lines one line high?

Maybe scroll_fit_content_height property is enough to fix that.

In this case, the editor can overflow through the line without stretching it in height. I don't think this is what we need.

KoBeWi · 2022-09-10T13:09:13Z

The height of the editor is equal to the height of the line. If all cells are empty, Tree draws a line with a very small height. Perhaps this is a Tree problem? Maybe we need Tree to draw empty lines one line high?

Well, if the cell is editable, it's not very useful when it's tiny. Maaybe having cell edit without other cells isn't very common, but for multiline edits the height should definitely match the edited text.

In this case, the editor can overflow through the line without stretching it in height.

You could try using minimum_size_changed signal to update the cell height.

dalexeev · 2022-09-10T13:21:17Z

You could try using minimum_size_changed signal to update the cell height.

The problem is that until the change is applied, the text is only in the TextEdit, not in the Tree cell. So, the line height remains small. Changing the contents of a cell before the change is applied is wrong.

KoBeWi · 2022-09-10T13:31:16Z

Then not sure what to do about the cell. IMO it's not fine if you have scrollable TextEdit, but then the text properly expands when you accept it. You could maybe change the cell text, but revert if it the user cancels editing text.

dalexeev · 2022-09-10T16:58:45Z

I made the minimum height the same size as the height of one empty line:

You could maybe change the cell text, but revert if it the user cancels editing text.

I don't think this is a good solution since editing is a lengthy process and user code can get errors if it reads the text of the cells (the value can be new before the signal, and roll back if the user undoes the changes).

Ideally, Tree should be able to draw currently edited (not yet applied) values, distinguish between visual and logical content. But now it is difficult to implement.

dalexeev · 2022-09-10T17:57:38Z

newline should be Shift+Enter not Ctrl+Enter (it's common in different apps, mainly chat)

In some applications this is Shift+Enter, in others Ctrl+Enter (for example, LibreOffice Calc).

KoBeWi

Can't say if the code is 100% correct, but looks ok and it works.

doc/classes/TreeItem.xml

akien-mga · 2023-04-25T14:18:22Z

Needs a rebase, then I think it should be mergeable?

dalexeev · 2023-04-25T15:57:39Z

Rebased.

akien-mga · 2023-04-25T17:30:48Z

Thanks!

bvigario · 2023-05-12T14:08:13Z

I believe this breaks set_column_clip_content, at least when using text. I'm using this method in order to display ellipsis when text overflows the column width. Is there a way to get around this that I'm not seeing?

dalexeev · 2023-05-12T14:15:15Z

See #76532 (comment). I added this to my TODO list and will try to fix it.

dalexeev requested review from a team as code owners June 5, 2022 11:16

KoBeWi added enhancement topic:gui labels Jun 5, 2022

KoBeWi added this to the 4.0 milestone Jun 5, 2022

dalexeev force-pushed the tree-multiline-items branch 2 times, most recently from 2f21498 to 8c8f099 Compare July 22, 2022 05:01

dalexeev force-pushed the tree-multiline-items branch from 8c8f099 to 53f1d02 Compare August 14, 2022 14:16

dalexeev force-pushed the tree-multiline-items branch from 53f1d02 to 174727e Compare August 14, 2022 14:23

dalexeev force-pushed the tree-multiline-items branch from 174727e to 9de10d0 Compare August 22, 2022 09:17

YuriSizov requested a review from KoBeWi September 8, 2022 14:15

bruvzg reviewed Sep 8, 2022

View reviewed changes

dalexeev force-pushed the tree-multiline-items branch from 9de10d0 to c177db8 Compare September 8, 2022 16:50