1 /*************************************************************************/ 2 /* option_button.h */ 3 /*************************************************************************/ 4 /* This file is part of: */ 5 /* GODOT ENGINE */ 6 /* https://godotengine.org */ 7 /*************************************************************************/ 8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ 9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */ 10 /* */ 11 /* Permission is hereby granted, free of charge, to any person obtaining */ 12 /* a copy of this software and associated documentation files (the */ 13 /* "Software"), to deal in the Software without restriction, including */ 14 /* without limitation the rights to use, copy, modify, merge, publish, */ 15 /* distribute, sublicense, and/or sell copies of the Software, and to */ 16 /* permit persons to whom the Software is furnished to do so, subject to */ 17 /* the following conditions: */ 18 /* */ 19 /* The above copyright notice and this permission notice shall be */ 20 /* included in all copies or substantial portions of the Software. */ 21 /* */ 22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ 23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ 24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ 25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ 26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ 27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ 28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ 29 /*************************************************************************/ 30 31 #ifndef OPTION_BUTTON_H 32 #define OPTION_BUTTON_H 33 34 #include "scene/gui/button.h" 35 #include "scene/gui/popup_menu.h" 36 37 class OptionButton : public Button { 38 39 GDCLASS(OptionButton, Button); 40 41 PopupMenu *popup; 42 int current; 43 44 void _focused(int p_which); 45 void _selected(int p_which); 46 void _select(int p_which, bool p_emit = false); 47 void _select_int(int p_which); 48 49 Array _get_items() const; 50 void _set_items(const Array &p_items); 51 52 virtual void pressed(); 53 54 protected: 55 Size2 get_minimum_size() const; 56 void _notification(int p_what); 57 static void _bind_methods(); 58 59 public: 60 void add_icon_item(const Ref<Texture> &p_icon, const String &p_label, int p_id = -1); 61 void add_item(const String &p_label, int p_id = -1); 62 63 void set_item_text(int p_idx, const String &p_text); 64 void set_item_icon(int p_idx, const Ref<Texture> &p_icon); 65 void set_item_id(int p_idx, int p_id); 66 void set_item_metadata(int p_idx, const Variant &p_metadata); 67 void set_item_disabled(int p_idx, bool p_disabled); 68 69 String get_item_text(int p_idx) const; 70 Ref<Texture> get_item_icon(int p_idx) const; 71 int get_item_id(int p_idx) const; 72 int get_item_index(int p_id) const; 73 Variant get_item_metadata(int p_idx) const; 74 bool is_item_disabled(int p_idx) const; 75 76 int get_item_count() const; 77 78 void add_separator(); 79 80 void clear(); 81 82 void select(int p_idx); 83 int get_selected() const; 84 int get_selected_id() const; 85 Variant get_selected_metadata() const; 86 87 void remove_item(int p_idx); 88 89 PopupMenu *get_popup() const; 90 91 virtual void get_translatable_strings(List<String> *p_strings) const; 92 93 OptionButton(); 94 ~OptionButton(); 95 }; 96 97 #endif 98