4f8d7cae26
This also tweaks EditorFileDialog to use the same shortcut, while making it select the path text after focusing (like in most file managers). Ctrl + L / Cmd + Shift + G can also now be used to focus on the property name in the project settings editor, as well in the Input Map, Autoload, Shader Globals and Global Groups tabs.
1546 lines
48 KiB
C++
1546 lines
48 KiB
C++
/**************************************************************************/
|
|
/* file_dialog.cpp */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#include "file_dialog.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/os/keyboard.h"
|
|
#include "core/string/print_string.h"
|
|
#include "scene/gui/check_box.h"
|
|
#include "scene/gui/grid_container.h"
|
|
#include "scene/gui/label.h"
|
|
#include "scene/gui/option_button.h"
|
|
#include "scene/theme/theme_db.h"
|
|
|
|
FileDialog::GetIconFunc FileDialog::get_icon_func = nullptr;
|
|
|
|
FileDialog::RegisterFunc FileDialog::register_func = nullptr;
|
|
FileDialog::RegisterFunc FileDialog::unregister_func = nullptr;
|
|
|
|
void FileDialog::popup_file_dialog() {
|
|
popup_centered_clamped(Size2i(700, 500), 0.8f);
|
|
_focus_file_text();
|
|
}
|
|
|
|
void FileDialog::_focus_file_text() {
|
|
int lp = file->get_text().rfind(".");
|
|
if (lp != -1) {
|
|
file->select(0, lp);
|
|
if (file->is_inside_tree() && !get_tree()->is_node_being_edited(file)) {
|
|
file->grab_focus();
|
|
}
|
|
}
|
|
}
|
|
|
|
void FileDialog::popup(const Rect2i &p_rect) {
|
|
_update_option_controls();
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
if (is_part_of_edited_scene()) {
|
|
ConfirmationDialog::popup(p_rect);
|
|
}
|
|
#endif
|
|
|
|
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG) && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
|
|
String root;
|
|
if (access == ACCESS_RESOURCES) {
|
|
root = ProjectSettings::get_singleton()->get_resource_path();
|
|
} else if (access == ACCESS_USERDATA) {
|
|
root = OS::get_singleton()->get_user_data_dir();
|
|
}
|
|
DisplayServer::get_singleton()->file_dialog_with_options_show(get_title(), ProjectSettings::get_singleton()->globalize_path(dir->get_text()), root, file->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), filters, _get_options(), callable_mp(this, &FileDialog::_native_dialog_cb));
|
|
} else {
|
|
ConfirmationDialog::popup(p_rect);
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_visible(bool p_visible) {
|
|
_update_option_controls();
|
|
|
|
#ifdef TOOLS_ENABLED
|
|
if (is_part_of_edited_scene()) {
|
|
ConfirmationDialog::set_visible(p_visible);
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_NATIVE_DIALOG) && (use_native_dialog || OS::get_singleton()->is_sandboxed())) {
|
|
if (p_visible) {
|
|
String root;
|
|
if (access == ACCESS_RESOURCES) {
|
|
root = ProjectSettings::get_singleton()->get_resource_path();
|
|
} else if (access == ACCESS_USERDATA) {
|
|
root = OS::get_singleton()->get_user_data_dir();
|
|
}
|
|
DisplayServer::get_singleton()->file_dialog_with_options_show(get_title(), ProjectSettings::get_singleton()->globalize_path(dir->get_text()), root, file->get_text().get_file(), show_hidden_files, DisplayServer::FileDialogMode(mode), filters, _get_options(), callable_mp(this, &FileDialog::_native_dialog_cb));
|
|
}
|
|
} else {
|
|
ConfirmationDialog::set_visible(p_visible);
|
|
}
|
|
}
|
|
|
|
void FileDialog::_native_dialog_cb(bool p_ok, const Vector<String> &p_files, int p_filter, const Dictionary &p_selected_options) {
|
|
if (p_ok) {
|
|
if (p_files.size() > 0) {
|
|
Vector<String> files = p_files;
|
|
if (access != ACCESS_FILESYSTEM) {
|
|
for (String &file_name : files) {
|
|
file_name = ProjectSettings::get_singleton()->localize_path(file_name);
|
|
}
|
|
}
|
|
String f = files[0];
|
|
if (mode == FILE_MODE_OPEN_FILES) {
|
|
emit_signal(SNAME("files_selected"), files);
|
|
} else {
|
|
if (mode == FILE_MODE_SAVE_FILE) {
|
|
if (p_filter >= 0 && p_filter < filters.size()) {
|
|
bool valid = false;
|
|
String flt = filters[p_filter].get_slice(";", 0);
|
|
int filter_slice_count = flt.get_slice_count(",");
|
|
for (int j = 0; j < filter_slice_count; j++) {
|
|
String str = (flt.get_slice(",", j).strip_edges());
|
|
if (f.match(str)) {
|
|
valid = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!valid && filter_slice_count > 0) {
|
|
String str = (flt.get_slice(",", 0).strip_edges());
|
|
f += str.substr(1, str.length() - 1);
|
|
}
|
|
}
|
|
emit_signal(SNAME("file_selected"), f);
|
|
} else if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
|
|
emit_signal(SNAME("file_selected"), f);
|
|
} else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
|
|
emit_signal(SNAME("dir_selected"), f);
|
|
}
|
|
}
|
|
file->set_text(f);
|
|
dir->set_text(f.get_base_dir());
|
|
selected_options = p_selected_options;
|
|
filter->select(p_filter);
|
|
}
|
|
} else {
|
|
file->set_text("");
|
|
emit_signal(SNAME("canceled"));
|
|
}
|
|
}
|
|
|
|
VBoxContainer *FileDialog::get_vbox() {
|
|
return vbox;
|
|
}
|
|
|
|
void FileDialog::_validate_property(PropertyInfo &p_property) const {
|
|
if (p_property.name == "dialog_text") {
|
|
// File dialogs have a custom layout, and dialog nodes can't have both a text and a layout.
|
|
p_property.usage = PROPERTY_USAGE_NONE;
|
|
}
|
|
}
|
|
|
|
void FileDialog::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_VISIBILITY_CHANGED: {
|
|
if (!is_visible()) {
|
|
set_process_shortcut_input(false);
|
|
}
|
|
|
|
invalidate(); // Put it here to preview in the editor.
|
|
} break;
|
|
|
|
case NOTIFICATION_THEME_CHANGED: {
|
|
dir_up->set_icon(theme_cache.parent_folder);
|
|
if (vbox->is_layout_rtl()) {
|
|
dir_prev->set_icon(theme_cache.forward_folder);
|
|
dir_next->set_icon(theme_cache.back_folder);
|
|
} else {
|
|
dir_prev->set_icon(theme_cache.back_folder);
|
|
dir_next->set_icon(theme_cache.forward_folder);
|
|
}
|
|
refresh->set_icon(theme_cache.reload);
|
|
show_hidden->set_icon(theme_cache.toggle_hidden);
|
|
makedir->set_icon(theme_cache.create_folder);
|
|
|
|
dir_up->begin_bulk_theme_override();
|
|
dir_up->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
|
|
dir_up->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
|
|
dir_up->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
dir_up->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
|
|
dir_up->end_bulk_theme_override();
|
|
|
|
dir_prev->begin_bulk_theme_override();
|
|
dir_prev->add_theme_color_override("icon_color_normal", theme_cache.icon_normal_color);
|
|
dir_prev->add_theme_color_override("icon_color_hover", theme_cache.icon_hover_color);
|
|
dir_prev->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
dir_prev->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
|
|
dir_prev->end_bulk_theme_override();
|
|
|
|
dir_next->begin_bulk_theme_override();
|
|
dir_next->add_theme_color_override("icon_color_normal", theme_cache.icon_normal_color);
|
|
dir_next->add_theme_color_override("icon_color_hover", theme_cache.icon_hover_color);
|
|
dir_next->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
dir_next->add_theme_color_override("icon_color_pressed", theme_cache.icon_pressed_color);
|
|
dir_next->end_bulk_theme_override();
|
|
|
|
refresh->begin_bulk_theme_override();
|
|
refresh->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
|
|
refresh->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
|
|
refresh->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
refresh->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
|
|
refresh->end_bulk_theme_override();
|
|
|
|
show_hidden->begin_bulk_theme_override();
|
|
show_hidden->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
|
|
show_hidden->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
|
|
show_hidden->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
show_hidden->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
|
|
show_hidden->end_bulk_theme_override();
|
|
|
|
makedir->begin_bulk_theme_override();
|
|
makedir->add_theme_color_override("icon_normal_color", theme_cache.icon_normal_color);
|
|
makedir->add_theme_color_override("icon_hover_color", theme_cache.icon_hover_color);
|
|
makedir->add_theme_color_override("icon_focus_color", theme_cache.icon_focus_color);
|
|
makedir->add_theme_color_override("icon_pressed_color", theme_cache.icon_pressed_color);
|
|
makedir->end_bulk_theme_override();
|
|
|
|
invalidate();
|
|
} break;
|
|
|
|
case NOTIFICATION_TRANSLATION_CHANGED: {
|
|
update_filters();
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void FileDialog::shortcut_input(const Ref<InputEvent> &p_event) {
|
|
ERR_FAIL_COND(p_event.is_null());
|
|
|
|
Ref<InputEventKey> k = p_event;
|
|
if (k.is_valid() && has_focus()) {
|
|
if (k->is_pressed()) {
|
|
bool handled = true;
|
|
|
|
switch (k->get_keycode()) {
|
|
case Key::H: {
|
|
if (k->is_command_or_control_pressed()) {
|
|
set_show_hidden_files(!show_hidden_files);
|
|
} else {
|
|
handled = false;
|
|
}
|
|
|
|
} break;
|
|
case Key::F5: {
|
|
invalidate();
|
|
} break;
|
|
case Key::BACKSPACE: {
|
|
_dir_submitted("..");
|
|
} break;
|
|
#ifdef MACOS_ENABLED
|
|
// Cmd + Shift + G (matches Finder's "Go To" shortcut).
|
|
case Key::G: {
|
|
if (k->is_command_or_control_pressed() && k->is_shift_pressed()) {
|
|
dir->grab_focus();
|
|
dir->select_all();
|
|
} else {
|
|
handled = false;
|
|
}
|
|
} break;
|
|
#endif
|
|
// Ctrl + L (matches most Windows/Linux file managers' "focus on path bar" shortcut,
|
|
// plus macOS Safari's "focus on address bar" shortcut).
|
|
case Key::L: {
|
|
if (k->is_command_or_control_pressed()) {
|
|
dir->grab_focus();
|
|
dir->select_all();
|
|
} else {
|
|
handled = false;
|
|
}
|
|
} break;
|
|
default: {
|
|
handled = false;
|
|
}
|
|
}
|
|
|
|
if (handled) {
|
|
set_input_as_handled();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_enable_multiple_selection(bool p_enable) {
|
|
tree->set_select_mode(p_enable ? Tree::SELECT_MULTI : Tree::SELECT_SINGLE);
|
|
}
|
|
|
|
Vector<String> FileDialog::get_selected_files() const {
|
|
Vector<String> list;
|
|
|
|
TreeItem *item = tree->get_root();
|
|
item = tree->get_next_selected(item);
|
|
while (item) {
|
|
list.push_back(dir_access->get_current_dir().path_join(item->get_text(0)));
|
|
item = tree->get_next_selected(item);
|
|
}
|
|
|
|
return list;
|
|
}
|
|
|
|
void FileDialog::update_dir() {
|
|
if (root_prefix.is_empty()) {
|
|
dir->set_text(dir_access->get_current_dir(false));
|
|
} else {
|
|
dir->set_text(dir_access->get_current_dir(false).trim_prefix(root_prefix).trim_prefix("/"));
|
|
}
|
|
|
|
if (drives->is_visible()) {
|
|
if (dir_access->get_current_dir().is_network_share_path()) {
|
|
_update_drives(false);
|
|
drives->add_item(ETR("Network"));
|
|
drives->set_item_disabled(-1, true);
|
|
drives->select(drives->get_item_count() - 1);
|
|
} else {
|
|
drives->select(dir_access->get_current_drive());
|
|
}
|
|
}
|
|
|
|
// Deselect any item, to make "Select Current Folder" button text by default.
|
|
deselect_all();
|
|
}
|
|
|
|
void FileDialog::_dir_submitted(String p_dir) {
|
|
_change_dir(root_prefix.path_join(p_dir));
|
|
file->set_text("");
|
|
_push_history();
|
|
}
|
|
|
|
void FileDialog::_file_submitted(const String &p_file) {
|
|
_action_pressed();
|
|
}
|
|
|
|
void FileDialog::_save_confirm_pressed() {
|
|
String f = dir_access->get_current_dir().path_join(file->get_text());
|
|
emit_signal(SNAME("file_selected"), f);
|
|
hide();
|
|
}
|
|
|
|
void FileDialog::_post_popup() {
|
|
ConfirmationDialog::_post_popup();
|
|
if (mode == FILE_MODE_SAVE_FILE) {
|
|
file->grab_focus();
|
|
} else {
|
|
tree->grab_focus();
|
|
}
|
|
|
|
set_process_shortcut_input(true);
|
|
|
|
// For open dir mode, deselect all items on file dialog open.
|
|
if (mode == FILE_MODE_OPEN_DIR) {
|
|
deselect_all();
|
|
file_box->set_visible(false);
|
|
} else {
|
|
file_box->set_visible(true);
|
|
}
|
|
|
|
local_history.clear();
|
|
local_history_pos = -1;
|
|
_push_history();
|
|
}
|
|
|
|
void FileDialog::_push_history() {
|
|
local_history.resize(local_history_pos + 1);
|
|
String new_path = dir_access->get_current_dir();
|
|
if (local_history.size() == 0 || new_path != local_history[local_history_pos]) {
|
|
local_history.push_back(new_path);
|
|
local_history_pos++;
|
|
dir_prev->set_disabled(local_history_pos == 0);
|
|
dir_next->set_disabled(true);
|
|
}
|
|
}
|
|
|
|
void FileDialog::_action_pressed() {
|
|
if (mode == FILE_MODE_OPEN_FILES) {
|
|
TreeItem *ti = tree->get_next_selected(nullptr);
|
|
String fbase = dir_access->get_current_dir();
|
|
|
|
Vector<String> files;
|
|
while (ti) {
|
|
files.push_back(fbase.path_join(ti->get_text(0)));
|
|
ti = tree->get_next_selected(ti);
|
|
}
|
|
|
|
if (files.size()) {
|
|
emit_signal(SNAME("files_selected"), files);
|
|
hide();
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
String file_text = file->get_text();
|
|
String f = file_text.is_absolute_path() ? file_text : dir_access->get_current_dir().path_join(file_text);
|
|
|
|
if ((mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_FILE) && dir_access->file_exists(f)) {
|
|
emit_signal(SNAME("file_selected"), f);
|
|
hide();
|
|
} else if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_OPEN_DIR) {
|
|
String path = dir_access->get_current_dir();
|
|
|
|
path = path.replace("\\", "/");
|
|
TreeItem *item = tree->get_selected();
|
|
if (item) {
|
|
Dictionary d = item->get_metadata(0);
|
|
if (d["dir"] && d["name"] != "..") {
|
|
path = path.path_join(d["name"]);
|
|
}
|
|
}
|
|
|
|
emit_signal(SNAME("dir_selected"), path);
|
|
hide();
|
|
}
|
|
|
|
if (mode == FILE_MODE_SAVE_FILE) {
|
|
bool valid = false;
|
|
|
|
if (filter->get_selected() == filter->get_item_count() - 1) {
|
|
valid = true; // match none
|
|
} else if (filters.size() > 1 && filter->get_selected() == 0) {
|
|
// match all filters
|
|
for (int i = 0; i < filters.size(); i++) {
|
|
String flt = filters[i].get_slice(";", 0);
|
|
for (int j = 0; j < flt.get_slice_count(","); j++) {
|
|
String str = flt.get_slice(",", j).strip_edges();
|
|
if (f.match(str)) {
|
|
valid = true;
|
|
break;
|
|
}
|
|
}
|
|
if (valid) {
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
int idx = filter->get_selected();
|
|
if (filters.size() > 1) {
|
|
idx--;
|
|
}
|
|
if (idx >= 0 && idx < filters.size()) {
|
|
String flt = filters[idx].get_slice(";", 0);
|
|
int filterSliceCount = flt.get_slice_count(",");
|
|
for (int j = 0; j < filterSliceCount; j++) {
|
|
String str = (flt.get_slice(",", j).strip_edges());
|
|
if (f.match(str)) {
|
|
valid = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!valid && filterSliceCount > 0) {
|
|
String str = (flt.get_slice(",", 0).strip_edges());
|
|
f += str.substr(1, str.length() - 1);
|
|
file->set_text(f.get_file());
|
|
valid = true;
|
|
}
|
|
} else {
|
|
valid = true;
|
|
}
|
|
}
|
|
|
|
String file_name = file_text.strip_edges().get_file();
|
|
if (!valid || file_name.is_empty()) {
|
|
exterr->popup_centered(Size2(250, 80));
|
|
return;
|
|
}
|
|
|
|
if (dir_access->file_exists(f)) {
|
|
confirm_save->set_text(vformat(atr(ETR("File \"%s\" already exists.\nDo you want to overwrite it?")), f));
|
|
confirm_save->popup_centered(Size2(250, 80));
|
|
} else {
|
|
emit_signal(SNAME("file_selected"), f);
|
|
hide();
|
|
}
|
|
}
|
|
}
|
|
|
|
void FileDialog::_cancel_pressed() {
|
|
file->set_text("");
|
|
invalidate();
|
|
hide();
|
|
}
|
|
|
|
bool FileDialog::_is_open_should_be_disabled() {
|
|
if (mode == FILE_MODE_OPEN_ANY || mode == FILE_MODE_SAVE_FILE) {
|
|
return false;
|
|
}
|
|
|
|
TreeItem *ti = tree->get_next_selected(tree->get_root());
|
|
while (ti) {
|
|
TreeItem *prev_ti = ti;
|
|
ti = tree->get_next_selected(tree->get_root());
|
|
if (ti == prev_ti) {
|
|
break;
|
|
}
|
|
}
|
|
// We have something that we can't select?
|
|
if (!ti) {
|
|
return mode != FILE_MODE_OPEN_DIR; // In "Open folder" mode, having nothing selected picks the current folder.
|
|
}
|
|
|
|
Dictionary d = ti->get_metadata(0);
|
|
|
|
// Opening a file, but selected a folder? Forbidden.
|
|
return ((mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES) && d["dir"]) || // Flipped case, also forbidden.
|
|
(mode == FILE_MODE_OPEN_DIR && !d["dir"]);
|
|
}
|
|
|
|
void FileDialog::_go_up() {
|
|
_change_dir("..");
|
|
_push_history();
|
|
}
|
|
|
|
void FileDialog::_go_back() {
|
|
if (local_history_pos <= 0) {
|
|
return;
|
|
}
|
|
|
|
local_history_pos--;
|
|
_change_dir(local_history[local_history_pos]);
|
|
|
|
dir_prev->set_disabled(local_history_pos == 0);
|
|
dir_next->set_disabled(local_history_pos == local_history.size() - 1);
|
|
}
|
|
|
|
void FileDialog::_go_forward() {
|
|
if (local_history_pos >= local_history.size() - 1) {
|
|
return;
|
|
}
|
|
|
|
local_history_pos++;
|
|
_change_dir(local_history[local_history_pos]);
|
|
|
|
dir_prev->set_disabled(local_history_pos == 0);
|
|
dir_next->set_disabled(local_history_pos == local_history.size() - 1);
|
|
}
|
|
|
|
void FileDialog::deselect_all() {
|
|
// Clear currently selected items in file manager.
|
|
tree->deselect_all();
|
|
|
|
// And change get_ok title.
|
|
if (!tree->is_anything_selected()) {
|
|
get_ok_button()->set_disabled(_is_open_should_be_disabled());
|
|
|
|
switch (mode) {
|
|
case FILE_MODE_OPEN_FILE:
|
|
case FILE_MODE_OPEN_FILES:
|
|
set_ok_button_text(ETR("Open"));
|
|
break;
|
|
case FILE_MODE_OPEN_DIR:
|
|
set_ok_button_text(ETR("Select Current Folder"));
|
|
break;
|
|
case FILE_MODE_OPEN_ANY:
|
|
case FILE_MODE_SAVE_FILE:
|
|
// FIXME: Implement, or refactor to avoid duplication with set_mode
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
void FileDialog::_tree_multi_selected(Object *p_object, int p_cell, bool p_selected) {
|
|
_tree_selected();
|
|
}
|
|
|
|
void FileDialog::_tree_selected() {
|
|
TreeItem *ti = tree->get_selected();
|
|
if (!ti) {
|
|
return;
|
|
}
|
|
Dictionary d = ti->get_metadata(0);
|
|
|
|
if (!d["dir"]) {
|
|
file->set_text(d["name"]);
|
|
} else if (mode == FILE_MODE_OPEN_DIR) {
|
|
set_ok_button_text(ETR("Select This Folder"));
|
|
}
|
|
|
|
get_ok_button()->set_disabled(_is_open_should_be_disabled());
|
|
}
|
|
|
|
void FileDialog::_tree_item_activated() {
|
|
TreeItem *ti = tree->get_selected();
|
|
if (!ti) {
|
|
return;
|
|
}
|
|
|
|
Dictionary d = ti->get_metadata(0);
|
|
|
|
if (d["dir"]) {
|
|
_change_dir(d["name"]);
|
|
if (mode == FILE_MODE_OPEN_FILE || mode == FILE_MODE_OPEN_FILES || mode == FILE_MODE_OPEN_DIR || mode == FILE_MODE_OPEN_ANY) {
|
|
file->set_text("");
|
|
}
|
|
_push_history();
|
|
} else {
|
|
_action_pressed();
|
|
}
|
|
}
|
|
|
|
void FileDialog::update_file_name() {
|
|
int idx = filter->get_selected() - 1;
|
|
if ((idx == -1 && filter->get_item_count() == 2) || (filter->get_item_count() > 2 && idx >= 0 && idx < filter->get_item_count() - 2)) {
|
|
if (idx == -1) {
|
|
idx += 1;
|
|
}
|
|
String filter_str = filters[idx];
|
|
String file_str = file->get_text();
|
|
String base_name = file_str.get_basename();
|
|
Vector<String> filter_substr = filter_str.split(";");
|
|
if (filter_substr.size() >= 2) {
|
|
file_str = base_name + "." + filter_substr[0].strip_edges().get_extension().to_lower();
|
|
} else {
|
|
file_str = base_name + "." + filter_str.strip_edges().get_extension().to_lower();
|
|
}
|
|
file->set_text(file_str);
|
|
}
|
|
}
|
|
|
|
void FileDialog::update_file_list() {
|
|
tree->clear();
|
|
|
|
// Scroll back to the top after opening a directory
|
|
tree->get_vscroll_bar()->set_value(0);
|
|
|
|
dir_access->list_dir_begin();
|
|
|
|
if (dir_access->is_readable(dir_access->get_current_dir().utf8().get_data())) {
|
|
message->hide();
|
|
} else {
|
|
message->set_text(ETR("You don't have permission to access contents of this folder."));
|
|
message->show();
|
|
}
|
|
|
|
TreeItem *root = tree->create_item();
|
|
List<String> files;
|
|
List<String> dirs;
|
|
|
|
bool is_hidden;
|
|
String item = dir_access->get_next();
|
|
|
|
while (!item.is_empty()) {
|
|
if (item == "." || item == "..") {
|
|
item = dir_access->get_next();
|
|
continue;
|
|
}
|
|
|
|
is_hidden = dir_access->current_is_hidden();
|
|
|
|
if (show_hidden_files || !is_hidden) {
|
|
if (!dir_access->current_is_dir()) {
|
|
files.push_back(item);
|
|
} else {
|
|
dirs.push_back(item);
|
|
}
|
|
}
|
|
item = dir_access->get_next();
|
|
}
|
|
|
|
dirs.sort_custom<NaturalNoCaseComparator>();
|
|
files.sort_custom<NaturalNoCaseComparator>();
|
|
|
|
while (!dirs.is_empty()) {
|
|
String &dir_name = dirs.front()->get();
|
|
TreeItem *ti = tree->create_item(root);
|
|
ti->set_text(0, dir_name);
|
|
ti->set_icon(0, theme_cache.folder);
|
|
ti->set_icon_modulate(0, theme_cache.folder_icon_color);
|
|
|
|
Dictionary d;
|
|
d["name"] = dir_name;
|
|
d["dir"] = true;
|
|
|
|
ti->set_metadata(0, d);
|
|
|
|
dirs.pop_front();
|
|
}
|
|
|
|
List<String> patterns;
|
|
// build filter
|
|
if (filter->get_selected() == filter->get_item_count() - 1) {
|
|
// match all
|
|
} else if (filters.size() > 1 && filter->get_selected() == 0) {
|
|
// match all filters
|
|
for (int i = 0; i < filters.size(); i++) {
|
|
String f = filters[i].get_slice(";", 0);
|
|
for (int j = 0; j < f.get_slice_count(","); j++) {
|
|
patterns.push_back(f.get_slice(",", j).strip_edges());
|
|
}
|
|
}
|
|
} else {
|
|
int idx = filter->get_selected();
|
|
if (filters.size() > 1) {
|
|
idx--;
|
|
}
|
|
|
|
if (idx >= 0 && idx < filters.size()) {
|
|
String f = filters[idx].get_slice(";", 0);
|
|
for (int j = 0; j < f.get_slice_count(","); j++) {
|
|
patterns.push_back(f.get_slice(",", j).strip_edges());
|
|
}
|
|
}
|
|
}
|
|
|
|
String base_dir = dir_access->get_current_dir();
|
|
|
|
while (!files.is_empty()) {
|
|
bool match = patterns.is_empty();
|
|
String match_str;
|
|
|
|
for (const String &E : patterns) {
|
|
if (files.front()->get().matchn(E)) {
|
|
match_str = E;
|
|
match = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (match) {
|
|
TreeItem *ti = tree->create_item(root);
|
|
ti->set_text(0, files.front()->get());
|
|
|
|
if (get_icon_func) {
|
|
Ref<Texture2D> icon = get_icon_func(base_dir.path_join(files.front()->get()));
|
|
ti->set_icon(0, icon);
|
|
} else {
|
|
ti->set_icon(0, theme_cache.file);
|
|
}
|
|
ti->set_icon_modulate(0, theme_cache.file_icon_color);
|
|
|
|
if (mode == FILE_MODE_OPEN_DIR) {
|
|
ti->set_custom_color(0, theme_cache.file_disabled_color);
|
|
ti->set_selectable(0, false);
|
|
}
|
|
Dictionary d;
|
|
d["name"] = files.front()->get();
|
|
d["dir"] = false;
|
|
ti->set_metadata(0, d);
|
|
|
|
if (file->get_text() == files.front()->get() || match_str == files.front()->get()) {
|
|
ti->select(0);
|
|
}
|
|
}
|
|
|
|
files.pop_front();
|
|
}
|
|
|
|
if (mode != FILE_MODE_SAVE_FILE && mode != FILE_MODE_OPEN_DIR) {
|
|
// Select the first file from list if nothing is selected.
|
|
if (tree->get_root() && tree->get_root()->get_first_child() && tree->get_selected() == nullptr) {
|
|
tree->get_root()->get_first_child()->select(0);
|
|
}
|
|
}
|
|
}
|
|
|
|
void FileDialog::_filter_selected(int) {
|
|
update_file_name();
|
|
update_file_list();
|
|
}
|
|
|
|
void FileDialog::update_filters() {
|
|
filter->clear();
|
|
|
|
if (filters.size() > 1) {
|
|
String all_filters;
|
|
|
|
const int max_filters = 5;
|
|
|
|
for (int i = 0; i < MIN(max_filters, filters.size()); i++) {
|
|
String flt = filters[i].get_slice(";", 0).strip_edges();
|
|
if (i > 0) {
|
|
all_filters += ", ";
|
|
}
|
|
all_filters += flt;
|
|
}
|
|
|
|
if (max_filters < filters.size()) {
|
|
all_filters += ", ...";
|
|
}
|
|
|
|
filter->add_item(atr(ETR("All Recognized")) + " (" + all_filters + ")");
|
|
}
|
|
for (int i = 0; i < filters.size(); i++) {
|
|
String flt = filters[i].get_slice(";", 0).strip_edges();
|
|
String desc = filters[i].get_slice(";", 1).strip_edges();
|
|
if (desc.length()) {
|
|
filter->add_item(String(tr(desc)) + " (" + flt + ")");
|
|
} else {
|
|
filter->add_item("(" + flt + ")");
|
|
}
|
|
}
|
|
|
|
filter->add_item(atr(ETR("All Files")) + " (*)");
|
|
}
|
|
|
|
void FileDialog::clear_filters() {
|
|
filters.clear();
|
|
update_filters();
|
|
invalidate();
|
|
}
|
|
|
|
void FileDialog::add_filter(const String &p_filter, const String &p_description) {
|
|
ERR_FAIL_COND_MSG(p_filter.begins_with("."), "Filter must be \"filename.extension\", can't start with dot.");
|
|
if (p_description.is_empty()) {
|
|
filters.push_back(p_filter);
|
|
} else {
|
|
filters.push_back(vformat("%s ; %s", p_filter, p_description));
|
|
}
|
|
update_filters();
|
|
invalidate();
|
|
}
|
|
|
|
void FileDialog::set_filters(const Vector<String> &p_filters) {
|
|
if (filters == p_filters) {
|
|
return;
|
|
}
|
|
filters = p_filters;
|
|
update_filters();
|
|
invalidate();
|
|
}
|
|
|
|
Vector<String> FileDialog::get_filters() const {
|
|
return filters;
|
|
}
|
|
|
|
String FileDialog::get_current_dir() const {
|
|
return dir->get_text();
|
|
}
|
|
|
|
String FileDialog::get_current_file() const {
|
|
return file->get_text();
|
|
}
|
|
|
|
String FileDialog::get_current_path() const {
|
|
return dir->get_text().path_join(file->get_text());
|
|
}
|
|
|
|
void FileDialog::set_current_dir(const String &p_dir) {
|
|
_change_dir(p_dir);
|
|
|
|
_push_history();
|
|
}
|
|
|
|
void FileDialog::set_current_file(const String &p_file) {
|
|
if (file->get_text() == p_file) {
|
|
return;
|
|
}
|
|
file->set_text(p_file);
|
|
update_dir();
|
|
invalidate();
|
|
_focus_file_text();
|
|
}
|
|
|
|
void FileDialog::set_current_path(const String &p_path) {
|
|
if (!p_path.size()) {
|
|
return;
|
|
}
|
|
int pos = MAX(p_path.rfind("/"), p_path.rfind("\\"));
|
|
if (pos == -1) {
|
|
set_current_file(p_path);
|
|
} else {
|
|
String path_dir = p_path.substr(0, pos);
|
|
String path_file = p_path.substr(pos + 1, p_path.length());
|
|
set_current_dir(path_dir);
|
|
set_current_file(path_file);
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_root_subfolder(const String &p_root) {
|
|
root_subfolder = p_root;
|
|
ERR_FAIL_COND_MSG(!dir_access->dir_exists(p_root), "root_subfolder must be an existing sub-directory.");
|
|
|
|
local_history.clear();
|
|
local_history_pos = -1;
|
|
|
|
dir_access->change_dir(root_subfolder);
|
|
if (root_subfolder.is_empty()) {
|
|
root_prefix = "";
|
|
} else {
|
|
root_prefix = dir_access->get_current_dir();
|
|
}
|
|
invalidate();
|
|
update_dir();
|
|
}
|
|
|
|
String FileDialog::get_root_subfolder() const {
|
|
return root_subfolder;
|
|
}
|
|
|
|
void FileDialog::set_mode_overrides_title(bool p_override) {
|
|
mode_overrides_title = p_override;
|
|
}
|
|
|
|
bool FileDialog::is_mode_overriding_title() const {
|
|
return mode_overrides_title;
|
|
}
|
|
|
|
void FileDialog::set_file_mode(FileMode p_mode) {
|
|
ERR_FAIL_INDEX((int)p_mode, 5);
|
|
if (mode == p_mode) {
|
|
return;
|
|
}
|
|
mode = p_mode;
|
|
switch (mode) {
|
|
case FILE_MODE_OPEN_FILE:
|
|
set_ok_button_text(ETR("Open"));
|
|
if (mode_overrides_title) {
|
|
set_title(ETR("Open a File"));
|
|
}
|
|
makedir->hide();
|
|
break;
|
|
case FILE_MODE_OPEN_FILES:
|
|
set_ok_button_text(ETR("Open"));
|
|
if (mode_overrides_title) {
|
|
set_title(ETR("Open File(s)"));
|
|
}
|
|
makedir->hide();
|
|
break;
|
|
case FILE_MODE_OPEN_DIR:
|
|
set_ok_button_text(ETR("Select Current Folder"));
|
|
if (mode_overrides_title) {
|
|
set_title(ETR("Open a Directory"));
|
|
}
|
|
makedir->show();
|
|
break;
|
|
case FILE_MODE_OPEN_ANY:
|
|
set_ok_button_text(ETR("Open"));
|
|
if (mode_overrides_title) {
|
|
set_title(ETR("Open a File or Directory"));
|
|
}
|
|
makedir->show();
|
|
break;
|
|
case FILE_MODE_SAVE_FILE:
|
|
set_ok_button_text(ETR("Save"));
|
|
if (mode_overrides_title) {
|
|
set_title(ETR("Save a File"));
|
|
}
|
|
makedir->show();
|
|
break;
|
|
}
|
|
|
|
if (mode == FILE_MODE_OPEN_FILES) {
|
|
tree->set_select_mode(Tree::SELECT_MULTI);
|
|
} else {
|
|
tree->set_select_mode(Tree::SELECT_SINGLE);
|
|
}
|
|
|
|
get_ok_button()->set_disabled(_is_open_should_be_disabled());
|
|
}
|
|
|
|
FileDialog::FileMode FileDialog::get_file_mode() const {
|
|
return mode;
|
|
}
|
|
|
|
void FileDialog::set_access(Access p_access) {
|
|
ERR_FAIL_INDEX(p_access, 3);
|
|
if (access == p_access) {
|
|
return;
|
|
}
|
|
switch (p_access) {
|
|
case ACCESS_FILESYSTEM: {
|
|
dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
|
|
} break;
|
|
case ACCESS_RESOURCES: {
|
|
dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
|
|
} break;
|
|
case ACCESS_USERDATA: {
|
|
dir_access = DirAccess::create(DirAccess::ACCESS_USERDATA);
|
|
} break;
|
|
}
|
|
access = p_access;
|
|
root_prefix = "";
|
|
root_subfolder = "";
|
|
_update_drives();
|
|
invalidate();
|
|
update_filters();
|
|
update_dir();
|
|
}
|
|
|
|
void FileDialog::invalidate() {
|
|
if (!is_visible() || is_invalidating) {
|
|
return;
|
|
}
|
|
|
|
is_invalidating = true;
|
|
callable_mp(this, &FileDialog::_invalidate).call_deferred();
|
|
}
|
|
|
|
void FileDialog::_invalidate() {
|
|
if (!is_invalidating) {
|
|
return;
|
|
}
|
|
|
|
update_file_list();
|
|
|
|
is_invalidating = false;
|
|
}
|
|
|
|
FileDialog::Access FileDialog::get_access() const {
|
|
return access;
|
|
}
|
|
|
|
void FileDialog::_make_dir_confirm() {
|
|
Error err = dir_access->make_dir(makedirname->get_text().strip_edges());
|
|
if (err == OK) {
|
|
_change_dir(makedirname->get_text().strip_edges());
|
|
update_filters();
|
|
_push_history();
|
|
} else {
|
|
mkdirerr->popup_centered(Size2(250, 50));
|
|
}
|
|
makedirname->set_text(""); // reset label
|
|
}
|
|
|
|
void FileDialog::_make_dir() {
|
|
makedialog->popup_centered(Size2(250, 80));
|
|
makedirname->grab_focus();
|
|
}
|
|
|
|
void FileDialog::_select_drive(int p_idx) {
|
|
String d = drives->get_item_text(p_idx);
|
|
_change_dir(d);
|
|
file->set_text("");
|
|
_push_history();
|
|
}
|
|
|
|
void FileDialog::_change_dir(const String &p_new_dir) {
|
|
if (root_prefix.is_empty()) {
|
|
dir_access->change_dir(p_new_dir);
|
|
} else {
|
|
String old_dir = dir_access->get_current_dir();
|
|
dir_access->change_dir(p_new_dir);
|
|
if (!dir_access->get_current_dir(false).begins_with(root_prefix)) {
|
|
dir_access->change_dir(old_dir);
|
|
return;
|
|
}
|
|
}
|
|
|
|
invalidate();
|
|
update_dir();
|
|
}
|
|
|
|
void FileDialog::_update_drives(bool p_select) {
|
|
int dc = dir_access->get_drive_count();
|
|
if (dc == 0 || access != ACCESS_FILESYSTEM) {
|
|
drives->hide();
|
|
} else {
|
|
drives->clear();
|
|
Node *dp = drives->get_parent();
|
|
if (dp) {
|
|
dp->remove_child(drives);
|
|
}
|
|
dp = dir_access->drives_are_shortcuts() ? shortcuts_container : drives_container;
|
|
dp->add_child(drives);
|
|
drives->show();
|
|
|
|
for (int i = 0; i < dir_access->get_drive_count(); i++) {
|
|
drives->add_item(dir_access->get_drive(i));
|
|
}
|
|
|
|
if (p_select) {
|
|
drives->select(dir_access->get_current_drive());
|
|
}
|
|
}
|
|
}
|
|
|
|
bool FileDialog::default_show_hidden_files = false;
|
|
|
|
TypedArray<Dictionary> FileDialog::_get_options() const {
|
|
TypedArray<Dictionary> out;
|
|
for (const FileDialog::Option &opt : options) {
|
|
Dictionary dict;
|
|
dict["name"] = opt.name;
|
|
dict["values"] = opt.values;
|
|
dict["default"] = (int)selected_options.get(opt.name, opt.default_idx);
|
|
out.push_back(dict);
|
|
}
|
|
return out;
|
|
}
|
|
|
|
void FileDialog::_option_changed_checkbox_toggled(bool p_pressed, const String &p_name) {
|
|
if (selected_options.has(p_name)) {
|
|
selected_options[p_name] = p_pressed;
|
|
}
|
|
}
|
|
|
|
void FileDialog::_option_changed_item_selected(int p_idx, const String &p_name) {
|
|
if (selected_options.has(p_name)) {
|
|
selected_options[p_name] = p_idx;
|
|
}
|
|
}
|
|
|
|
void FileDialog::_update_option_controls() {
|
|
if (!options_dirty) {
|
|
return;
|
|
}
|
|
options_dirty = false;
|
|
|
|
while (grid_options->get_child_count(false) > 0) {
|
|
Node *child = grid_options->get_child(0);
|
|
grid_options->remove_child(child);
|
|
child->queue_free();
|
|
}
|
|
selected_options.clear();
|
|
|
|
for (const FileDialog::Option &opt : options) {
|
|
Label *lbl = memnew(Label);
|
|
lbl->set_text(opt.name);
|
|
grid_options->add_child(lbl);
|
|
if (opt.values.is_empty()) {
|
|
CheckBox *cb = memnew(CheckBox);
|
|
cb->set_pressed(opt.default_idx);
|
|
grid_options->add_child(cb);
|
|
cb->connect("toggled", callable_mp(this, &FileDialog::_option_changed_checkbox_toggled).bind(opt.name));
|
|
selected_options[opt.name] = (bool)opt.default_idx;
|
|
} else {
|
|
OptionButton *ob = memnew(OptionButton);
|
|
for (const String &val : opt.values) {
|
|
ob->add_item(val);
|
|
}
|
|
ob->select(opt.default_idx);
|
|
grid_options->add_child(ob);
|
|
ob->connect("item_selected", callable_mp(this, &FileDialog::_option_changed_item_selected).bind(opt.name));
|
|
selected_options[opt.name] = opt.default_idx;
|
|
}
|
|
}
|
|
}
|
|
|
|
Dictionary FileDialog::get_selected_options() const {
|
|
return selected_options;
|
|
}
|
|
|
|
String FileDialog::get_option_name(int p_option) const {
|
|
ERR_FAIL_INDEX_V(p_option, options.size(), String());
|
|
return options[p_option].name;
|
|
}
|
|
|
|
Vector<String> FileDialog::get_option_values(int p_option) const {
|
|
ERR_FAIL_INDEX_V(p_option, options.size(), Vector<String>());
|
|
return options[p_option].values;
|
|
}
|
|
|
|
int FileDialog::get_option_default(int p_option) const {
|
|
ERR_FAIL_INDEX_V(p_option, options.size(), -1);
|
|
return options[p_option].default_idx;
|
|
}
|
|
|
|
void FileDialog::set_option_name(int p_option, const String &p_name) {
|
|
if (p_option < 0) {
|
|
p_option += get_option_count();
|
|
}
|
|
ERR_FAIL_INDEX(p_option, options.size());
|
|
options.write[p_option].name = p_name;
|
|
options_dirty = true;
|
|
if (is_visible()) {
|
|
_update_option_controls();
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_option_values(int p_option, const Vector<String> &p_values) {
|
|
if (p_option < 0) {
|
|
p_option += get_option_count();
|
|
}
|
|
ERR_FAIL_INDEX(p_option, options.size());
|
|
options.write[p_option].values = p_values;
|
|
if (p_values.is_empty()) {
|
|
options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, 1);
|
|
} else {
|
|
options.write[p_option].default_idx = CLAMP(options[p_option].default_idx, 0, options[p_option].values.size() - 1);
|
|
}
|
|
options_dirty = true;
|
|
if (is_visible()) {
|
|
_update_option_controls();
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_option_default(int p_option, int p_index) {
|
|
if (p_option < 0) {
|
|
p_option += get_option_count();
|
|
}
|
|
ERR_FAIL_INDEX(p_option, options.size());
|
|
if (options[p_option].values.is_empty()) {
|
|
options.write[p_option].default_idx = CLAMP(p_index, 0, 1);
|
|
} else {
|
|
options.write[p_option].default_idx = CLAMP(p_index, 0, options[p_option].values.size() - 1);
|
|
}
|
|
options_dirty = true;
|
|
if (is_visible()) {
|
|
_update_option_controls();
|
|
}
|
|
}
|
|
|
|
void FileDialog::add_option(const String &p_name, const Vector<String> &p_values, int p_index) {
|
|
Option opt;
|
|
opt.name = p_name;
|
|
opt.values = p_values;
|
|
if (opt.values.is_empty()) {
|
|
opt.default_idx = CLAMP(p_index, 0, 1);
|
|
} else {
|
|
opt.default_idx = CLAMP(p_index, 0, opt.values.size() - 1);
|
|
}
|
|
options.push_back(opt);
|
|
options_dirty = true;
|
|
if (is_visible()) {
|
|
_update_option_controls();
|
|
}
|
|
}
|
|
|
|
void FileDialog::set_option_count(int p_count) {
|
|
ERR_FAIL_COND(p_count < 0);
|
|
int prev_size = options.size();
|
|
|
|
if (prev_size == p_count) {
|
|
return;
|
|
}
|
|
options.resize(p_count);
|
|
|
|
options_dirty = true;
|
|
notify_property_list_changed();
|
|
if (is_visible()) {
|
|
_update_option_controls();
|
|
}
|
|
}
|
|
|
|
int FileDialog::get_option_count() const {
|
|
return options.size();
|
|
}
|
|
|
|
bool FileDialog::_set(const StringName &p_name, const Variant &p_value) {
|
|
Vector<String> components = String(p_name).split("/", true, 2);
|
|
if (components.size() >= 2 && components[0].begins_with("option_") && components[0].trim_prefix("option_").is_valid_int()) {
|
|
int item_index = components[0].trim_prefix("option_").to_int();
|
|
String property = components[1];
|
|
if (property == "name") {
|
|
set_option_name(item_index, p_value);
|
|
return true;
|
|
} else if (property == "values") {
|
|
set_option_values(item_index, p_value);
|
|
return true;
|
|
} else if (property == "default") {
|
|
set_option_default(item_index, p_value);
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool FileDialog::_get(const StringName &p_name, Variant &r_ret) const {
|
|
Vector<String> components = String(p_name).split("/", true, 2);
|
|
if (components.size() >= 2 && components[0].begins_with("option_") && components[0].trim_prefix("option_").is_valid_int()) {
|
|
int item_index = components[0].trim_prefix("option_").to_int();
|
|
String property = components[1];
|
|
if (property == "name") {
|
|
r_ret = get_option_name(item_index);
|
|
return true;
|
|
} else if (property == "values") {
|
|
r_ret = get_option_values(item_index);
|
|
return true;
|
|
} else if (property == "default") {
|
|
r_ret = get_option_default(item_index);
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
void FileDialog::_get_property_list(List<PropertyInfo> *p_list) const {
|
|
for (int i = 0; i < options.size(); i++) {
|
|
p_list->push_back(PropertyInfo(Variant::STRING, vformat("option_%d/name", i)));
|
|
p_list->push_back(PropertyInfo(Variant::PACKED_STRING_ARRAY, vformat("option_%d/values", i)));
|
|
p_list->push_back(PropertyInfo(Variant::INT, vformat("option_%d/default", i)));
|
|
}
|
|
}
|
|
|
|
void FileDialog::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("_cancel_pressed"), &FileDialog::_cancel_pressed);
|
|
|
|
ClassDB::bind_method(D_METHOD("clear_filters"), &FileDialog::clear_filters);
|
|
ClassDB::bind_method(D_METHOD("add_filter", "filter", "description"), &FileDialog::add_filter, DEFVAL(""));
|
|
ClassDB::bind_method(D_METHOD("set_filters", "filters"), &FileDialog::set_filters);
|
|
ClassDB::bind_method(D_METHOD("get_filters"), &FileDialog::get_filters);
|
|
ClassDB::bind_method(D_METHOD("get_option_name", "option"), &FileDialog::get_option_name);
|
|
ClassDB::bind_method(D_METHOD("get_option_values", "option"), &FileDialog::get_option_values);
|
|
ClassDB::bind_method(D_METHOD("get_option_default", "option"), &FileDialog::get_option_default);
|
|
ClassDB::bind_method(D_METHOD("set_option_name", "option", "name"), &FileDialog::set_option_name);
|
|
ClassDB::bind_method(D_METHOD("set_option_values", "option", "values"), &FileDialog::set_option_values);
|
|
ClassDB::bind_method(D_METHOD("set_option_default", "option", "index"), &FileDialog::set_option_default);
|
|
ClassDB::bind_method(D_METHOD("set_option_count", "count"), &FileDialog::set_option_count);
|
|
ClassDB::bind_method(D_METHOD("get_option_count"), &FileDialog::get_option_count);
|
|
ClassDB::bind_method(D_METHOD("add_option", "name", "values", "index"), &FileDialog::add_option);
|
|
ClassDB::bind_method(D_METHOD("get_selected_options"), &FileDialog::get_selected_options);
|
|
ClassDB::bind_method(D_METHOD("get_current_dir"), &FileDialog::get_current_dir);
|
|
ClassDB::bind_method(D_METHOD("get_current_file"), &FileDialog::get_current_file);
|
|
ClassDB::bind_method(D_METHOD("get_current_path"), &FileDialog::get_current_path);
|
|
ClassDB::bind_method(D_METHOD("set_current_dir", "dir"), &FileDialog::set_current_dir);
|
|
ClassDB::bind_method(D_METHOD("set_current_file", "file"), &FileDialog::set_current_file);
|
|
ClassDB::bind_method(D_METHOD("set_current_path", "path"), &FileDialog::set_current_path);
|
|
ClassDB::bind_method(D_METHOD("set_mode_overrides_title", "override"), &FileDialog::set_mode_overrides_title);
|
|
ClassDB::bind_method(D_METHOD("is_mode_overriding_title"), &FileDialog::is_mode_overriding_title);
|
|
ClassDB::bind_method(D_METHOD("set_file_mode", "mode"), &FileDialog::set_file_mode);
|
|
ClassDB::bind_method(D_METHOD("get_file_mode"), &FileDialog::get_file_mode);
|
|
ClassDB::bind_method(D_METHOD("get_vbox"), &FileDialog::get_vbox);
|
|
ClassDB::bind_method(D_METHOD("get_line_edit"), &FileDialog::get_line_edit);
|
|
ClassDB::bind_method(D_METHOD("set_access", "access"), &FileDialog::set_access);
|
|
ClassDB::bind_method(D_METHOD("get_access"), &FileDialog::get_access);
|
|
ClassDB::bind_method(D_METHOD("set_root_subfolder", "dir"), &FileDialog::set_root_subfolder);
|
|
ClassDB::bind_method(D_METHOD("get_root_subfolder"), &FileDialog::get_root_subfolder);
|
|
ClassDB::bind_method(D_METHOD("set_show_hidden_files", "show"), &FileDialog::set_show_hidden_files);
|
|
ClassDB::bind_method(D_METHOD("is_showing_hidden_files"), &FileDialog::is_showing_hidden_files);
|
|
ClassDB::bind_method(D_METHOD("set_use_native_dialog", "native"), &FileDialog::set_use_native_dialog);
|
|
ClassDB::bind_method(D_METHOD("get_use_native_dialog"), &FileDialog::get_use_native_dialog);
|
|
ClassDB::bind_method(D_METHOD("deselect_all"), &FileDialog::deselect_all);
|
|
|
|
ClassDB::bind_method(D_METHOD("invalidate"), &FileDialog::invalidate);
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "mode_overrides_title"), "set_mode_overrides_title", "is_mode_overriding_title");
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "file_mode", PROPERTY_HINT_ENUM, "Open File,Open Files,Open Folder,Open Any,Save"), "set_file_mode", "get_file_mode");
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "access", PROPERTY_HINT_ENUM, "Resources,User Data,File System"), "set_access", "get_access");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "root_subfolder"), "set_root_subfolder", "get_root_subfolder");
|
|
ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "filters"), "set_filters", "get_filters");
|
|
ADD_ARRAY_COUNT("Options", "option_count", "set_option_count", "get_option_count", "option_");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "show_hidden_files"), "set_show_hidden_files", "is_showing_hidden_files");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "use_native_dialog"), "set_use_native_dialog", "get_use_native_dialog");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_dir", PROPERTY_HINT_DIR, "", PROPERTY_USAGE_NONE), "set_current_dir", "get_current_dir");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_file", PROPERTY_HINT_FILE, "*", PROPERTY_USAGE_NONE), "set_current_file", "get_current_file");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "current_path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE), "set_current_path", "get_current_path");
|
|
|
|
ADD_SIGNAL(MethodInfo("file_selected", PropertyInfo(Variant::STRING, "path")));
|
|
ADD_SIGNAL(MethodInfo("files_selected", PropertyInfo(Variant::PACKED_STRING_ARRAY, "paths")));
|
|
ADD_SIGNAL(MethodInfo("dir_selected", PropertyInfo(Variant::STRING, "dir")));
|
|
|
|
BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILE);
|
|
BIND_ENUM_CONSTANT(FILE_MODE_OPEN_FILES);
|
|
BIND_ENUM_CONSTANT(FILE_MODE_OPEN_DIR);
|
|
BIND_ENUM_CONSTANT(FILE_MODE_OPEN_ANY);
|
|
BIND_ENUM_CONSTANT(FILE_MODE_SAVE_FILE);
|
|
|
|
BIND_ENUM_CONSTANT(ACCESS_RESOURCES);
|
|
BIND_ENUM_CONSTANT(ACCESS_USERDATA);
|
|
BIND_ENUM_CONSTANT(ACCESS_FILESYSTEM);
|
|
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, parent_folder);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, forward_folder);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, back_folder);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, reload);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, toggle_hidden);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, folder);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, file);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_ICON, FileDialog, create_folder);
|
|
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, folder_icon_color);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_icon_color);
|
|
BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, FileDialog, file_disabled_color);
|
|
|
|
// TODO: Define own colors?
|
|
BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_normal_color, "font_color", "Button");
|
|
BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_hover_color, "font_hover_color", "Button");
|
|
BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_focus_color, "font_focus_color", "Button");
|
|
BIND_THEME_ITEM_EXT(Theme::DATA_TYPE_COLOR, FileDialog, icon_pressed_color, "font_pressed_color", "Button");
|
|
}
|
|
|
|
void FileDialog::set_show_hidden_files(bool p_show) {
|
|
if (show_hidden_files == p_show) {
|
|
return;
|
|
}
|
|
show_hidden_files = p_show;
|
|
invalidate();
|
|
}
|
|
|
|
bool FileDialog::is_showing_hidden_files() const {
|
|
return show_hidden_files;
|
|
}
|
|
|
|
void FileDialog::set_default_show_hidden_files(bool p_show) {
|
|
default_show_hidden_files = p_show;
|
|
}
|
|
|
|
void FileDialog::set_use_native_dialog(bool p_native) {
|
|
use_native_dialog = p_native;
|
|
}
|
|
|
|
bool FileDialog::get_use_native_dialog() const {
|
|
return use_native_dialog;
|
|
}
|
|
|
|
FileDialog::FileDialog() {
|
|
show_hidden_files = default_show_hidden_files;
|
|
|
|
vbox = memnew(VBoxContainer);
|
|
add_child(vbox, false, INTERNAL_MODE_FRONT);
|
|
|
|
mode = FILE_MODE_SAVE_FILE;
|
|
set_title(TTRC("Save a File"));
|
|
|
|
HBoxContainer *hbc = memnew(HBoxContainer);
|
|
|
|
dir_prev = memnew(Button);
|
|
dir_prev->set_theme_type_variation("FlatButton");
|
|
dir_prev->set_tooltip_text(ETR("Go to previous folder."));
|
|
dir_next = memnew(Button);
|
|
dir_next->set_theme_type_variation("FlatButton");
|
|
dir_next->set_tooltip_text(ETR("Go to next folder."));
|
|
dir_up = memnew(Button);
|
|
dir_up->set_theme_type_variation("FlatButton");
|
|
dir_up->set_tooltip_text(ETR("Go to parent folder."));
|
|
hbc->add_child(dir_prev);
|
|
hbc->add_child(dir_next);
|
|
hbc->add_child(dir_up);
|
|
dir_prev->connect("pressed", callable_mp(this, &FileDialog::_go_back));
|
|
dir_next->connect("pressed", callable_mp(this, &FileDialog::_go_forward));
|
|
dir_up->connect("pressed", callable_mp(this, &FileDialog::_go_up));
|
|
|
|
hbc->add_child(memnew(Label(ETR("Path:"))));
|
|
|
|
drives_container = memnew(HBoxContainer);
|
|
hbc->add_child(drives_container);
|
|
|
|
drives = memnew(OptionButton);
|
|
drives->connect("item_selected", callable_mp(this, &FileDialog::_select_drive));
|
|
hbc->add_child(drives);
|
|
|
|
dir = memnew(LineEdit);
|
|
dir->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
|
|
hbc->add_child(dir);
|
|
dir->set_h_size_flags(Control::SIZE_EXPAND_FILL);
|
|
|
|
refresh = memnew(Button);
|
|
refresh->set_theme_type_variation("FlatButton");
|
|
refresh->set_tooltip_text(ETR("Refresh files."));
|
|
refresh->connect("pressed", callable_mp(this, &FileDialog::update_file_list));
|
|
hbc->add_child(refresh);
|
|
|
|
show_hidden = memnew(Button);
|
|
show_hidden->set_theme_type_variation("FlatButton");
|
|
show_hidden->set_toggle_mode(true);
|
|
show_hidden->set_pressed(is_showing_hidden_files());
|
|
show_hidden->set_tooltip_text(ETR("Toggle the visibility of hidden files."));
|
|
show_hidden->connect("toggled", callable_mp(this, &FileDialog::set_show_hidden_files));
|
|
hbc->add_child(show_hidden);
|
|
|
|
shortcuts_container = memnew(HBoxContainer);
|
|
hbc->add_child(shortcuts_container);
|
|
|
|
makedir = memnew(Button);
|
|
makedir->set_theme_type_variation("FlatButton");
|
|
makedir->set_tooltip_text(ETR("Create a new folder."));
|
|
makedir->connect("pressed", callable_mp(this, &FileDialog::_make_dir));
|
|
hbc->add_child(makedir);
|
|
vbox->add_child(hbc);
|
|
|
|
tree = memnew(Tree);
|
|
tree->set_hide_root(true);
|
|
vbox->add_margin_child(ETR("Directories & Files:"), tree, true);
|
|
|
|
message = memnew(Label);
|
|
message->hide();
|
|
message->set_anchors_and_offsets_preset(Control::PRESET_FULL_RECT);
|
|
message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_CENTER);
|
|
message->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER);
|
|
tree->add_child(message);
|
|
|
|
file_box = memnew(HBoxContainer);
|
|
file_box->add_child(memnew(Label(ETR("File:"))));
|
|
file = memnew(LineEdit);
|
|
file->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
|
|
file->set_stretch_ratio(4);
|
|
file->set_h_size_flags(Control::SIZE_EXPAND_FILL);
|
|
file_box->add_child(file);
|
|
filter = memnew(OptionButton);
|
|
filter->set_stretch_ratio(3);
|
|
filter->set_h_size_flags(Control::SIZE_EXPAND_FILL);
|
|
filter->set_clip_text(true); // too many extensions overflows it
|
|
file_box->add_child(filter);
|
|
vbox->add_child(file_box);
|
|
|
|
grid_options = memnew(GridContainer);
|
|
grid_options->set_h_size_flags(Control::SIZE_SHRINK_CENTER);
|
|
grid_options->set_columns(2);
|
|
vbox->add_child(grid_options);
|
|
|
|
dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES);
|
|
_update_drives();
|
|
|
|
connect("confirmed", callable_mp(this, &FileDialog::_action_pressed));
|
|
tree->connect("multi_selected", callable_mp(this, &FileDialog::_tree_multi_selected), CONNECT_DEFERRED);
|
|
tree->connect("cell_selected", callable_mp(this, &FileDialog::_tree_selected), CONNECT_DEFERRED);
|
|
tree->connect("item_activated", callable_mp(this, &FileDialog::_tree_item_activated));
|
|
tree->connect("nothing_selected", callable_mp(this, &FileDialog::deselect_all));
|
|
dir->connect("text_submitted", callable_mp(this, &FileDialog::_dir_submitted));
|
|
file->connect("text_submitted", callable_mp(this, &FileDialog::_file_submitted));
|
|
filter->connect("item_selected", callable_mp(this, &FileDialog::_filter_selected));
|
|
|
|
confirm_save = memnew(ConfirmationDialog);
|
|
add_child(confirm_save, false, INTERNAL_MODE_FRONT);
|
|
|
|
confirm_save->connect("confirmed", callable_mp(this, &FileDialog::_save_confirm_pressed));
|
|
|
|
makedialog = memnew(ConfirmationDialog);
|
|
makedialog->set_title(ETR("Create Folder"));
|
|
VBoxContainer *makevb = memnew(VBoxContainer);
|
|
makedialog->add_child(makevb);
|
|
|
|
makedirname = memnew(LineEdit);
|
|
makedirname->set_structured_text_bidi_override(TextServer::STRUCTURED_TEXT_FILE);
|
|
makevb->add_margin_child(ETR("Name:"), makedirname);
|
|
add_child(makedialog, false, INTERNAL_MODE_FRONT);
|
|
makedialog->register_text_enter(makedirname);
|
|
makedialog->connect("confirmed", callable_mp(this, &FileDialog::_make_dir_confirm));
|
|
mkdirerr = memnew(AcceptDialog);
|
|
mkdirerr->set_text(ETR("Could not create folder."));
|
|
add_child(mkdirerr, false, INTERNAL_MODE_FRONT);
|
|
|
|
exterr = memnew(AcceptDialog);
|
|
exterr->set_text(ETR("Invalid extension, or empty filename."));
|
|
add_child(exterr, false, INTERNAL_MODE_FRONT);
|
|
|
|
update_filters();
|
|
update_dir();
|
|
|
|
set_hide_on_ok(false);
|
|
|
|
if (register_func) {
|
|
register_func(this);
|
|
}
|
|
}
|
|
|
|
FileDialog::~FileDialog() {
|
|
if (unregister_func) {
|
|
unregister_func(this);
|
|
}
|
|
}
|