class_editorfiledialog.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_EditorFileDialog:
  4. EditorFileDialog
  5. ================
  6. **Inherits:** :ref:`ConfirmationDialog<class_confirmationdialog>` **<** :ref:`AcceptDialog<class_acceptdialog>` **<** :ref:`WindowDialog<class_windowdialog>` **<** :ref:`Popup<class_popup>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
  14. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`clear_filters<class_EditorFileDialog_clear_filters>` **(** **)** |
  16. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
  18. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_current_dir<class_EditorFileDialog_get_current_dir>` **(** **)** const |
  20. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_string>` | :ref:`get_current_file<class_EditorFileDialog_get_current_file>` **(** **)** const |
  22. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_string>` | :ref:`get_current_path<class_EditorFileDialog_get_current_path>` **(** **)** const |
  24. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
  26. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
  28. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
  30. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
  32. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`is_overwrite_warning_disabled<class_EditorFileDialog_is_overwrite_warning_disabled>` **(** **)** const |
  34. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
  36. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
  38. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`set_current_dir<class_EditorFileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
  40. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  41. | void | :ref:`set_current_file<class_EditorFileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
  42. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`set_current_path<class_EditorFileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
  44. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`set_disable_overwrite_warning<class_EditorFileDialog_set_disable_overwrite_warning>` **(** :ref:`bool<class_bool>` disable **)** |
  46. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`set_display_mode<class_EditorFileDialog_set_display_mode>` **(** :ref:`int<class_int>` mode **)** |
  48. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
  50. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
  52. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  53. Signals
  54. -------
  55. - **dir_selected** **(** :ref:`String<class_string>` dir **)**
  56. - **file_selected** **(** :ref:`String<class_string>` path **)**
  57. - **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
  58. Numeric Constants
  59. -----------------
  60. - **MODE_OPEN_FILE** = **0**
  61. - **MODE_OPEN_FILES** = **1**
  62. - **MODE_OPEN_DIR** = **2**
  63. - **MODE_OPEN_ANY** = **3**
  64. - **MODE_SAVE_FILE** = **4**
  65. - **ACCESS_RESOURCES** = **0**
  66. - **ACCESS_USERDATA** = **1**
  67. - **ACCESS_FILESYSTEM** = **2**
  68. Member Function Description
  69. ---------------------------
  70. .. _class_EditorFileDialog_add_filter:
  71. - void **add_filter** **(** :ref:`String<class_string>` filter **)**
  72. .. _class_EditorFileDialog_clear_filters:
  73. - void **clear_filters** **(** **)**
  74. .. _class_EditorFileDialog_get_access:
  75. - :ref:`int<class_int>` **get_access** **(** **)** const
  76. .. _class_EditorFileDialog_get_current_dir:
  77. - :ref:`String<class_string>` **get_current_dir** **(** **)** const
  78. .. _class_EditorFileDialog_get_current_file:
  79. - :ref:`String<class_string>` **get_current_file** **(** **)** const
  80. .. _class_EditorFileDialog_get_current_path:
  81. - :ref:`String<class_string>` **get_current_path** **(** **)** const
  82. .. _class_EditorFileDialog_get_display_mode:
  83. - :ref:`int<class_int>` **get_display_mode** **(** **)** const
  84. .. _class_EditorFileDialog_get_mode:
  85. - :ref:`int<class_int>` **get_mode** **(** **)** const
  86. .. _class_EditorFileDialog_get_vbox:
  87. - :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
  88. .. _class_EditorFileDialog_invalidate:
  89. - void **invalidate** **(** **)**
  90. .. _class_EditorFileDialog_is_overwrite_warning_disabled:
  91. - :ref:`bool<class_bool>` **is_overwrite_warning_disabled** **(** **)** const
  92. .. _class_EditorFileDialog_is_showing_hidden_files:
  93. - :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
  94. .. _class_EditorFileDialog_set_access:
  95. - void **set_access** **(** :ref:`int<class_int>` access **)**
  96. .. _class_EditorFileDialog_set_current_dir:
  97. - void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
  98. .. _class_EditorFileDialog_set_current_file:
  99. - void **set_current_file** **(** :ref:`String<class_string>` file **)**
  100. .. _class_EditorFileDialog_set_current_path:
  101. - void **set_current_path** **(** :ref:`String<class_string>` path **)**
  102. .. _class_EditorFileDialog_set_disable_overwrite_warning:
  103. - void **set_disable_overwrite_warning** **(** :ref:`bool<class_bool>` disable **)**
  104. .. _class_EditorFileDialog_set_display_mode:
  105. - void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
  106. .. _class_EditorFileDialog_set_mode:
  107. - void **set_mode** **(** :ref:`int<class_int>` mode **)**
  108. .. _class_EditorFileDialog_set_show_hidden_files:
  109. - void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**