/*************************************************************************/ /* option_button.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 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 "option_button.h" #include "core/string/print_string.h" static const int NONE_SELECTED = -1; Size2 OptionButton::get_minimum_size() const { Size2 minsize = Button::get_minimum_size(); if (has_theme_icon(SNAME("arrow"))) { const Size2 padding = get_theme_stylebox(SNAME("normal"))->get_minimum_size(); const Size2 arrow_size = Control::get_theme_icon(SNAME("arrow"))->get_size(); Size2 content_size = minsize - padding; content_size.width += arrow_size.width + get_theme_constant(SNAME("hseparation")); content_size.height = MAX(content_size.height, arrow_size.height); minsize = content_size + padding; } return minsize; } void OptionButton::_notification(int p_what) { switch (p_what) { case NOTIFICATION_DRAW: { if (!has_theme_icon(SNAME("arrow"))) { return; } RID ci = get_canvas_item(); Ref arrow = Control::get_theme_icon(SNAME("arrow")); Color clr = Color(1, 1, 1); if (get_theme_constant(SNAME("modulate_arrow"))) { switch (get_draw_mode()) { case DRAW_PRESSED: clr = get_theme_color(SNAME("font_pressed_color")); break; case DRAW_HOVER: clr = get_theme_color(SNAME("font_hover_color")); break; case DRAW_DISABLED: clr = get_theme_color(SNAME("font_disabled_color")); break; default: if (has_focus()) { clr = get_theme_color(SNAME("font_focus_color")); } else { clr = get_theme_color(SNAME("font_color")); } } } Size2 size = get_size(); Point2 ofs; if (is_layout_rtl()) { ofs = Point2(get_theme_constant(SNAME("arrow_margin")), int(Math::abs((size.height - arrow->get_height()) / 2))); } else { ofs = Point2(size.width - arrow->get_width() - get_theme_constant(SNAME("arrow_margin")), int(Math::abs((size.height - arrow->get_height()) / 2))); } arrow->draw(ci, ofs, clr); } break; case NOTIFICATION_TRANSLATION_CHANGED: case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: case NOTIFICATION_THEME_CHANGED: { if (has_theme_icon(SNAME("arrow"))) { if (is_layout_rtl()) { _set_internal_margin(SIDE_LEFT, Control::get_theme_icon(SNAME("arrow"))->get_width()); _set_internal_margin(SIDE_RIGHT, 0.f); } else { _set_internal_margin(SIDE_LEFT, 0.f); _set_internal_margin(SIDE_RIGHT, Control::get_theme_icon(SNAME("arrow"))->get_width()); } } } break; case NOTIFICATION_VISIBILITY_CHANGED: { if (!is_visible_in_tree()) { popup->hide(); } } break; } } bool OptionButton::_set(const StringName &p_name, const Variant &p_value) { Vector components = String(p_name).split("/", true, 2); if (components.size() >= 2 && components[0] == "popup") { bool valid; popup->set(String(p_name).trim_prefix("popup/"), p_value, &valid); int idx = components[1].get_slice("_", 1).to_int(); if (idx == current) { // Force refreshing currently displayed item. current = NONE_SELECTED; _select(idx, false); } return valid; } return false; } bool OptionButton::_get(const StringName &p_name, Variant &r_ret) const { Vector components = String(p_name).split("/", true, 2); if (components.size() >= 2 && components[0] == "popup") { bool valid; r_ret = popup->get(String(p_name).trim_prefix("popup/"), &valid); return valid; } return false; } void OptionButton::_get_property_list(List *p_list) const { for (int i = 0; i < popup->get_item_count(); i++) { p_list->push_back(PropertyInfo(Variant::STRING, vformat("popup/item_%d/text", i))); PropertyInfo pi = PropertyInfo(Variant::OBJECT, vformat("popup/item_%d/icon", i), PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"); pi.usage &= ~(popup->get_item_icon(i).is_null() ? PROPERTY_USAGE_STORAGE : 0); p_list->push_back(pi); pi = PropertyInfo(Variant::INT, vformat("popup/item_%d/checkable", i), PROPERTY_HINT_ENUM, "No,As checkbox,As radio button"); pi.usage &= ~(!popup->is_item_checkable(i) ? PROPERTY_USAGE_STORAGE : 0); p_list->push_back(pi); pi = PropertyInfo(Variant::BOOL, vformat("popup/item_%d/checked", i)); pi.usage &= ~(!popup->is_item_checked(i) ? PROPERTY_USAGE_STORAGE : 0); p_list->push_back(pi); pi = PropertyInfo(Variant::INT, vformat("popup/item_%d/id", i), PROPERTY_HINT_RANGE, "0,10,1,or_greater"); p_list->push_back(pi); pi = PropertyInfo(Variant::BOOL, vformat("popup/item_%d/disabled", i)); pi.usage &= ~(!popup->is_item_disabled(i) ? PROPERTY_USAGE_STORAGE : 0); p_list->push_back(pi); pi = PropertyInfo(Variant::BOOL, vformat("popup/item_%d/separator", i)); pi.usage &= ~(!popup->is_item_separator(i) ? PROPERTY_USAGE_STORAGE : 0); p_list->push_back(pi); } } void OptionButton::_focused(int p_which) { emit_signal(SNAME("item_focused"), p_which); } void OptionButton::_selected(int p_which) { _select(p_which, true); } void OptionButton::pressed() { Size2 size = get_size() * get_viewport()->get_canvas_transform().get_scale(); popup->set_position(get_screen_position() + Size2(0, size.height * get_global_transform().get_scale().y)); popup->set_size(Size2(size.width, 0)); popup->set_current_index(current); popup->popup(); } void OptionButton::add_icon_item(const Ref &p_icon, const String &p_label, int p_id) { popup->add_icon_radio_check_item(p_icon, p_label, p_id); if (popup->get_item_count() == 1) { select(0); } } void OptionButton::add_item(const String &p_label, int p_id) { popup->add_radio_check_item(p_label, p_id); if (popup->get_item_count() == 1) { select(0); } } void OptionButton::set_item_text(int p_idx, const String &p_text) { popup->set_item_text(p_idx, p_text); if (current == p_idx) { set_text(p_text); } } void OptionButton::set_item_icon(int p_idx, const Ref &p_icon) { popup->set_item_icon(p_idx, p_icon); if (current == p_idx) { set_icon(p_icon); } } void OptionButton::set_item_id(int p_idx, int p_id) { popup->set_item_id(p_idx, p_id); } void OptionButton::set_item_metadata(int p_idx, const Variant &p_metadata) { popup->set_item_metadata(p_idx, p_metadata); } void OptionButton::set_item_disabled(int p_idx, bool p_disabled) { popup->set_item_disabled(p_idx, p_disabled); } String OptionButton::get_item_text(int p_idx) const { return popup->get_item_text(p_idx); } Ref OptionButton::get_item_icon(int p_idx) const { return popup->get_item_icon(p_idx); } int OptionButton::get_item_id(int p_idx) const { if (p_idx == NONE_SELECTED) { return NONE_SELECTED; } return popup->get_item_id(p_idx); } int OptionButton::get_item_index(int p_id) const { return popup->get_item_index(p_id); } Variant OptionButton::get_item_metadata(int p_idx) const { return popup->get_item_metadata(p_idx); } bool OptionButton::is_item_disabled(int p_idx) const { return popup->is_item_disabled(p_idx); } void OptionButton::set_item_count(int p_count) { ERR_FAIL_COND(p_count < 0); popup->set_item_count(p_count); notify_property_list_changed(); } int OptionButton::get_item_count() const { return popup->get_item_count(); } void OptionButton::add_separator() { popup->add_separator(); } void OptionButton::clear() { popup->clear(); set_text(""); current = NONE_SELECTED; } void OptionButton::_select(int p_which, bool p_emit) { if (p_which == current) { return; } if (p_which == NONE_SELECTED) { for (int i = 0; i < popup->get_item_count(); i++) { popup->set_item_checked(i, false); } current = NONE_SELECTED; set_text(""); set_icon(NULL); } else { ERR_FAIL_INDEX(p_which, popup->get_item_count()); for (int i = 0; i < popup->get_item_count(); i++) { popup->set_item_checked(i, i == p_which); } current = p_which; set_text(popup->get_item_text(current)); set_icon(popup->get_item_icon(current)); } if (is_inside_tree() && p_emit) { emit_signal(SNAME("item_selected"), current); } } void OptionButton::_select_int(int p_which) { if (p_which < NONE_SELECTED || p_which >= popup->get_item_count()) { return; } _select(p_which, false); } void OptionButton::select(int p_idx) { _select(p_idx, false); } int OptionButton::get_selected() const { return current; } int OptionButton::get_selected_id() const { return get_item_id(current); } Variant OptionButton::get_selected_metadata() const { int idx = get_selected(); if (idx < 0) { return Variant(); } return get_item_metadata(current); } void OptionButton::remove_item(int p_idx) { popup->remove_item(p_idx); if (current == p_idx) { _select(NONE_SELECTED); } } PopupMenu *OptionButton::get_popup() const { return popup; } void OptionButton::get_translatable_strings(List *p_strings) const { popup->get_translatable_strings(p_strings); } void OptionButton::_bind_methods() { ClassDB::bind_method(D_METHOD("add_item", "label", "id"), &OptionButton::add_item, DEFVAL(-1)); ClassDB::bind_method(D_METHOD("add_icon_item", "texture", "label", "id"), &OptionButton::add_icon_item, DEFVAL(-1)); ClassDB::bind_method(D_METHOD("set_item_text", "idx", "text"), &OptionButton::set_item_text); ClassDB::bind_method(D_METHOD("set_item_icon", "idx", "texture"), &OptionButton::set_item_icon); ClassDB::bind_method(D_METHOD("set_item_disabled", "idx", "disabled"), &OptionButton::set_item_disabled); ClassDB::bind_method(D_METHOD("set_item_id", "idx", "id"), &OptionButton::set_item_id); ClassDB::bind_method(D_METHOD("set_item_metadata", "idx", "metadata"), &OptionButton::set_item_metadata); ClassDB::bind_method(D_METHOD("get_item_text", "idx"), &OptionButton::get_item_text); ClassDB::bind_method(D_METHOD("get_item_icon", "idx"), &OptionButton::get_item_icon); ClassDB::bind_method(D_METHOD("get_item_id", "idx"), &OptionButton::get_item_id); ClassDB::bind_method(D_METHOD("get_item_index", "id"), &OptionButton::get_item_index); ClassDB::bind_method(D_METHOD("get_item_metadata", "idx"), &OptionButton::get_item_metadata); ClassDB::bind_method(D_METHOD("is_item_disabled", "idx"), &OptionButton::is_item_disabled); ClassDB::bind_method(D_METHOD("add_separator"), &OptionButton::add_separator); ClassDB::bind_method(D_METHOD("clear"), &OptionButton::clear); ClassDB::bind_method(D_METHOD("select", "idx"), &OptionButton::select); ClassDB::bind_method(D_METHOD("get_selected"), &OptionButton::get_selected); ClassDB::bind_method(D_METHOD("get_selected_id"), &OptionButton::get_selected_id); ClassDB::bind_method(D_METHOD("get_selected_metadata"), &OptionButton::get_selected_metadata); ClassDB::bind_method(D_METHOD("remove_item", "idx"), &OptionButton::remove_item); ClassDB::bind_method(D_METHOD("_select_int"), &OptionButton::_select_int); ClassDB::bind_method(D_METHOD("get_popup"), &OptionButton::get_popup); ClassDB::bind_method(D_METHOD("set_item_count", "count"), &OptionButton::set_item_count); ClassDB::bind_method(D_METHOD("get_item_count"), &OptionButton::get_item_count); // "selected" property must come after "item_count", otherwise GH-10213 occurs. ADD_ARRAY_COUNT("Items", "item_count", "set_item_count", "get_item_count", "popup/item_"); ADD_PROPERTY(PropertyInfo(Variant::INT, "selected"), "_select_int", "get_selected"); ADD_SIGNAL(MethodInfo("item_selected", PropertyInfo(Variant::INT, "index"))); ADD_SIGNAL(MethodInfo("item_focused", PropertyInfo(Variant::INT, "index"))); } OptionButton::OptionButton() { set_toggle_mode(true); set_text_alignment(HORIZONTAL_ALIGNMENT_LEFT); if (is_layout_rtl()) { if (has_theme_icon(SNAME("arrow"))) { _set_internal_margin(SIDE_LEFT, Control::get_theme_icon(SNAME("arrow"))->get_width()); } } else { if (has_theme_icon(SNAME("arrow"))) { _set_internal_margin(SIDE_RIGHT, Control::get_theme_icon(SNAME("arrow"))->get_width()); } } set_action_mode(ACTION_MODE_BUTTON_PRESS); popup = memnew(PopupMenu); popup->hide(); add_child(popup, false, INTERNAL_MODE_FRONT); popup->connect("index_pressed", callable_mp(this, &OptionButton::_selected)); popup->connect("id_focused", callable_mp(this, &OptionButton::_focused)); popup->connect("popup_hide", callable_mp((BaseButton *)this, &BaseButton::set_pressed), varray(false)); } OptionButton::~OptionButton() { }