/**************************************************************************/ /* file_dialog.h */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /**************************************************************************/ #ifndef FILE_DIALOG_H #define FILE_DIALOG_H #include "box_container.h" #include "core/io/dir_access.h" #include "scene/gui/dialogs.h" #include "scene/gui/line_edit.h" #include "scene/gui/option_button.h" #include "scene/gui/tree.h" class FileDialog : public ConfirmationDialog { GDCLASS(FileDialog, ConfirmationDialog); public: enum Access { ACCESS_RESOURCES, ACCESS_USERDATA, ACCESS_FILESYSTEM }; enum FileMode { FILE_MODE_OPEN_FILE, FILE_MODE_OPEN_FILES, FILE_MODE_OPEN_DIR, FILE_MODE_OPEN_ANY, FILE_MODE_SAVE_FILE }; typedef Ref (*GetIconFunc)(const String &); typedef void (*RegisterFunc)(FileDialog *); static GetIconFunc get_icon_func; static RegisterFunc register_func; static RegisterFunc unregister_func; private: ConfirmationDialog *makedialog = nullptr; LineEdit *makedirname = nullptr; Button *makedir = nullptr; Access access = ACCESS_RESOURCES; VBoxContainer *vbox = nullptr; FileMode mode; LineEdit *dir = nullptr; HBoxContainer *drives_container = nullptr; HBoxContainer *shortcuts_container = nullptr; OptionButton *drives = nullptr; Tree *tree = nullptr; HBoxContainer *file_box = nullptr; LineEdit *file = nullptr; OptionButton *filter = nullptr; AcceptDialog *mkdirerr = nullptr; AcceptDialog *exterr = nullptr; Ref dir_access; ConfirmationDialog *confirm_save = nullptr; Label *message = nullptr; Button *dir_prev = nullptr; Button *dir_next = nullptr; Button *dir_up = nullptr; Button *refresh = nullptr; Button *show_hidden = nullptr; Vector filters; Vector local_history; int local_history_pos = 0; void _push_history(); bool mode_overrides_title = true; String root_subfolder; String root_prefix; static bool default_show_hidden_files; bool show_hidden_files = false; bool use_native_dialog = false; bool is_invalidating = false; struct ThemeCache { Ref parent_folder; Ref forward_folder; Ref back_folder; Ref reload; Ref toggle_hidden; Ref folder; Ref file; Color folder_icon_color; Color file_icon_color; Color file_disabled_color; Color icon_normal_color; Color icon_hover_color; Color icon_focus_color; Color icon_pressed_color; } theme_cache; void update_dir(); void update_file_name(); void update_file_list(); void update_filters(); void _focus_file_text(); void _tree_multi_selected(Object *p_object, int p_cell, bool p_selected); void _tree_selected(); void _select_drive(int p_idx); void _tree_item_activated(); void _dir_submitted(String p_dir); void _file_submitted(const String &p_file); void _action_pressed(); void _save_confirm_pressed(); void _cancel_pressed(); void _filter_selected(int); void _make_dir(); void _make_dir_confirm(); void _go_up(); void _go_back(); void _go_forward(); void _change_dir(const String &p_new_dir); void _update_drives(bool p_select = true); void _invalidate(); virtual void shortcut_input(const Ref &p_event) override; void _native_dialog_cb(bool p_ok, const Vector &p_files); bool _is_open_should_be_disabled(); virtual void _post_popup() override; protected: virtual void _update_theme_item_cache() override; void _notification(int p_what); static void _bind_methods(); //bind helpers public: virtual void popup(const Rect2i &p_rect = Rect2i()) override; void popup_file_dialog(); void clear_filters(); void add_filter(const String &p_filter, const String &p_description = ""); void set_filters(const Vector &p_filters); Vector get_filters() const; void set_enable_multiple_selection(bool p_enable); Vector get_selected_files() const; String get_current_dir() const; String get_current_file() const; String get_current_path() const; void set_current_dir(const String &p_dir); void set_current_file(const String &p_file); void set_current_path(const String &p_path); void set_root_subfolder(const String &p_root); String get_root_subfolder() const; void set_mode_overrides_title(bool p_override); bool is_mode_overriding_title() const; void set_use_native_dialog(bool p_native); bool get_use_native_dialog() const; void set_file_mode(FileMode p_mode); FileMode get_file_mode() const; VBoxContainer *get_vbox(); LineEdit *get_line_edit() { return file; } void set_access(Access p_access); Access get_access() const; void set_show_hidden_files(bool p_show); bool is_showing_hidden_files() const; static void set_default_show_hidden_files(bool p_show); void invalidate(); void deselect_all(); FileDialog(); ~FileDialog(); }; VARIANT_ENUM_CAST(FileDialog::FileMode); VARIANT_ENUM_CAST(FileDialog::Access); #endif // FILE_DIALOG_H