1 /*************************************************************************/
2 /*  option_button.h                                                      */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2019 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 #ifndef OPTION_BUTTON_H
31 #define OPTION_BUTTON_H
32 
33 #include "scene/gui/button.h"
34 #include "scene/gui/popup_menu.h"
35 /**
36 	@author Juan Linietsky <reduzio@gmail.com>
37 */
38 class OptionButton : public Button {
39 
40 	OBJ_TYPE(OptionButton, Button);
41 
42 	PopupMenu *popup;
43 	int current;
44 
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 	Variant get_item_metadata(int p_idx) const;
73 	bool is_item_disabled(int p_idx) const;
74 
75 	int get_item_count() const;
76 
77 	void add_separator();
78 
79 	void clear();
80 
81 	void select(int p_idx);
82 	int get_selected() const;
83 	int get_selected_ID() const;
84 	Variant get_selected_metadata() const;
85 
86 	void remove_item(int p_idx);
87 
88 	virtual void get_translatable_strings(List<String> *p_strings) const;
89 
90 	OptionButton();
91 	~OptionButton();
92 };
93 
94 #endif
95