31b7f02a29
ToolButton has no redeeming differences with Button; it's just a Button with the Flat property enabled by default. Removing it avoids some confusion when creating GUIs. Existing ToolButtons will be converted to Buttons, but the Flat property won't be enabled automatically. This closes https://github.com/godotengine/godot-proposals/issues/1081.
399 lines
12 KiB
C++
399 lines
12 KiB
C++
/*************************************************************************/
|
|
/* item_list_editor_plugin.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 "item_list_editor_plugin.h"
|
|
|
|
#include "core/io/resource_loader.h"
|
|
#include "editor/editor_scale.h"
|
|
|
|
bool ItemListPlugin::_set(const StringName &p_name, const Variant &p_value) {
|
|
String name = p_name;
|
|
int idx = name.get_slice("/", 0).to_int();
|
|
String what = name.get_slice("/", 1);
|
|
|
|
if (what == "text") {
|
|
set_item_text(idx, p_value);
|
|
} else if (what == "icon") {
|
|
set_item_icon(idx, p_value);
|
|
} else if (what == "checkable") {
|
|
// This keeps compatibility to/from versions where this property was a boolean, before radio buttons
|
|
switch ((int)p_value) {
|
|
case 0:
|
|
case 1:
|
|
set_item_checkable(idx, p_value);
|
|
break;
|
|
case 2:
|
|
set_item_radio_checkable(idx, true);
|
|
break;
|
|
}
|
|
} else if (what == "checked") {
|
|
set_item_checked(idx, p_value);
|
|
} else if (what == "id") {
|
|
set_item_id(idx, p_value);
|
|
} else if (what == "enabled") {
|
|
set_item_enabled(idx, p_value);
|
|
} else if (what == "separator") {
|
|
set_item_separator(idx, p_value);
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool ItemListPlugin::_get(const StringName &p_name, Variant &r_ret) const {
|
|
String name = p_name;
|
|
int idx = name.get_slice("/", 0).to_int();
|
|
String what = name.get_slice("/", 1);
|
|
|
|
if (what == "text") {
|
|
r_ret = get_item_text(idx);
|
|
} else if (what == "icon") {
|
|
r_ret = get_item_icon(idx);
|
|
} else if (what == "checkable") {
|
|
// This keeps compatibility to/from versions where this property was a boolean, before radio buttons
|
|
if (!is_item_checkable(idx)) {
|
|
r_ret = 0;
|
|
} else {
|
|
r_ret = is_item_radio_checkable(idx) ? 2 : 1;
|
|
}
|
|
} else if (what == "checked") {
|
|
r_ret = is_item_checked(idx);
|
|
} else if (what == "id") {
|
|
r_ret = get_item_id(idx);
|
|
} else if (what == "enabled") {
|
|
r_ret = is_item_enabled(idx);
|
|
} else if (what == "separator") {
|
|
r_ret = is_item_separator(idx);
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
void ItemListPlugin::_get_property_list(List<PropertyInfo> *p_list) const {
|
|
for (int i = 0; i < get_item_count(); i++) {
|
|
String base = itos(i) + "/";
|
|
|
|
p_list->push_back(PropertyInfo(Variant::STRING, base + "text"));
|
|
p_list->push_back(PropertyInfo(Variant::OBJECT, base + "icon", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"));
|
|
|
|
int flags = get_flags();
|
|
|
|
if (flags & FLAG_CHECKABLE) {
|
|
p_list->push_back(PropertyInfo(Variant::INT, base + "checkable", PROPERTY_HINT_ENUM, "No,As checkbox,As radio button"));
|
|
p_list->push_back(PropertyInfo(Variant::BOOL, base + "checked"));
|
|
}
|
|
|
|
if (flags & FLAG_ID) {
|
|
p_list->push_back(PropertyInfo(Variant::INT, base + "id", PROPERTY_HINT_RANGE, "-1,4096"));
|
|
}
|
|
|
|
if (flags & FLAG_ENABLE) {
|
|
p_list->push_back(PropertyInfo(Variant::BOOL, base + "enabled"));
|
|
}
|
|
|
|
if (flags & FLAG_SEPARATOR) {
|
|
p_list->push_back(PropertyInfo(Variant::BOOL, base + "separator"));
|
|
}
|
|
}
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////
|
|
///////////////////////// PLUGINS /////////////////////////////
|
|
///////////////////////////////////////////////////////////////
|
|
|
|
void ItemListOptionButtonPlugin::set_object(Object *p_object) {
|
|
ob = Object::cast_to<OptionButton>(p_object);
|
|
}
|
|
|
|
bool ItemListOptionButtonPlugin::handles(Object *p_object) const {
|
|
return p_object->is_class("OptionButton");
|
|
}
|
|
|
|
int ItemListOptionButtonPlugin::get_flags() const {
|
|
return FLAG_ICON | FLAG_ID | FLAG_ENABLE;
|
|
}
|
|
|
|
void ItemListOptionButtonPlugin::add_item() {
|
|
ob->add_item(vformat(TTR("Item %d"), ob->get_item_count()));
|
|
_change_notify();
|
|
}
|
|
|
|
int ItemListOptionButtonPlugin::get_item_count() const {
|
|
return ob->get_item_count();
|
|
}
|
|
|
|
void ItemListOptionButtonPlugin::erase(int p_idx) {
|
|
ob->remove_item(p_idx);
|
|
_change_notify();
|
|
}
|
|
|
|
ItemListOptionButtonPlugin::ItemListOptionButtonPlugin() {
|
|
ob = nullptr;
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////
|
|
|
|
void ItemListPopupMenuPlugin::set_object(Object *p_object) {
|
|
if (p_object->is_class("MenuButton")) {
|
|
pp = Object::cast_to<MenuButton>(p_object)->get_popup();
|
|
} else {
|
|
pp = Object::cast_to<PopupMenu>(p_object);
|
|
}
|
|
}
|
|
|
|
bool ItemListPopupMenuPlugin::handles(Object *p_object) const {
|
|
return p_object->is_class("PopupMenu") || p_object->is_class("MenuButton");
|
|
}
|
|
|
|
int ItemListPopupMenuPlugin::get_flags() const {
|
|
return FLAG_ICON | FLAG_CHECKABLE | FLAG_ID | FLAG_ENABLE | FLAG_SEPARATOR;
|
|
}
|
|
|
|
void ItemListPopupMenuPlugin::add_item() {
|
|
pp->add_item(vformat(TTR("Item %d"), pp->get_item_count()));
|
|
_change_notify();
|
|
}
|
|
|
|
int ItemListPopupMenuPlugin::get_item_count() const {
|
|
return pp->get_item_count();
|
|
}
|
|
|
|
void ItemListPopupMenuPlugin::erase(int p_idx) {
|
|
pp->remove_item(p_idx);
|
|
_change_notify();
|
|
}
|
|
|
|
ItemListPopupMenuPlugin::ItemListPopupMenuPlugin() {
|
|
pp = nullptr;
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////
|
|
|
|
void ItemListItemListPlugin::set_object(Object *p_object) {
|
|
pp = Object::cast_to<ItemList>(p_object);
|
|
}
|
|
|
|
bool ItemListItemListPlugin::handles(Object *p_object) const {
|
|
return p_object->is_class("ItemList");
|
|
}
|
|
|
|
int ItemListItemListPlugin::get_flags() const {
|
|
return FLAG_ICON | FLAG_ENABLE;
|
|
}
|
|
|
|
void ItemListItemListPlugin::add_item() {
|
|
pp->add_item(vformat(TTR("Item %d"), pp->get_item_count()));
|
|
_change_notify();
|
|
}
|
|
|
|
int ItemListItemListPlugin::get_item_count() const {
|
|
return pp->get_item_count();
|
|
}
|
|
|
|
void ItemListItemListPlugin::erase(int p_idx) {
|
|
pp->remove_item(p_idx);
|
|
_change_notify();
|
|
}
|
|
|
|
ItemListItemListPlugin::ItemListItemListPlugin() {
|
|
pp = nullptr;
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////
|
|
///////////////////////////////////////////////////////////////
|
|
///////////////////////////////////////////////////////////////
|
|
|
|
void ItemListEditor::_node_removed(Node *p_node) {
|
|
if (p_node == item_list) {
|
|
item_list = nullptr;
|
|
hide();
|
|
dialog->hide();
|
|
}
|
|
}
|
|
|
|
void ItemListEditor::_notification(int p_notification) {
|
|
if (p_notification == NOTIFICATION_ENTER_TREE || p_notification == NOTIFICATION_THEME_CHANGED) {
|
|
add_button->set_icon(get_theme_icon("Add", "EditorIcons"));
|
|
del_button->set_icon(get_theme_icon("Remove", "EditorIcons"));
|
|
} else if (p_notification == NOTIFICATION_READY) {
|
|
get_tree()->connect("node_removed", callable_mp(this, &ItemListEditor::_node_removed));
|
|
}
|
|
}
|
|
|
|
void ItemListEditor::_add_pressed() {
|
|
if (selected_idx == -1) {
|
|
return;
|
|
}
|
|
|
|
item_plugins[selected_idx]->add_item();
|
|
}
|
|
|
|
void ItemListEditor::_delete_pressed() {
|
|
if (selected_idx == -1) {
|
|
return;
|
|
}
|
|
|
|
String current_selected = (String)property_editor->get_selected_path();
|
|
|
|
if (current_selected == "") {
|
|
return;
|
|
}
|
|
|
|
// FIXME: Currently relying on selecting a *property* to derive what item to delete
|
|
// e.g. you select "1/enabled" to delete item 1.
|
|
// This should be fixed so that you can delete by selecting the item section header,
|
|
// or a delete button on that header.
|
|
|
|
int idx = current_selected.get_slice("/", 0).to_int();
|
|
|
|
item_plugins[selected_idx]->erase(idx);
|
|
}
|
|
|
|
void ItemListEditor::_edit_items() {
|
|
dialog->popup_centered_clamped(Vector2(425, 1200) * EDSCALE, 0.8);
|
|
}
|
|
|
|
void ItemListEditor::edit(Node *p_item_list) {
|
|
item_list = p_item_list;
|
|
|
|
if (!item_list) {
|
|
selected_idx = -1;
|
|
property_editor->edit(nullptr);
|
|
return;
|
|
}
|
|
|
|
for (int i = 0; i < item_plugins.size(); i++) {
|
|
if (item_plugins[i]->handles(p_item_list)) {
|
|
item_plugins[i]->set_object(p_item_list);
|
|
property_editor->edit(item_plugins[i]);
|
|
|
|
toolbar_button->set_icon(EditorNode::get_singleton()->get_object_icon(item_list, ""));
|
|
|
|
selected_idx = i;
|
|
return;
|
|
}
|
|
}
|
|
|
|
selected_idx = -1;
|
|
property_editor->edit(nullptr);
|
|
}
|
|
|
|
bool ItemListEditor::handles(Object *p_object) const {
|
|
for (int i = 0; i < item_plugins.size(); i++) {
|
|
if (item_plugins[i]->handles(p_object)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void ItemListEditor::_bind_methods() {
|
|
}
|
|
|
|
ItemListEditor::ItemListEditor() {
|
|
selected_idx = -1;
|
|
item_list = nullptr;
|
|
|
|
toolbar_button = memnew(Button);
|
|
toolbar_button->set_flat(true);
|
|
toolbar_button->set_text(TTR("Items"));
|
|
add_child(toolbar_button);
|
|
toolbar_button->connect("pressed", callable_mp(this, &ItemListEditor::_edit_items));
|
|
|
|
dialog = memnew(AcceptDialog);
|
|
dialog->set_title(TTR("Item List Editor"));
|
|
add_child(dialog);
|
|
|
|
VBoxContainer *vbc = memnew(VBoxContainer);
|
|
dialog->add_child(vbc);
|
|
//dialog->set_child_rect(vbc);
|
|
|
|
HBoxContainer *hbc = memnew(HBoxContainer);
|
|
hbc->set_h_size_flags(SIZE_EXPAND_FILL);
|
|
vbc->add_child(hbc);
|
|
|
|
add_button = memnew(Button);
|
|
add_button->set_text(TTR("Add"));
|
|
hbc->add_child(add_button);
|
|
add_button->connect("pressed", callable_mp(this, &ItemListEditor::_add_pressed));
|
|
|
|
hbc->add_spacer();
|
|
|
|
del_button = memnew(Button);
|
|
del_button->set_text(TTR("Delete"));
|
|
hbc->add_child(del_button);
|
|
del_button->connect("pressed", callable_mp(this, &ItemListEditor::_delete_pressed));
|
|
|
|
property_editor = memnew(EditorInspector);
|
|
vbc->add_child(property_editor);
|
|
property_editor->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
}
|
|
|
|
ItemListEditor::~ItemListEditor() {
|
|
for (int i = 0; i < item_plugins.size(); i++) {
|
|
memdelete(item_plugins[i]);
|
|
}
|
|
}
|
|
|
|
void ItemListEditorPlugin::edit(Object *p_object) {
|
|
item_list_editor->edit(Object::cast_to<Node>(p_object));
|
|
}
|
|
|
|
bool ItemListEditorPlugin::handles(Object *p_object) const {
|
|
return item_list_editor->handles(p_object);
|
|
}
|
|
|
|
void ItemListEditorPlugin::make_visible(bool p_visible) {
|
|
if (p_visible) {
|
|
item_list_editor->show();
|
|
} else {
|
|
item_list_editor->hide();
|
|
item_list_editor->edit(nullptr);
|
|
}
|
|
}
|
|
|
|
ItemListEditorPlugin::ItemListEditorPlugin(EditorNode *p_node) {
|
|
editor = p_node;
|
|
item_list_editor = memnew(ItemListEditor);
|
|
CanvasItemEditor::get_singleton()->add_control_to_menu_panel(item_list_editor);
|
|
|
|
item_list_editor->hide();
|
|
item_list_editor->add_plugin(memnew(ItemListOptionButtonPlugin));
|
|
item_list_editor->add_plugin(memnew(ItemListPopupMenuPlugin));
|
|
item_list_editor->add_plugin(memnew(ItemListItemListPlugin));
|
|
}
|
|
|
|
ItemListEditorPlugin::~ItemListEditorPlugin() {
|
|
}
|