class_editorfiledialog.rst 11 KB

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