class_editorfiledialog.rst 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619
  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. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  21. | :ref:`Access<enum_EditorFileDialog_Access>` | :ref:`access<class_EditorFileDialog_property_access>` | ``0`` |
  22. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_String>` | :ref:`current_dir<class_EditorFileDialog_property_current_dir>` | |
  24. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  25. | :ref:`String<class_String>` | :ref:`current_file<class_EditorFileDialog_property_current_file>` | |
  26. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  27. | :ref:`String<class_String>` | :ref:`current_path<class_EditorFileDialog_property_current_path>` | |
  28. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  29. | :ref:`bool<class_bool>` | dialog_hide_on_ok | ``false`` (overrides :ref:`AcceptDialog<class_AcceptDialog_property_dialog_hide_on_ok>`) |
  30. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`disable_overwrite_warning<class_EditorFileDialog_property_disable_overwrite_warning>` | ``false`` |
  32. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  33. | :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` | :ref:`display_mode<class_EditorFileDialog_property_display_mode>` | ``0`` |
  34. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  35. | :ref:`FileMode<enum_EditorFileDialog_FileMode>` | :ref:`file_mode<class_EditorFileDialog_property_file_mode>` | ``4`` |
  36. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  37. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`filters<class_EditorFileDialog_property_filters>` | ``PackedStringArray()`` |
  38. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`option_count<class_EditorFileDialog_property_option_count>` | ``0`` |
  40. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  41. | :ref:`bool<class_bool>` | :ref:`show_hidden_files<class_EditorFileDialog_property_show_hidden_files>` | ``false`` |
  42. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  43. | :ref:`String<class_String>` | title | ``"Save a File"`` (overrides :ref:`Window<class_Window_property_title>`) |
  44. +-------------------------------------------------------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
  45. .. rst-class:: classref-reftable-group
  46. Methods
  47. -------
  48. .. table::
  49. :widths: auto
  50. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`add_filter<class_EditorFileDialog_method_add_filter>`\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ ) |
  52. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |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>`\ ) |
  54. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`add_side_menu<class_EditorFileDialog_method_add_side_menu>`\ (\ menu\: :ref:`Control<class_Control>`, title\: :ref:`String<class_String>` = ""\ ) |
  56. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`clear_filters<class_EditorFileDialog_method_clear_filters>`\ (\ ) |
  58. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`LineEdit<class_LineEdit>` | :ref:`get_line_edit<class_EditorFileDialog_method_get_line_edit>`\ (\ ) |
  60. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`int<class_int>` | :ref:`get_option_default<class_EditorFileDialog_method_get_option_default>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  62. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`String<class_String>` | :ref:`get_option_name<class_EditorFileDialog_method_get_option_name>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  64. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_option_values<class_EditorFileDialog_method_get_option_values>`\ (\ option\: :ref:`int<class_int>`\ ) |const| |
  66. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_selected_options<class_EditorFileDialog_method_get_selected_options>`\ (\ ) |const| |
  68. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`VBoxContainer<class_VBoxContainer>` | :ref:`get_vbox<class_EditorFileDialog_method_get_vbox>`\ (\ ) |
  70. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`invalidate<class_EditorFileDialog_method_invalidate>`\ (\ ) |
  72. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`set_option_default<class_EditorFileDialog_method_set_option_default>`\ (\ option\: :ref:`int<class_int>`, default_value_index\: :ref:`int<class_int>`\ ) |
  74. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`set_option_name<class_EditorFileDialog_method_set_option_name>`\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) |
  76. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | |void| | :ref:`set_option_values<class_EditorFileDialog_method_set_option_values>`\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |
  78. +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. .. rst-class:: classref-section-separator
  80. ----
  81. .. rst-class:: classref-descriptions-group
  82. Signals
  83. -------
  84. .. _class_EditorFileDialog_signal_dir_selected:
  85. .. rst-class:: classref-signal
  86. **dir_selected**\ (\ dir\: :ref:`String<class_String>`\ )
  87. Emitted when a directory is selected.
  88. .. rst-class:: classref-item-separator
  89. ----
  90. .. _class_EditorFileDialog_signal_file_selected:
  91. .. rst-class:: classref-signal
  92. **file_selected**\ (\ path\: :ref:`String<class_String>`\ )
  93. Emitted when a file is selected.
  94. .. rst-class:: classref-item-separator
  95. ----
  96. .. _class_EditorFileDialog_signal_files_selected:
  97. .. rst-class:: classref-signal
  98. **files_selected**\ (\ paths\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
  99. Emitted when multiple files are selected.
  100. .. rst-class:: classref-section-separator
  101. ----
  102. .. rst-class:: classref-descriptions-group
  103. Enumerations
  104. ------------
  105. .. _enum_EditorFileDialog_FileMode:
  106. .. rst-class:: classref-enumeration
  107. enum **FileMode**:
  108. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILE:
  109. .. rst-class:: classref-enumeration-constant
  110. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_FILE** = ``0``
  111. The **EditorFileDialog** can select only one file. Accepting the window will open the file.
  112. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_FILES:
  113. .. rst-class:: classref-enumeration-constant
  114. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_FILES** = ``1``
  115. The **EditorFileDialog** can select multiple files. Accepting the window will open all files.
  116. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_DIR:
  117. .. rst-class:: classref-enumeration-constant
  118. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_DIR** = ``2``
  119. The **EditorFileDialog** can select only one directory. Accepting the window will open the directory.
  120. .. _class_EditorFileDialog_constant_FILE_MODE_OPEN_ANY:
  121. .. rst-class:: classref-enumeration-constant
  122. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_OPEN_ANY** = ``3``
  123. The **EditorFileDialog** can select a file or directory. Accepting the window will open it.
  124. .. _class_EditorFileDialog_constant_FILE_MODE_SAVE_FILE:
  125. .. rst-class:: classref-enumeration-constant
  126. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **FILE_MODE_SAVE_FILE** = ``4``
  127. The **EditorFileDialog** can select only one file. Accepting the window will save the file.
  128. .. rst-class:: classref-item-separator
  129. ----
  130. .. _enum_EditorFileDialog_Access:
  131. .. rst-class:: classref-enumeration
  132. enum **Access**:
  133. .. _class_EditorFileDialog_constant_ACCESS_RESOURCES:
  134. .. rst-class:: classref-enumeration-constant
  135. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_RESOURCES** = ``0``
  136. The **EditorFileDialog** can only view ``res://`` directory contents.
  137. .. _class_EditorFileDialog_constant_ACCESS_USERDATA:
  138. .. rst-class:: classref-enumeration-constant
  139. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_USERDATA** = ``1``
  140. The **EditorFileDialog** can only view ``user://`` directory contents.
  141. .. _class_EditorFileDialog_constant_ACCESS_FILESYSTEM:
  142. .. rst-class:: classref-enumeration-constant
  143. :ref:`Access<enum_EditorFileDialog_Access>` **ACCESS_FILESYSTEM** = ``2``
  144. The **EditorFileDialog** can view the entire local file system.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _enum_EditorFileDialog_DisplayMode:
  148. .. rst-class:: classref-enumeration
  149. enum **DisplayMode**:
  150. .. _class_EditorFileDialog_constant_DISPLAY_THUMBNAILS:
  151. .. rst-class:: classref-enumeration-constant
  152. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **DISPLAY_THUMBNAILS** = ``0``
  153. The **EditorFileDialog** displays resources as thumbnails.
  154. .. _class_EditorFileDialog_constant_DISPLAY_LIST:
  155. .. rst-class:: classref-enumeration-constant
  156. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **DISPLAY_LIST** = ``1``
  157. The **EditorFileDialog** displays resources as a list of filenames.
  158. .. rst-class:: classref-section-separator
  159. ----
  160. .. rst-class:: classref-descriptions-group
  161. Property Descriptions
  162. ---------------------
  163. .. _class_EditorFileDialog_property_access:
  164. .. rst-class:: classref-property
  165. :ref:`Access<enum_EditorFileDialog_Access>` **access** = ``0``
  166. .. rst-class:: classref-property-setget
  167. - |void| **set_access**\ (\ value\: :ref:`Access<enum_EditorFileDialog_Access>`\ )
  168. - :ref:`Access<enum_EditorFileDialog_Access>` **get_access**\ (\ )
  169. The location from which the user may select a file, including ``res://``, ``user://``, and the local file system.
  170. .. rst-class:: classref-item-separator
  171. ----
  172. .. _class_EditorFileDialog_property_current_dir:
  173. .. rst-class:: classref-property
  174. :ref:`String<class_String>` **current_dir**
  175. .. rst-class:: classref-property-setget
  176. - |void| **set_current_dir**\ (\ value\: :ref:`String<class_String>`\ )
  177. - :ref:`String<class_String>` **get_current_dir**\ (\ )
  178. The currently occupied directory.
  179. .. rst-class:: classref-item-separator
  180. ----
  181. .. _class_EditorFileDialog_property_current_file:
  182. .. rst-class:: classref-property
  183. :ref:`String<class_String>` **current_file**
  184. .. rst-class:: classref-property-setget
  185. - |void| **set_current_file**\ (\ value\: :ref:`String<class_String>`\ )
  186. - :ref:`String<class_String>` **get_current_file**\ (\ )
  187. The currently selected file.
  188. .. rst-class:: classref-item-separator
  189. ----
  190. .. _class_EditorFileDialog_property_current_path:
  191. .. rst-class:: classref-property
  192. :ref:`String<class_String>` **current_path**
  193. .. rst-class:: classref-property-setget
  194. - |void| **set_current_path**\ (\ value\: :ref:`String<class_String>`\ )
  195. - :ref:`String<class_String>` **get_current_path**\ (\ )
  196. The file system path in the address bar.
  197. .. rst-class:: classref-item-separator
  198. ----
  199. .. _class_EditorFileDialog_property_disable_overwrite_warning:
  200. .. rst-class:: classref-property
  201. :ref:`bool<class_bool>` **disable_overwrite_warning** = ``false``
  202. .. rst-class:: classref-property-setget
  203. - |void| **set_disable_overwrite_warning**\ (\ value\: :ref:`bool<class_bool>`\ )
  204. - :ref:`bool<class_bool>` **is_overwrite_warning_disabled**\ (\ )
  205. If ``true``, the **EditorFileDialog** will not warn the user before overwriting files.
  206. .. rst-class:: classref-item-separator
  207. ----
  208. .. _class_EditorFileDialog_property_display_mode:
  209. .. rst-class:: classref-property
  210. :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **display_mode** = ``0``
  211. .. rst-class:: classref-property-setget
  212. - |void| **set_display_mode**\ (\ value\: :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>`\ )
  213. - :ref:`DisplayMode<enum_EditorFileDialog_DisplayMode>` **get_display_mode**\ (\ )
  214. The view format in which the **EditorFileDialog** displays resources to the user.
  215. .. rst-class:: classref-item-separator
  216. ----
  217. .. _class_EditorFileDialog_property_file_mode:
  218. .. rst-class:: classref-property
  219. :ref:`FileMode<enum_EditorFileDialog_FileMode>` **file_mode** = ``4``
  220. .. rst-class:: classref-property-setget
  221. - |void| **set_file_mode**\ (\ value\: :ref:`FileMode<enum_EditorFileDialog_FileMode>`\ )
  222. - :ref:`FileMode<enum_EditorFileDialog_FileMode>` **get_file_mode**\ (\ )
  223. The dialog's open or save mode, which affects the selection behavior. See :ref:`FileMode<enum_EditorFileDialog_FileMode>`.
  224. .. rst-class:: classref-item-separator
  225. ----
  226. .. _class_EditorFileDialog_property_filters:
  227. .. rst-class:: classref-property
  228. :ref:`PackedStringArray<class_PackedStringArray>` **filters** = ``PackedStringArray()``
  229. .. rst-class:: classref-property-setget
  230. - |void| **set_filters**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
  231. - :ref:`PackedStringArray<class_PackedStringArray>` **get_filters**\ (\ )
  232. 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.
  233. **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.
  234. .. rst-class:: classref-item-separator
  235. ----
  236. .. _class_EditorFileDialog_property_option_count:
  237. .. rst-class:: classref-property
  238. :ref:`int<class_int>` **option_count** = ``0``
  239. .. rst-class:: classref-property-setget
  240. - |void| **set_option_count**\ (\ value\: :ref:`int<class_int>`\ )
  241. - :ref:`int<class_int>` **get_option_count**\ (\ )
  242. The number of additional :ref:`OptionButton<class_OptionButton>`\ s and :ref:`CheckBox<class_CheckBox>`\ es in the dialog.
  243. .. rst-class:: classref-item-separator
  244. ----
  245. .. _class_EditorFileDialog_property_show_hidden_files:
  246. .. rst-class:: classref-property
  247. :ref:`bool<class_bool>` **show_hidden_files** = ``false``
  248. .. rst-class:: classref-property-setget
  249. - |void| **set_show_hidden_files**\ (\ value\: :ref:`bool<class_bool>`\ )
  250. - :ref:`bool<class_bool>` **is_showing_hidden_files**\ (\ )
  251. 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>`.
  252. .. rst-class:: classref-section-separator
  253. ----
  254. .. rst-class:: classref-descriptions-group
  255. Method Descriptions
  256. -------------------
  257. .. _class_EditorFileDialog_method_add_filter:
  258. .. rst-class:: classref-method
  259. |void| **add_filter**\ (\ filter\: :ref:`String<class_String>`, description\: :ref:`String<class_String>` = ""\ )
  260. Adds a comma-delimited file name ``filter`` option to the **EditorFileDialog** with an optional ``description``, which restricts what files can be picked.
  261. 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.
  262. For example, a ``filter`` of ``"*.tscn, *.scn"`` and a ``description`` of ``"Scenes"`` results in filter text "Scenes (\*.tscn, \*.scn)".
  263. .. rst-class:: classref-item-separator
  264. ----
  265. .. _class_EditorFileDialog_method_add_option:
  266. .. rst-class:: classref-method
  267. |void| **add_option**\ (\ name\: :ref:`String<class_String>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`, default_value_index\: :ref:`int<class_int>`\ )
  268. Adds an additional :ref:`OptionButton<class_OptionButton>` to the file dialog. If ``values`` is empty, a :ref:`CheckBox<class_CheckBox>` is added instead.
  269. \ ``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).
  270. .. rst-class:: classref-item-separator
  271. ----
  272. .. _class_EditorFileDialog_method_add_side_menu:
  273. .. rst-class:: classref-method
  274. |void| **add_side_menu**\ (\ menu\: :ref:`Control<class_Control>`, title\: :ref:`String<class_String>` = ""\ )
  275. Adds the given ``menu`` to the side of the file dialog with the given ``title`` text on top. Only one side menu is allowed.
  276. .. rst-class:: classref-item-separator
  277. ----
  278. .. _class_EditorFileDialog_method_clear_filters:
  279. .. rst-class:: classref-method
  280. |void| **clear_filters**\ (\ )
  281. Removes all filters except for "All Files (\*)".
  282. .. rst-class:: classref-item-separator
  283. ----
  284. .. _class_EditorFileDialog_method_get_line_edit:
  285. .. rst-class:: classref-method
  286. :ref:`LineEdit<class_LineEdit>` **get_line_edit**\ (\ )
  287. Returns the LineEdit for the selected file.
  288. \ **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.
  289. .. rst-class:: classref-item-separator
  290. ----
  291. .. _class_EditorFileDialog_method_get_option_default:
  292. .. rst-class:: classref-method
  293. :ref:`int<class_int>` **get_option_default**\ (\ option\: :ref:`int<class_int>`\ ) |const|
  294. Returns the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  295. .. rst-class:: classref-item-separator
  296. ----
  297. .. _class_EditorFileDialog_method_get_option_name:
  298. .. rst-class:: classref-method
  299. :ref:`String<class_String>` **get_option_name**\ (\ option\: :ref:`int<class_int>`\ ) |const|
  300. Returns the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  301. .. rst-class:: classref-item-separator
  302. ----
  303. .. _class_EditorFileDialog_method_get_option_values:
  304. .. rst-class:: classref-method
  305. :ref:`PackedStringArray<class_PackedStringArray>` **get_option_values**\ (\ option\: :ref:`int<class_int>`\ ) |const|
  306. Returns an array of values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
  307. .. rst-class:: classref-item-separator
  308. ----
  309. .. _class_EditorFileDialog_method_get_selected_options:
  310. .. rst-class:: classref-method
  311. :ref:`Dictionary<class_Dictionary>` **get_selected_options**\ (\ ) |const|
  312. 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.
  313. .. rst-class:: classref-item-separator
  314. ----
  315. .. _class_EditorFileDialog_method_get_vbox:
  316. .. rst-class:: classref-method
  317. :ref:`VBoxContainer<class_VBoxContainer>` **get_vbox**\ (\ )
  318. Returns the :ref:`VBoxContainer<class_VBoxContainer>` used to display the file system.
  319. \ **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.
  320. .. rst-class:: classref-item-separator
  321. ----
  322. .. _class_EditorFileDialog_method_invalidate:
  323. .. rst-class:: classref-method
  324. |void| **invalidate**\ (\ )
  325. Notify the **EditorFileDialog** that its view of the data is no longer accurate. Updates the view contents on next view update.
  326. .. rst-class:: classref-item-separator
  327. ----
  328. .. _class_EditorFileDialog_method_set_option_default:
  329. .. rst-class:: classref-method
  330. |void| **set_option_default**\ (\ option\: :ref:`int<class_int>`, default_value_index\: :ref:`int<class_int>`\ )
  331. Sets the default value index of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  332. .. rst-class:: classref-item-separator
  333. ----
  334. .. _class_EditorFileDialog_method_set_option_name:
  335. .. rst-class:: classref-method
  336. |void| **set_option_name**\ (\ option\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ )
  337. Sets the name of the :ref:`OptionButton<class_OptionButton>` or :ref:`CheckBox<class_CheckBox>` with index ``option``.
  338. .. rst-class:: classref-item-separator
  339. ----
  340. .. _class_EditorFileDialog_method_set_option_values:
  341. .. rst-class:: classref-method
  342. |void| **set_option_values**\ (\ option\: :ref:`int<class_int>`, values\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
  343. Sets the option values of the :ref:`OptionButton<class_OptionButton>` with index ``option``.
  344. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  345. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  346. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  347. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  348. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  349. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  350. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  351. .. |void| replace:: :abbr:`void (No return value.)`