Add filename filter field to FileDialog

[vPumpking]

Added possibility to filter files and folders through a text entry.
The text entry is hidden by default, and can be opened by pressing Ctrl+F or by clicking the appropriate filter button.

Closes godotengine/godot-proposals#9099

This Pull Request features a filter bar for FileDialog.

It enables to search a specific term in the current folder. The matching subdirectories are first displayed alphabetically, and then the same happens to files.

2024-02-29.15-08-45.mp4

[vPumpking]

I've got an error saying that if (match and files.front()->get().to_lower().contains(filename_filter_match.to_lower())) { was a syntax error, how am i supposed to write it?

[AThousandShips]

With &&, don't use and in c++

[vPumpking]

With &&, don't use and in c++

That's weird because it worked with and when I tested my code

[AThousandShips]

Yes it's an alternative syntax, but it's not allowed (and fails on MSVC)

[bruvzg]

That's weird because it worked with and when I tested my code

MSVC do support alternative syntax, but require inclusion of iso646.h (this is true for all compilers, but GCC will work with a lot of omitted includes). Syntax exist to support ancient encodings without some characters like & and in general should not be used.

[bruvzg]

Same for the second dialog.

Note: This feature will be impossible to implement in the native dialogs (on any of the supported platforms). But native dialogs usually have search functionality of their own.

[vPumpking]

Same for the second dialog.

Note: This feature will be impossible to implement in the native dialogs (on any of the supported platforms). But native dialogs usually have search functionality of their own.

@bruvzg
I'm trying to figure out why, but your suggestion broke the filter

EDIT: Fixed, my fault

[Calinou]

I still can't get the autoselect behavior to work in FileDialog, I need to use Shift + Tab to focus the file list then select a file:

filedialog_no_autoselect_after_filter.mp4

This behavior only works in EditorFileDialog for me:

editorfiledialog_autoselect_after_filter.mp4

Also, this is printed in the console every time I enter a character in the file filter if there are no visible files in the current folder in EditorFileDialog (e.g. because of the file type filter):

ERROR: Index p_idx = 0 is out of bounds (items.size() = 0).
   at: select (./scene/gui/item_list.cpp:381)

[vPumpking]

I still can't get the autoselect behavior to work in FileDialog, I need to use Shift + Tab to focus the file list then select a file:

filedialog_no_autoselect_after_filter.mp4

This behavior only works in EditorFileDialog for me:

editorfiledialog_autoselect_after_filter.mp4

Also, this is printed in the console every time I enter a character in the file filter if there are no visible files in the current folder in EditorFileDialog (e.g. because of the file type filter):

ERROR: Index p_idx = 0 is out of bounds (items.size() = 0).
   at: select (./scene/gui/item_list.cpp:381)

so this isn't the final commit after all 😅, sorry for that
I think I get what behavior you want for FileDialog: you want the first item to be selected every time a character is entered
but I don't think it's possible, since doing that would make the filter bar loose focus (tell me if I'm wrong) 🤔
the error when directory empty should be an easy fix though

[Calinou]

I think I get what behavior you want for FileDialog: you want the first item to be selected every time a character is entered
but I don't think it's possible, since doing that would make the filter bar loose focus (tell me if I'm wrong) 🤔

The same behavior works fine in EditorFileDialog. You can have the ItemList/Tree select an item without giving focus to the ItemList/Tree in question.

[vPumpking]

as said here #88673 (comment) , I struggle figuring out why it works in editor version but not in regular one, since it's implemented the same way
EDIT:
Seems to work for me as is

2024-08-11.02-50-47.mp4

[YeldhamDev]

The file focusing doesn't appear to work on the non-editor file dialog in my end. Calinou also reported the same on the dev chat.

[vPumpking]

how can I have the latest version of godot source into my branch without adding any commit from my account?

[YeldhamDev]

how can I have the latest version of godot source into my branch without adding any commit from my account?

https://docs.godotengine.org/en/stable/contributing/workflow/pr_workflow.html#updating-your-branch

[vPumpking]

thanks

[vPumpking]

@bruvzg thanks for your help man

[vPumpking]

@bruvzg as written in the review, I made the changes you recommended, but now the editor filename filter doesn't select the firdt item anymore

[vPumpking]

Could someone please restart the checks, it seems like a network error occured

[Calinou]

Works great now 🙂

Note for reviewers: EditorFileDialog changes were removed from this PR since #97344 was merged. This PR now only modifies FileDialog, which #97344 didn't modify. Therefore, this PR ensures feature parity between FileDialog and EditorFileDialog on providing a filter function.

[akien-mga]

Thanks!