class_editorfiledialog.rst 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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:`clear_filters<class_EditorFileDialog_clear_filters>` **(** **)** |
  14. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
  16. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`String<class_string>` | :ref:`get_current_dir<class_EditorFileDialog_get_current_dir>` **(** **)** const |
  18. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_current_file<class_EditorFileDialog_get_current_file>` **(** **)** const |
  20. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_string>` | :ref:`get_current_path<class_EditorFileDialog_get_current_path>` **(** **)** const |
  22. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_current_dir<class_EditorFileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
  24. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_current_file<class_EditorFileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
  26. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_current_path<class_EditorFileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
  28. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
  30. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
  32. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
  34. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
  36. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
  38. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
  40. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
  42. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`set_display_mode<class_EditorFileDialog_set_display_mode>` **(** :ref:`int<class_int>` mode **)** |
  44. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
  46. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
  48. +--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
  49. Signals
  50. -------
  51. - **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
  52. - **dir_selected** **(** :ref:`String<class_string>` dir **)**
  53. - **file_selected** **(** :ref:`String<class_string>` path **)**
  54. Numeric Constants
  55. -----------------
  56. - **MODE_OPEN_FILE** = **0**
  57. - **MODE_OPEN_FILES** = **1**
  58. - **MODE_OPEN_DIR** = **2**
  59. - **MODE_SAVE_FILE** = **3**
  60. - **ACCESS_RESOURCES** = **0**
  61. - **ACCESS_USERDATA** = **1**
  62. - **ACCESS_FILESYSTEM** = **2**
  63. Member Function Description
  64. ---------------------------
  65. .. _class_EditorFileDialog_clear_filters:
  66. - void **clear_filters** **(** **)**
  67. .. _class_EditorFileDialog_add_filter:
  68. - void **add_filter** **(** :ref:`String<class_string>` filter **)**
  69. .. _class_EditorFileDialog_get_current_dir:
  70. - :ref:`String<class_string>` **get_current_dir** **(** **)** const
  71. .. _class_EditorFileDialog_get_current_file:
  72. - :ref:`String<class_string>` **get_current_file** **(** **)** const
  73. .. _class_EditorFileDialog_get_current_path:
  74. - :ref:`String<class_string>` **get_current_path** **(** **)** const
  75. .. _class_EditorFileDialog_set_current_dir:
  76. - void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
  77. .. _class_EditorFileDialog_set_current_file:
  78. - void **set_current_file** **(** :ref:`String<class_string>` file **)**
  79. .. _class_EditorFileDialog_set_current_path:
  80. - void **set_current_path** **(** :ref:`String<class_string>` path **)**
  81. .. _class_EditorFileDialog_set_mode:
  82. - void **set_mode** **(** :ref:`int<class_int>` mode **)**
  83. .. _class_EditorFileDialog_get_mode:
  84. - :ref:`int<class_int>` **get_mode** **(** **)** const
  85. .. _class_EditorFileDialog_get_vbox:
  86. - :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
  87. .. _class_EditorFileDialog_set_access:
  88. - void **set_access** **(** :ref:`int<class_int>` access **)**
  89. .. _class_EditorFileDialog_get_access:
  90. - :ref:`int<class_int>` **get_access** **(** **)** const
  91. .. _class_EditorFileDialog_set_show_hidden_files:
  92. - void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
  93. .. _class_EditorFileDialog_is_showing_hidden_files:
  94. - :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
  95. .. _class_EditorFileDialog_set_display_mode:
  96. - void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
  97. .. _class_EditorFileDialog_get_display_mode:
  98. - :ref:`int<class_int>` **get_display_mode** **(** **)** const
  99. .. _class_EditorFileDialog_invalidate:
  100. - void **invalidate** **(** **)**