summaryrefslogtreecommitdiff
path: root/doc/classes/FileDialog.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/FileDialog.xml')
-rw-r--r--doc/classes/FileDialog.xml52
1 files changed, 21 insertions, 31 deletions
diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml
index 966be0a981..22b5c72fa9 100644
--- a/doc/classes/FileDialog.xml
+++ b/doc/classes/FileDialog.xml
@@ -10,45 +10,38 @@
</tutorials>
<methods>
<method name="add_filter">
- <return type="void">
- </return>
- <argument index="0" name="filter" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="filter" type="String" />
<description>
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">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clear all the added filters in the dialog.
</description>
</method>
<method name="deselect_all">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clear all currently selected items in the dialog.
</description>
</method>
<method name="get_line_edit">
- <return type="LineEdit">
- </return>
+ <return type="LineEdit" />
<description>
Returns the LineEdit for the selected file.
</description>
</method>
<method name="get_vbox">
- <return type="VBoxContainer">
- </return>
+ <return type="VBoxContainer" />
<description>
Returns the vertical box container of the dialog, custom controls can be added to it.
</description>
</method>
<method name="invalidate">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Invalidate and update the current dialog content list.
</description>
@@ -72,7 +65,7 @@
<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>
- <member name="filters" type="PackedStringArray" setter="set_filters" getter="get_filters" default="PackedStringArray( )">
+ <member name="filters" type="PackedStringArray" setter="set_filters" getter="get_filters" default="PackedStringArray()">
The available file type filters. For example, this shows only [code].png[/code] and [code].gd[/code] files: [code]set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))[/code].
</member>
<member name="mode_overrides_title" type="bool" setter="set_mode_overrides_title" getter="is_mode_overriding_title" default="true">
@@ -85,22 +78,19 @@
</members>
<signals>
<signal name="dir_selected">
- <argument index="0" name="dir" type="String">
- </argument>
+ <argument index="0" name="dir" type="String" />
<description>
Emitted when the user selects a directory.
</description>
</signal>
<signal name="file_selected">
- <argument index="0" name="path" type="String">
- </argument>
+ <argument index="0" name="path" type="String" />
<description>
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="PackedStringArray">
- </argument>
+ <argument index="0" name="paths" type="PackedStringArray" />
<description>
Emitted when the user selects multiple files.
</description>
@@ -133,34 +123,34 @@
</constant>
</constants>
<theme_items>
- <theme_item name="back_folder" type="Texture2D">
+ <theme_item name="back_folder" data_type="icon" type="Texture2D">
Custom icon for the back arrow.
</theme_item>
- <theme_item name="file" type="Texture2D">
+ <theme_item name="file" data_type="icon" type="Texture2D">
Custom icon for files.
</theme_item>
- <theme_item name="file_icon_modulate" type="Color" default="Color( 1, 1, 1, 1 )">
+ <theme_item name="file_icon_modulate" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
The color modulation applied to the file icon.
</theme_item>
- <theme_item name="files_disabled" type="Color" default="Color( 0, 0, 0, 0.7 )">
+ <theme_item name="files_disabled" data_type="color" type="Color" default="Color(0, 0, 0, 0.7)">
The color tint for disabled files (when the [FileDialog] is used in open folder mode).
</theme_item>
- <theme_item name="folder" type="Texture2D">
+ <theme_item name="folder" data_type="icon" type="Texture2D">
Custom icon for folders.
</theme_item>
- <theme_item name="folder_icon_modulate" type="Color" default="Color( 1, 1, 1, 1 )">
+ <theme_item name="folder_icon_modulate" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
The color modulation applied to the folder icon.
</theme_item>
- <theme_item name="forward_folder" type="Texture2D">
+ <theme_item name="forward_folder" data_type="icon" type="Texture2D">
Custom icon for the forward arrow.
</theme_item>
- <theme_item name="parent_folder" type="Texture2D">
+ <theme_item name="parent_folder" data_type="icon" type="Texture2D">
Custom icon for the parent folder arrow.
</theme_item>
- <theme_item name="reload" type="Texture2D">
+ <theme_item name="reload" data_type="icon" type="Texture2D">
Custom icon for the reload button.
</theme_item>
- <theme_item name="toggle_hidden" type="Texture2D">
+ <theme_item name="toggle_hidden" data_type="icon" type="Texture2D">
Custom icon for the toggle hidden button.
</theme_item>
</theme_items>