class_editorfiledialog.rst 33 KB

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