asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/FileDialog.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

264 lines
14 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="FileDialog" inherits="ConfirmationDialog" 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 22:42:36 +02:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
A dialog for selecting files or directories in the filesystem.
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 22:42:36 +02:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
[FileDialog] is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. [FileDialog] automatically sets its window title according to the [member file_mode]. If you want to use a custom title, disable this by setting [member mode_overrides_title] to [code]false[/code].
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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_filter">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="filter" type="String" />
<param index="1" name="description" type="String" default="&quot;&quot;" />
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 22:42:36 +02:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 18:07:53 +02:00
Adds a comma-delimited file name [param filter] option to the [FileDialog] with an optional [param description], which restricts what files can be picked.
A [param filter] should be of the form [code]"filename.extension"[/code], where filename and extension can be [code]*[/code] to match any string. Filters starting with [code].[/code] (i.e. empty filenames) are not allowed.
For example, a [param filter] of [code]"*.png, *.jpg"[/code] and a [param description] of [code]"Images"[/code] results in filter text "Images (*.png, *.jpg)".
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 22:42:36 +02:00
</description>
</method>
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<method name="add_option">
<return type="void" />
<param index="0" name="name" type="String" />
<param index="1" name="values" type="PackedStringArray" />
[Native File Dialog] Add support for using native dialogs in the editor.
2024-03-21 09:42:38 +01:00
<param index="2" name="default_value_index" type="int" />
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<description>
Adds an additional [OptionButton] to the file dialog. If [param values] is empty, a [CheckBox] is added instead.
[Native File Dialog] Add support for using native dialogs in the editor.
2024-03-21 09:42:38 +01:00
[param default_value_index] should be an index of the value in the [param values]. If [param values] is empty it should be either [code]1[/code] (checked), or [code]0[/code] (unchecked).
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
</description>
</method>
Add filename filter field to FileDialog Added possibility to filter files and folders through a text entry.
2024-02-22 18:34:46 +01:00
<method name="clear_filename_filter">
<return type="void" />
<description>
Clear the filter for file names.
</description>
</method>
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 22:42:36 +02:00
<method name="clear_filters">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
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 22:42:36 +02:00
<description>
Clear all the added filters in the dialog.
</description>
</method>
Rename unselect to deselect
2020-12-21 11:26:41 +01:00
<method name="deselect_all">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source
2017-11-27 23:37:47 +01:00
<description>
Rename unselect to deselect
2020-12-21 11:26:41 +01:00
Clear all currently selected items in the dialog.
doc: Sync classref with current source
2017-11-27 23:37:47 +01:00
</description>
</method>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
<method name="get_line_edit">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="LineEdit" />
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
<description>
Filled missing Doc for String and FileDialog
2018-10-11 19:28:36 +02:00
Returns the LineEdit for the selected file.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</description>
</method>
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<method name="get_option_default" qualifiers="const">
<return type="int" />
<param index="0" name="option" type="int" />
<description>
Returns the default value index of the [OptionButton] or [CheckBox] with index [param option].
</description>
</method>
<method name="get_option_name" qualifiers="const">
<return type="String" />
<param index="0" name="option" type="int" />
<description>
Returns the name of the [OptionButton] or [CheckBox] with index [param option].
</description>
</method>
<method name="get_option_values" qualifiers="const">
<return type="PackedStringArray" />
<param index="0" name="option" type="int" />
<description>
Returns an array of values of the [OptionButton] with index [param option].
</description>
</method>
<method name="get_selected_options" qualifiers="const">
<return type="Dictionary" />
<description>
Returns a [Dictionary] with the selected values of the additional [OptionButton]s and/or [CheckBox]es. [Dictionary] keys are names and values are selected value indices.
</description>
</method>
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 22:42:36 +02:00
<method name="get_vbox">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="VBoxContainer" />
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 22:42:36 +02:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns the vertical box container of the dialog, custom controls can be added to it.
Add warnings to methods that give access to internal nodes
2021-10-10 21:28:56 +02:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] Changes to this node are ignored by native file dialogs, use [method add_option] to add custom elements to the dialog instead.
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 22:42:36 +02:00
</description>
</method>
<method name="invalidate">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
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 22:42:36 +02:00
<description>
Invalidate and update the current dialog content list.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] This method does nothing on native file dialogs.
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 22:42:36 +02:00
</description>
</method>
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<method name="set_option_default">
<return type="void" />
<param index="0" name="option" type="int" />
[Native File Dialog] Add support for using native dialogs in the editor.
2024-03-21 09:42:38 +01:00
<param index="1" name="default_value_index" type="int" />
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<description>
Sets the default value index of the [OptionButton] or [CheckBox] with index [param option].
</description>
</method>
<method name="set_option_name">
<return type="void" />
<param index="0" name="option" type="int" />
<param index="1" name="name" type="String" />
<description>
Sets the name of the [OptionButton] or [CheckBox] with index [param option].
</description>
</method>
<method name="set_option_values">
<return type="void" />
<param index="0" name="option" type="int" />
<param index="1" name="values" type="PackedStringArray" />
<description>
Sets the option values of the [OptionButton] with index [param option].
</description>
</method>
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 22:42:36 +02:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access" default="0">
docs/FileDialog: Use clickable references This replaces two [code][/code] blocks with clickable refs to [enum Access] and [member file_mode] respectively.
2023-04-10 15:13:20 +02:00
The file system access scope. See [enum Access] constants.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Warning:[/b] In Web builds, FileDialog cannot access the host file system. In sandboxed Linux and macOS environments, [member use_native_dialog] is automatically used to allow limited access to host file system.
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 22:42:36 +02:00
</member>
Don't store and show current file/directory/path FileDialog properties These properties are only useful at run-time, so they don't need to be displayed in the editor and stored.
2021-10-29 20:15:33 +02:00
<member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The current working directory of the file dialog.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] For native file dialogs, this property is only treated as a hint and may not be respected by specific OS implementations.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
Don't store and show current file/directory/path FileDialog properties These properties are only useful at run-time, so they don't need to be displayed in the editor and stored.
2021-10-29 20:15:33 +02:00
<member name="current_file" type="String" setter="set_current_file" getter="get_current_file">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The currently selected file of the file dialog.
</member>
Don't store and show current file/directory/path FileDialog properties These properties are only useful at run-time, so they don't need to be displayed in the editor and stored.
2021-10-29 20:15:33 +02:00
<member name="current_path" type="String" setter="set_current_path" getter="get_current_path">
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
The currently selected file path of the file dialog.
</member>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:38:49 +01:00
<member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok" overrides="AcceptDialog" default="false" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<member name="file_mode" type="int" setter="set_file_mode" getter="get_file_mode" enum="FileDialog.FileMode" default="4">
The dialog's open or save mode, which affects the selection behavior. See [enum FileMode].
</member>
Add filename filter field to FileDialog Added possibility to filter files and folders through a text entry.
2024-02-22 18:34:46 +01:00
<member name="filename_filter" type="String" setter="set_filename_filter" getter="get_filename_filter" default="&quot;&quot;">
The filter for file names (case-insensitive). When set to a non-empty string, only files that contains the substring will be shown. [member filename_filter] can be edited by the user with the filter button at the top of the file dialog.
See also [member filters], which should be used to restrict the file types that can be selected instead of [member filename_filter] which is meant to be set by the user.
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="filters" type="PackedStringArray" setter="set_filters" getter="get_filters" default="PackedStringArray()">
Update FileDialog filters documentation
2024-03-04 20:12:22 +01:00
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.
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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title" default="true">
docs/FileDialog: Use clickable references This replaces two [code][/code] blocks with clickable refs to [enum Access] and [member file_mode] respectively.
2023-04-10 15:13:20 +02:00
If [code]true[/code], changing the [member file_mode] property will set the window title accordingly (e.g. setting [member file_mode] to [constant FILE_MODE_OPEN_FILE] will change the window title to "Open a File").
Added "mode_overrides_title" property to FileDialog.
2017-12-03 02:54:06 +01:00
</member>
[Native File Dialog] Add support for adding custom options to the dialogs. Add support for adding custom options (checkboxes and optionboxes) to the dialogs (both native and built-in).
2023-10-13 11:37:46 +02:00
<member name="option_count" type="int" setter="set_option_count" getter="get_option_count" default="0">
The number of additional [OptionButton]s and [CheckBox]es in the dialog.
</member>
Add root_subfolder to FileDialog
2022-03-13 01:35:20 +01:00
<member name="root_subfolder" type="String" setter="set_root_subfolder" getter="get_root_subfolder" default="&quot;&quot;">
If non-empty, the given sub-folder will be "root" of this [FileDialog], i.e. user won't be able to go to its parent directory.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] This property is ignored by native file dialogs.
Add root_subfolder to FileDialog
2022-03-13 01:35:20 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files" default="false">
Filled missing Doc for String and FileDialog
2018-10-11 19:28:36 +02:00
If [code]true[/code], the dialog will show hidden files.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] This property is ignored by native file dialogs on Linux.
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 22:42:36 +02:00
</member>
Fix FileDialog default size
2024-09-14 13:28:39 +02:00
<member name="size" type="Vector2i" setter="set_size" getter="get_size" overrides="Window" default="Vector2i(640, 360)" />
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:38:49 +01:00
<member name="title" type="String" setter="set_title" getter="get_title" overrides="Window" default="&quot;Save a File&quot;" />
[macOS] Implement optional native file selection dialog support for sandboxed apps.
2021-03-30 14:42:50 +02:00
<member name="use_native_dialog" type="bool" setter="set_use_native_dialog" getter="get_use_native_dialog" default="false">
If [code]true[/code], [member access] is set to [constant ACCESS_FILESYSTEM], and it is supported by the current [DisplayServer], OS native dialog will be used instead of custom one.
[Docs] Add some notes about native file dialog limitations.
2024-07-10 08:28:15 +02:00
[b]Note:[/b] On Linux and macOS, sandboxed apps always use native dialogs to access the host file system.
[b]Note:[/b] On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use [method OS.get_granted_permissions] to get a list of saved bookmarks.
[b]Note:[/b] Native dialogs are isolated from the base process, file dialog properties can't be modified once the dialog is shown.
[macOS] Implement optional native file selection dialog support for sandboxed apps.
2021-03-30 14:42:50 +02:00
</member>
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 22:42:36 +02:00
</members>
<signals>
<signal name="dir_selected">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="dir" type="String" />
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 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted when the user selects a directory.
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 22:42:36 +02:00
</description>
</signal>
<signal name="file_selected">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="path" type="String" />
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 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button.
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 22:42:36 +02:00
</description>
</signal>
Add filename filter field to FileDialog Added possibility to filter files and folders through a text entry.
2024-02-22 18:34:46 +01:00
<signal name="filename_filter_changed">
<param index="0" name="filter" type="String" />
<description>
Emitted when the filter for file names changes.
</description>
</signal>
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 22:42:36 +02:00
<signal name="files_selected">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="paths" type="PackedStringArray" />
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 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Emitted when the user selects multiple files.
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 22:42:36 +02:00
</description>
</signal>
</signals>
<constants>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="FILE_MODE_OPEN_FILE" value="0" enum="FileMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog allows selecting one, and only one file.
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 22:42:36 +02:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="FILE_MODE_OPEN_FILES" value="1" enum="FileMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog allows selecting multiple files.
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 22:42:36 +02:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="FILE_MODE_OPEN_DIR" value="2" enum="FileMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog only allows selecting a directory, disallowing the selection of any file.
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 22:42:36 +02:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="FILE_MODE_OPEN_ANY" value="3" enum="FileMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog allows selecting one file or directory.
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 22:42:36 +02:00
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<constant name="FILE_MODE_SAVE_FILE" value="4" enum="FileMode">
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 22:42:36 +02:00
The dialog will warn when a file exists.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ACCESS_RESOURCES" value="0" enum="Access">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog only allows accessing files under the [Resource] path ([code]res://[/code]).
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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ACCESS_USERDATA" value="1" enum="Access">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog only allows accessing files under user data path ([code]user://[/code]).
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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ACCESS_FILESYSTEM" value="2" enum="Access">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
The dialog allows accessing files on the whole file system.
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 22:42:36 +02:00
</constant>
</constants>
<theme_items>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-06 19:09:32 +02:00
<theme_item name="file_disabled_color" data_type="color" type="Color" default="Color(1, 1, 1, 0.25)">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The color tint for disabled files (when the [FileDialog] is used in open folder mode).
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 22:42:36 +02:00
</theme_item>
Improve naming of theme properties throughout GUI code Rename ItemList's bg -> panel Rename ItemList's bg_focus -> focus Rename ProgressBar's bg -> background Rename ProgressBar's fg -> fill Rename Tree's bg -> panel Rename Tree's bg_focus -> focus Rename ScrollContainer's bg -> panel Rename FileDialog's *_icon_modulate -> *_icon_color Rename FileDialog's files_disabled -> file_disabled_color Rename CheckButton's on/off -> checked/unchecked Rename check_v_adjust -> check_v_offset
2022-09-06 19:09:32 +02:00
<theme_item name="file_icon_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
The color modulation applied to the file icon.
</theme_item>
<theme_item name="folder_icon_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The color modulation applied to the folder icon.
Rename FileDialog's folder icon custom color to `folder_icon_modulate` The custom color introduced in be8d569744e4eed9acb313d355d96e6989e92087 had the same name as the "folder" icon, which could cause conflicts in the generated documentation. The new name is also more self-explanatory.
2019-08-21 18:43:01 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="back_folder" data_type="icon" type="Texture2D">
Custom icon for the back arrow.
</theme_item>
Add create folder icon
2024-02-25 17:51:50 +01:00
<theme_item name="create_folder" data_type="icon" type="Texture2D">
Custom icon for the create folder button.
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
<theme_item name="file" data_type="icon" type="Texture2D">
Custom icon for files.
</theme_item>
<theme_item name="folder" data_type="icon" type="Texture2D">
Custom icon for folders.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="forward_folder" data_type="icon" type="Texture2D">
FileDialog: add Back/Forward buttons, add message for inaccessible folders.
2021-03-19 13:01:03 +01:00
Custom icon for the forward arrow.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="parent_folder" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
Custom icon for the parent folder arrow.
doc: Sync classref with current source
2017-12-07 08:23:08 +01:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="reload" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
Custom icon for the reload button.
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 22:42:36 +02:00
</theme_item>
Add filename filter field to FileDialog Added possibility to filter files and folders through a text entry.
2024-02-22 18:34:46 +01:00
<theme_item name="toggle_filename_filter" data_type="icon" type="Texture2D">
Custom icon for the toggle button for the filter for file names.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="toggle_hidden" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
Custom icon for the toggle hidden button.
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:04:55 +02:00
</theme_item>
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 22:42:36 +02:00
</theme_items>
</class>
Reference in a new issue Copy permalink