class_editorfiledialog.rst 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorFileDialog.xml.
  6. .. _class_EditorFileDialog:
  7. EditorFileDialog
  8. ================
  9. **Inherits:** :ref:`ConfirmationDialog<class_ConfirmationDialog>` **<** :ref:`AcceptDialog<class_AcceptDialog>` **<** :ref:`Window<class_Window>` **<** :ref:`Viewport<class_Viewport>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A modified version of :ref:`FileDialog<class_FileDialog>` used by the editor.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **EditorFileDialog** is an enhanced version of :ref:`FileDialog<class_FileDialog>` available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list.
  15. Unlike :ref:`FileDialog<class_FileDialog>`, **EditorFileDialog** does not have a property for using native dialogs. Instead, native dialogs can be enabled globally via the :ref:`EditorSettings.interface/editor/use_native_file_dialogs<class_EditorSettings_property_interface/editor/use_native_file_dialogs>` editor setting. They are also enabled automatically when running in sandbox (e.g. on macOS).
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  22. | :ref:`Access<enum_EditorFileDialog_Access>` | :ref:`access<class_EditorFileDialog_property_access>` | ``0`` |
  23. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`current_dir<class_EditorFileDialog_property_current_dir>` | |
  25. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  26. | :ref:`String<class_String>` | :ref:`current_file<class_EditorFileDialog_property_current_file>` | |
  27. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  28. | :ref:`String<class_String>` | :ref:`current_path<class_EditorFileDialog_property_current_path>` | |
  29. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  30. | :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
  31. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`disable_overwrite_warning<class_EditorFileDialog_property_disable_overwrite_warning>` | ``false`` |
  33. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  34. | :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` | :ref:`display_mode<class_EditorFileDialog_property_display_mode>` | ``0`` |
  35. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  36. | :ref:`FileMode<enum_EditorFileDialog_FileMode>` | :ref:`file_mode<class_EditorFileDialog_property_file_mode>` | ``4`` |
  37. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  38. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`filters<class_EditorFileDialog_property_filters>` | ``PackedStringArray()`` |
  39. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`option_count<class_EditorFileDialog_property_option_count>` | ``0`` |
  41. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  42. | :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_EditorFileDialog_property_show_hidden_files>` | ``false`` |
  43. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  44. | :ref:`String<class_String>` | title | ``"Save a File"`` (overrides :ref:`Window<class_Window_property_title>`) |
  45. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  46. .. rst-class:: classref-reftable-group
  47. Methods
  48. -------
  49. .. table::
  50. :widths: auto
  51. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | |void| | :ref:`add_filter<class_EditorFileDialog_method_add_filter>`\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) |
  53. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | |void| | :ref:`add_option<class_EditorFileDialog_method_add_option>`\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ ) |
  55. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | |void| | :ref:`add_side_menu<class_EditorFileDialog_method_add_side_menu>`\ (\ menu\: :ref:`Control<class_Control>`, title\: :ref:`String<class_String>` = ""\ ) |
  57. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | |void| | :ref:`clear_filename_filter<class_EditorFileDialog_method_clear_filename_filter>`\ (\ ) |
  59. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | |void| | :ref:`clear_filters<class_EditorFileDialog_method_clear_filters>`\ (\ ) |
  61. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`String<class_String>` | :ref:`get_filename_filter<class_EditorFileDialog_method_get_filename_filter>`\ (\ ) |const| |
  63. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_EditorFileDialog_method_get_line_edit>`\ (\ ) |
  65. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`int<class_int>` | :ref:`get_option_default<class_EditorFileDialog_method_get_option_default>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  67. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`String<class_String>` | :ref:`get_option_name<class_EditorFileDialog_method_get_option_name>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  69. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_EditorFileDialog_method_get_option_values>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  71. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_EditorFileDialog_method_get_selected_options>`\ (\ ) |const| |
  73. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_EditorFileDialog_method_get_vbox>`\ (\ ) |
  75. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`invalidate<class_EditorFileDialog_method_invalidate>`\ (\ ) |
  77. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | |void| | :ref:`popup_file_dialog<class_EditorFileDialog_method_popup_file_dialog>`\ (\ ) |
  79. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | |void| | :ref:`set_filename_filter<class_EditorFileDialog_method_set_filename_filter>`\ (\ filter\: :ref:`String<class_String>`\ ) |
  81. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | |void| | :ref:`set_option_default<class_EditorFileDialog_method_set_option_default>`\ (\ option\: :ref:`int<class_int>`, default_value_index\: :ref:`int<class_int>`\ ) |
  83. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | |void| | :ref:`set_option_name<class_EditorFileDialog_method_set_option_name>`\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
  85. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`set_option_values<class_EditorFileDialog_method_set_option_values>`\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |
  87. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. .. rst-class:: classref-section-separator
  89. ----
  90. .. rst-class:: classref-descriptions-group
  91. Signals
  92. -------
  93. .. _class_EditorFileDialog_signal_dir_selected:
  94. .. rst-class:: classref-signal
  95. **dir_selected**\ (\ dir\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorFileDialog_signal_dir_selected>`
  96. Emitted when a directory is selected.
  97. .. rst-class:: classref-item-separator
  98. ----
  99. .. _class_EditorFileDialog_signal_file_selected:
  100. .. rst-class:: classref-signal
  101. **file_selected**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorFileDialog_signal_file_selected>`
  102. Emitted when a file is selected.
  103. .. rst-class:: classref-item-separator
  104. ----
  105. .. _class_EditorFileDialog_signal_filename_filter_changed:
  106. .. rst-class:: classref-signal
  107. **filename_filter_changed**\ (\ filter\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorFileDialog_signal_filename_filter_changed>`
  108. Emitted when the filter for file names changes.
  109. .. rst-class:: classref-item-separator
  110. ----
  111. .. _class_EditorFileDialog_signal_files_selected:
  112. .. rst-class:: classref-signal
  113. **files_selected**\ (\ paths\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) :ref:`🔗<class_EditorFileDialog_signal_files_selected>`
  114. Emitted when multiple files are selected.
  115. .. rst-class:: classref-section-separator
  116. ----
  117. .. rst-class:: classref-descriptions-group
  118. Enumerations
  119. ------------
  120. .. _enum_EditorFileDialog_FileMode:
  121. .. rst-class:: classref-enumeration
  122. enum **FileMode**: :ref:`🔗<enum_EditorFileDialog_FileMode>`
  123. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE:
  124. .. rst-class:: classref-enumeration-constant
  125. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_FILE** = ``0``
  126. The **EditorFileDialog** can select only one file. Accepting the window will open the file.
  127. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILES:
  128. .. rst-class:: classref-enumeration-constant
  129. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_FILES** = ``1``
  130. The **EditorFileDialog** can select multiple files. Accepting the window will open all files.
  131. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_DIR:
  132. .. rst-class:: classref-enumeration-constant
  133. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_DIR** = ``2``
  134. The **EditorFileDialog** can select only one directory. Accepting the window will open the directory.
  135. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_ANY:
  136. .. rst-class:: classref-enumeration-constant
  137. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_ANY** = ``3``
  138. The **EditorFileDialog** can select a file or directory. Accepting the window will open it.
  139. .. _class_EditorFileDialog_constant_FILE_MODE_SAVE_FILE:
  140. .. rst-class:: classref-enumeration-constant
  141. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_SAVE_FILE** = ``4``
  142. The **EditorFileDialog** can select only one file. Accepting the window will save the file.
  143. .. rst-class:: classref-item-separator
  144. ----
  145. .. _enum_EditorFileDialog_Access:
  146. .. rst-class:: classref-enumeration
  147. enum **Access**: :ref:`🔗<enum_EditorFileDialog_Access>`
  148. .. _class_EditorFileDialog_constant_ACCESS_RESOURCES:
  149. .. rst-class:: classref-enumeration-constant
  150. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_RESOURCES** = ``0``
  151. The **EditorFileDialog** can only view ``res://`` directory contents.
  152. .. _class_EditorFileDialog_constant_ACCESS_USERDATA:
  153. .. rst-class:: classref-enumeration-constant
  154. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_USERDATA** = ``1``
  155. The **EditorFileDialog** can only view ``user://`` directory contents.
  156. .. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM:
  157. .. rst-class:: classref-enumeration-constant
  158. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_FILESYSTEM** = ``2``
  159. The **EditorFileDialog** can view the entire local file system.
  160. .. rst-class:: classref-item-separator
  161. ----
  162. .. _enum_EditorFileDialog_DisplayMode:
  163. .. rst-class:: classref-enumeration
  164. enum **DisplayMode**: :ref:`🔗<enum_EditorFileDialog_DisplayMode>`
  165. .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS:
  166. .. rst-class:: classref-enumeration-constant
  167. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **DISPLAY_THUMBNAILS** = ``0``
  168. The **EditorFileDialog** displays resources as thumbnails.
  169. .. _class_EditorFileDialog_constant_DISPLAY_LIST:
  170. .. rst-class:: classref-enumeration-constant
  171. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **DISPLAY_LIST** = ``1``
  172. The **EditorFileDialog** displays resources as a list of filenames.
  173. .. rst-class:: classref-section-separator
  174. ----
  175. .. rst-class:: classref-descriptions-group
  176. Property Descriptions
  177. ---------------------
  178. .. _class_EditorFileDialog_property_access:
  179. .. rst-class:: classref-property
  180. :ref:`Access<enum_EditorFileDialog_Access>` **access** = ``0`` :ref:`🔗<class_EditorFileDialog_property_access>`
  181. .. rst-class:: classref-property-setget
  182. - |void| **set_access**\ (\ value\: :ref:`Access<enum_EditorFileDialog_Access>`\ )
  183. - :ref:`Access<enum_EditorFileDialog_Access>` **get_access**\ (\ )
  184. The location from which the user may select a file, including ``res://``, ``user://``, and the local file system.
  185. .. rst-class:: classref-item-separator
  186. ----
  187. .. _class_EditorFileDialog_property_current_dir:
  188. .. rst-class:: classref-property
  189. :ref:`String<class_String>` **current_dir** :ref:`🔗<class_EditorFileDialog_property_current_dir>`
  190. .. rst-class:: classref-property-setget
  191. - |void| **set_current_dir**\ (\ value\: :ref:`String<class_String>`\ )
  192. - :ref:`String<class_String>` **get_current_dir**\ (\ )
  193. The currently occupied directory.
  194. .. rst-class:: classref-item-separator
  195. ----
  196. .. _class_EditorFileDialog_property_current_file:
  197. .. rst-class:: classref-property
  198. :ref:`String<class_String>` **current_file** :ref:`🔗<class_EditorFileDialog_property_current_file>`
  199. .. rst-class:: classref-property-setget
  200. - |void| **set_current_file**\ (\ value\: :ref:`String<class_String>`\ )
  201. - :ref:`String<class_String>` **get_current_file**\ (\ )
  202. The currently selected file.
  203. .. rst-class:: classref-item-separator
  204. ----
  205. .. _class_EditorFileDialog_property_current_path:
  206. .. rst-class:: classref-property
  207. :ref:`String<class_String>` **current_path** :ref:`🔗<class_EditorFileDialog_property_current_path>`
  208. .. rst-class:: classref-property-setget
  209. - |void| **set_current_path**\ (\ value\: :ref:`String<class_String>`\ )
  210. - :ref:`String<class_String>` **get_current_path**\ (\ )
  211. The file system path in the address bar.
  212. .. rst-class:: classref-item-separator
  213. ----
  214. .. _class_EditorFileDialog_property_disable_overwrite_warning:
  215. .. rst-class:: classref-property
  216. :ref:`bool<class_bool>` **disable_overwrite_warning** = ``false`` :ref:`🔗<class_EditorFileDialog_property_disable_overwrite_warning>`
  217. .. rst-class:: classref-property-setget
  218. - |void| **set_disable_overwrite_warning**\ (\ value\: :ref:`bool<class_bool>`\ )
  219. - :ref:`bool<class_bool>` **is_overwrite_warning_disabled**\ (\ )
  220. If ``true``, the **EditorFileDialog** will not warn the user before overwriting files.
  221. .. rst-class:: classref-item-separator
  222. ----
  223. .. _class_EditorFileDialog_property_display_mode:
  224. .. rst-class:: classref-property
  225. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **display_mode** = ``0`` :ref:`🔗<class_EditorFileDialog_property_display_mode>`
  226. .. rst-class:: classref-property-setget
  227. - |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>`\ )
  228. - :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **get_display_mode**\ (\ )
  229. The view format in which the **EditorFileDialog** displays resources to the user.
  230. .. rst-class:: classref-item-separator
  231. ----
  232. .. _class_EditorFileDialog_property_file_mode:
  233. .. rst-class:: classref-property
  234. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **file_mode** = ``4`` :ref:`🔗<class_EditorFileDialog_property_file_mode>`
  235. .. rst-class:: classref-property-setget
  236. - |void| **set_file_mode**\ (\ value\: :ref:`FileMode<enum_EditorFileDialog_FileMode>`\ )
  237. - :ref:`FileMode<enum_EditorFileDialog_FileMode>` **get_file_mode**\ (\ )
  238. The dialog's open or save mode, which affects the selection behavior.
  239. .. rst-class:: classref-item-separator
  240. ----
  241. .. _class_EditorFileDialog_property_filters:
  242. .. rst-class:: classref-property
  243. :ref:`PackedStringArray<class_PackedStringArray>` **filters** = ``PackedStringArray()`` :ref:`🔗<class_EditorFileDialog_property_filters>`
  244. .. rst-class:: classref-property-setget
  245. - |void| **set_filters**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
  246. - :ref:`PackedStringArray<class_PackedStringArray>` **get_filters**\ (\ )
  247. The available file type filters. For example, this shows only ``.png`` and ``.gd`` files: ``set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))``. Multiple file types can also be specified in a single filter. ``"*.png, *.jpg, *.jpeg ; Supported Images"`` will show both PNG and JPEG files when selected.
  248. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray<class_PackedStringArray>` for more details.
  249. .. rst-class:: classref-item-separator
  250. ----
  251. .. _class_EditorFileDialog_property_option_count:
  252. .. rst-class:: classref-property
  253. :ref:`int<class_int>` **option_count** = ``0`` :ref:`🔗<class_EditorFileDialog_property_option_count>`
  254. .. rst-class:: classref-property-setget
  255. - |void| **set_option_count**\ (\ value\: :ref:`int<class_int>`\ )
  256. - :ref:`int<class_int>` **get_option_count**\ (\ )
  257. The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`CheckBox<class_CheckBox>`\ es in the dialog.
  258. .. rst-class:: classref-item-separator
  259. ----
  260. .. _class_EditorFileDialog_property_show_hidden_files:
  261. .. rst-class:: classref-property
  262. :ref:`bool<class_bool>` **show_hidden_files** = ``false`` :ref:`🔗<class_EditorFileDialog_property_show_hidden_files>`
  263. .. rst-class:: classref-property-setget
  264. - |void| **set_show_hidden_files**\ (\ value\: :ref:`bool<class_bool>`\ )
  265. - :ref:`bool<class_bool>` **is_showing_hidden_files**\ (\ )
  266. If ``true``, hidden files and directories will be visible in the **EditorFileDialog**. This property is synchronized with :ref:`EditorSettings.filesystem/file_dialog/show_hidden_files<class_EditorSettings_property_filesystem/file_dialog/show_hidden_files>`.
  267. .. rst-class:: classref-section-separator
  268. ----
  269. .. rst-class:: classref-descriptions-group
  270. Method Descriptions
  271. -------------------
  272. .. _class_EditorFileDialog_method_add_filter:
  273. .. rst-class:: classref-method
  274. |void| **add_filter**\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_EditorFileDialog_method_add_filter>`
  275. Adds a comma-separated file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked.
  276. A ``filter`` should be of the form ``"filename.extension"``, where filename and extension can be ``*`` to match any string. Filters starting with ``.`` (i.e. empty filenames) are not allowed.
  277. For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)".
  278. .. rst-class:: classref-item-separator
  279. ----
  280. .. _class_EditorFileDialog_method_add_option:
  281. .. rst-class:: classref-method
  282. |void| **add_option**\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_EditorFileDialog_method_add_option>`
  283. Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
  284. \ ``default_value_index`` should be an index of the value in the ``values``. If ``values`` is empty it should be either ``1`` (checked), or ``0`` (unchecked).
  285. .. rst-class:: classref-item-separator
  286. ----
  287. .. _class_EditorFileDialog_method_add_side_menu:
  288. .. rst-class:: classref-method
  289. |void| **add_side_menu**\ (\ menu\: :ref:`Control<class_Control>`, title\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_EditorFileDialog_method_add_side_menu>`
  290. **Deprecated:** This feature is no longer supported.
  291. This method is kept for compatibility and does nothing. As an alternative, you can display another dialog after showing the file dialog.
  292. .. rst-class:: classref-item-separator
  293. ----
  294. .. _class_EditorFileDialog_method_clear_filename_filter:
  295. .. rst-class:: classref-method
  296. |void| **clear_filename_filter**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_clear_filename_filter>`
  297. Clear the filter for file names.
  298. .. rst-class:: classref-item-separator
  299. ----
  300. .. _class_EditorFileDialog_method_clear_filters:
  301. .. rst-class:: classref-method
  302. |void| **clear_filters**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_clear_filters>`
  303. Removes all filters except for "All Files (\*.\*)".
  304. .. rst-class:: classref-item-separator
  305. ----
  306. .. _class_EditorFileDialog_method_get_filename_filter:
  307. .. rst-class:: classref-method
  308. :ref:`String<class_String>` **get_filename_filter**\ (\ ) |const| :ref:`🔗<class_EditorFileDialog_method_get_filename_filter>`
  309. Returns the value of the filter for file names.
  310. .. rst-class:: classref-item-separator
  311. ----
  312. .. _class_EditorFileDialog_method_get_line_edit:
  313. .. rst-class:: classref-method
  314. :ref:`LineEdit<class_LineEdit>` **get_line_edit**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_get_line_edit>`
  315. Returns the LineEdit for the selected file.
  316. \ **Warning:** 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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
  317. .. rst-class:: classref-item-separator
  318. ----
  319. .. _class_EditorFileDialog_method_get_option_default:
  320. .. rst-class:: classref-method
  321. :ref:`int<class_int>` **get_option_default**\ (\ option\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_EditorFileDialog_method_get_option_default>`
  322. Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  323. .. rst-class:: classref-item-separator
  324. ----
  325. .. _class_EditorFileDialog_method_get_option_name:
  326. .. rst-class:: classref-method
  327. :ref:`String<class_String>` **get_option_name**\ (\ option\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_EditorFileDialog_method_get_option_name>`
  328. Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  329. .. rst-class:: classref-item-separator
  330. ----
  331. .. _class_EditorFileDialog_method_get_option_values:
  332. .. rst-class:: classref-method
  333. :ref:`PackedStringArray<class_PackedStringArray>` **get_option_values**\ (\ option\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_EditorFileDialog_method_get_option_values>`
  334. Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
  335. .. rst-class:: classref-item-separator
  336. ----
  337. .. _class_EditorFileDialog_method_get_selected_options:
  338. .. rst-class:: classref-method
  339. :ref:`Dictionary<class_Dictionary>` **get_selected_options**\ (\ ) |const| :ref:`🔗<class_EditorFileDialog_method_get_selected_options>`
  340. Returns a :ref:`Dictionary<class_Dictionary>` with the selected values of the additional :ref:`OptionButton<class_OptionButton>`\ s and/or :ref:`CheckBox<class_CheckBox>`\ es. :ref:`Dictionary<class_Dictionary>` keys are names and values are selected value indices.
  341. .. rst-class:: classref-item-separator
  342. ----
  343. .. _class_EditorFileDialog_method_get_vbox:
  344. .. rst-class:: classref-method
  345. :ref:`VBoxContainer<class_VBoxContainer>` **get_vbox**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_get_vbox>`
  346. Returns the :ref:`VBoxContainer<class_VBoxContainer>` used to display the file system.
  347. \ **Warning:** 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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.
  348. .. rst-class:: classref-item-separator
  349. ----
  350. .. _class_EditorFileDialog_method_invalidate:
  351. .. rst-class:: classref-method
  352. |void| **invalidate**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_invalidate>`
  353. Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update.
  354. .. rst-class:: classref-item-separator
  355. ----
  356. .. _class_EditorFileDialog_method_popup_file_dialog:
  357. .. rst-class:: classref-method
  358. |void| **popup_file_dialog**\ (\ ) :ref:`🔗<class_EditorFileDialog_method_popup_file_dialog>`
  359. Shows the **EditorFileDialog** at the default size and position for file dialogs in the editor, and selects the file name if there is a current file.
  360. .. rst-class:: classref-item-separator
  361. ----
  362. .. _class_EditorFileDialog_method_set_filename_filter:
  363. .. rst-class:: classref-method
  364. |void| **set_filename_filter**\ (\ filter\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorFileDialog_method_set_filename_filter>`
  365. Sets the value of the filter for file names.
  366. .. rst-class:: classref-item-separator
  367. ----
  368. .. _class_EditorFileDialog_method_set_option_default:
  369. .. rst-class:: classref-method
  370. |void| **set_option_default**\ (\ option\: :ref:`int<class_int>`, default_value_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_EditorFileDialog_method_set_option_default>`
  371. Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  372. .. rst-class:: classref-item-separator
  373. ----
  374. .. _class_EditorFileDialog_method_set_option_name:
  375. .. rst-class:: classref-method
  376. |void| **set_option_name**\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_EditorFileDialog_method_set_option_name>`
  377. Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  378. .. rst-class:: classref-item-separator
  379. ----
  380. .. _class_EditorFileDialog_method_set_option_values:
  381. .. rst-class:: classref-method
  382. |void| **set_option_values**\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) :ref:`🔗<class_EditorFileDialog_method_set_option_values>`
  383. Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
  384. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  385. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  386. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  387. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  388. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  389. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  390. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  391. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  392. .. |void| replace:: :abbr:`void (No return value.)`