diff options
Diffstat (limited to 'doc/classes/FileDialog.xml')
| -rw-r--r-- | doc/classes/FileDialog.xml | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index f8df356da2..e78f21b274 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -15,7 +15,7 @@ <argument index="0" name="filter" type="String"> </argument> <description> - Add a custom filter. Example: [code]add_filter("*.png ; PNG Images")[/code] + Adds [code]filter[/code] as a custom filter; [code]filter[/code] should be of the form [code]"filename.extension ; Description"[/code]. For example, [code]"*.png ; PNG Images"[/code]. </description> </method> <method name="clear_filters"> @@ -55,28 +55,28 @@ </method> </methods> <members> - <member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access"> + <member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access" default="0"> The file system access scope. See enum [code]Access[/code] constants. </member> - <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir"> + <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir" default=""res://""> The current working directory of the file dialog. </member> - <member name="current_file" type="String" setter="set_current_file" getter="get_current_file"> + <member name="current_file" type="String" setter="set_current_file" getter="get_current_file" default=""""> The currently selected file of the file dialog. </member> - <member name="current_path" type="String" setter="set_current_path" getter="get_current_path"> + <member name="current_path" type="String" setter="set_current_path" getter="get_current_path" default=""res://""> The currently selected file path of the file dialog. </member> - <member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters"> - Set file type filters. This example shows only .png and .gd files [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))[/code]. + <member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters" default="PoolStringArray( )"> + The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code]. </member> - <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> - Set dialog to open or save mode, changes selection behavior. See enum [code]Mode[/code] constants. + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode" default="4"> + The dialog's open or save mode, which affects the selection behavior. See enum [code]Mode[/code] constants. </member> - <member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title"> + <member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title" default="true"> If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [constant MODE_OPEN_FILE] will change the window title to "Open a File"). </member> - <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> + <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files" default="false"> If [code]true[/code], the dialog will show hidden files. </member> </members> @@ -85,52 +85,52 @@ <argument index="0" name="dir" type="String"> </argument> <description> - Event emitted when the user selects a directory. + Emitted when the user selects a directory. </description> </signal> <signal name="file_selected"> <argument index="0" name="path" type="String"> </argument> <description> - Event emitted when the user selects a file (double clicks it or presses the OK button). + Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button. </description> </signal> <signal name="files_selected"> <argument index="0" name="paths" type="PoolStringArray"> </argument> <description> - Event emitted when the user selects multiple files. + Emitted when the user selects multiple files. </description> </signal> </signals> <constants> <constant name="MODE_OPEN_FILE" value="0" enum="Mode"> - The dialog allows the selection of one, and only one file. + The dialog allows selecting one, and only one file. </constant> <constant name="MODE_OPEN_FILES" value="1" enum="Mode"> - The dialog allows the selection of multiple files. + The dialog allows selecting multiple files. </constant> <constant name="MODE_OPEN_DIR" value="2" enum="Mode"> - The dialog functions as a folder selector, disallowing the selection of any file. + The dialog only allows selecting a directory, disallowing the selection of any file. </constant> <constant name="MODE_OPEN_ANY" value="3" enum="Mode"> - The dialog allows the selection of a file or a directory. + The dialog allows selecting one file or directory. </constant> <constant name="MODE_SAVE_FILE" value="4" enum="Mode"> The dialog will warn when a file exists. </constant> <constant name="ACCESS_RESOURCES" value="0" enum="Access"> - The dialog allows the selection of file and directory. + The dialog only allows accessing files under the [Resource] path ([code]res://[/code]). </constant> <constant name="ACCESS_USERDATA" value="1" enum="Access"> - The dialog allows access files under [Resource] path(res://) . + The dialog only allows accessing files under user data path ([code]user://[/code]). </constant> <constant name="ACCESS_FILESYSTEM" value="2" enum="Access"> - The dialog allows access files in whole file system. + The dialog allows accessing files on the whole file system. </constant> </constants> <theme_items> - <theme_item name="files_disabled" type="Color"> + <theme_item name="files_disabled" type="Color" default="Color( 0, 0, 0, 0.7 )"> </theme_item> <theme_item name="folder" type="Texture"> </theme_item> |