Support MIME types in file dialog filters on macOS and Linux. #99350
+241
−57
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bruvzg
force-pushed
the
fs_mime
branch
2 times, most recently
from
1dcfe9d to
f039cac
Compare
servers/display_server.h
Outdated
| @@ -153,6 +153,8 @@ class DisplayServer : public Object { | |||
| FEATURE_NATIVE_DIALOG_INPUT, | |||
| FEATURE_NATIVE_DIALOG_FILE, | |||
| FEATURE_NATIVE_DIALOG_FILE_EXTRA, | |||
| FEATURE_NATIVE_DIALOG_FILE_MIME, | |||
| FEATURE_NATIVE_DIALOG_FILE_EXT, | |||
There was a problem hiding this comment.
The feature flag for file extensions is unnecessary, as it is supported across all platforms (I have already submitted a PR for Android). It would be better to remove this flag, as Android can handle file extensions even without the PR. If the MIME type is not provided, app simply defaults to showing all file types.
There was a problem hiding this comment.
@bruvzg My PR for adding file extension support for Android is now merged.
There was a problem hiding this comment.
Removed FEATURE_NATIVE_DIALOG_FILE_EXT and updated to use send both extensions and MIMEs to Android Java part.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This was referenced Nov 18, 2024
syntaxerror247
approved these changes
Nov 28, 2024
| @@ -138,11 +138,11 @@ | |||
| <param index="6" name="callback" type="Callable" /> | |||
| <description> | |||
| Displays OS native dialog for selecting files or directories in the file system. | |||
| Each filter string in the [param filters] array should be formatted like this: [code]*.txt,*.doc;Text Files[/code]. The description text of the filter is optional and can be omitted. See also [member FileDialog.filters]. | |||
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. See also [member FileDialog.filters]. | |||
There was a problem hiding this comment.
Suggested change
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. See also [member FileDialog.filters]. | |
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also [member FileDialog.filters]. |
| Callbacks have the following arguments: [code]status: bool, selected_paths: PackedStringArray, selected_filter_index: int[/code]. [b]On Android,[/b] callback argument [code]selected_filter_index[/code] is always zero. | ||
| [b]Note:[/b] This method is implemented if the display server has the [constant FEATURE_NATIVE_DIALOG_FILE] feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android. | ||
| [b]Note:[/b] [param current_directory] might be ignored. | ||
| [b]Note:[/b] On Android, the filter strings in the [param filters] array should be specified using MIME types, for example:[code]image/png, image/jpeg"[/code]. Additionally, the [param mode] [constant FILE_DIALOG_MODE_OPEN_ANY] is not supported on Android. | ||
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. |
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. | |
| [b]Note:[/b] Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. |
| @@ -161,14 +161,15 @@ | |||
| <param index="8" name="callback" type="Callable" /> | |||
| <description> | |||
| Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. | |||
| Each filter string in the [param filters] array should be formatted like this: [code]*.txt,*.doc;Text Files[/code]. The description text of the filter is optional and can be omitted. See also [member FileDialog.filters]. | |||
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. See also [member FileDialog.filters]. | |||
There was a problem hiding this comment.
Suggested change
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. See also [member FileDialog.filters]. | |
| Each filter string in the [param filters] array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also [member FileDialog.filters]. |
| [param options] is array of [Dictionary]s with the following keys: | ||
| - [code]"name"[/code] - option's name [String]. | ||
| - [code]"values"[/code] - [PackedStringArray] of values. If empty, boolean option (check box) is used. | ||
| - [code]"default"[/code] - default selected option index ([int]) or default boolean value ([bool]). | ||
| Callbacks have the following arguments: [code]status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary[/code]. | ||
| [b]Note:[/b] This method is implemented if the display server has the [constant FEATURE_NATIVE_DIALOG_FILE_EXTRA] feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS. | ||
| [b]Note:[/b] [param current_directory] might be ignored. | ||
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. |
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. | |
| [b]Note:[/b] Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. |
| The available file type filters. Each filter string in the array should be formatted like this: [code]*.txt,*.doc;Text Files[/code]. The description text of the filter is optional and can be omitted. | ||
| [b]Note:[/b] For android native dialog, MIME types are used like this: [code]image/*, application/pdf[/code]. | ||
| The available file type filters. Each filter string in the array should be formatted like this: [code]*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg[/code]. The description text of the filter is optional and can be omitted. Both file extensions and MIME type should be always set. | ||
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. |
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] Embedded file dialog, and Windows file dialog support only file extensions, Android, Linux and macOS file dialogs also support MIME types. | |
| [b]Note:[/b] Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes file filter format from
extension_list;nametoextension_list;name;mime_type_list.Embedded and Windows use only extensions.
Android use only MIMEs.
macOS and Linux use both.