140 lines
5.3 KiB
C++
140 lines
5.3 KiB
C++
/**************************************************************************/
|
|
/* option_button.h */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef OPTION_BUTTON_H
|
|
#define OPTION_BUTTON_H
|
|
|
|
#include "scene/gui/button.h"
|
|
#include "scene/gui/popup_menu.h"
|
|
|
|
class OptionButton : public Button {
|
|
GDCLASS(OptionButton, Button);
|
|
|
|
bool disable_shortcuts = false;
|
|
PopupMenu *popup = nullptr;
|
|
int current = -1;
|
|
bool fit_to_longest_item = true;
|
|
Vector2 _cached_size;
|
|
bool cache_refresh_pending = false;
|
|
bool allow_reselect = false;
|
|
|
|
struct ThemeCache {
|
|
Ref<StyleBox> normal;
|
|
|
|
Color font_color;
|
|
Color font_focus_color;
|
|
Color font_pressed_color;
|
|
Color font_hover_color;
|
|
Color font_hover_pressed_color;
|
|
Color font_disabled_color;
|
|
|
|
int h_separation = 0;
|
|
|
|
Ref<Texture2D> arrow_icon;
|
|
int arrow_margin = 0;
|
|
int modulate_arrow = 0;
|
|
} theme_cache;
|
|
|
|
void _focused(int p_which);
|
|
void _selected(int p_which);
|
|
void _select(int p_which, bool p_emit = false);
|
|
void _select_int(int p_which);
|
|
void _refresh_size_cache();
|
|
|
|
virtual void pressed() override;
|
|
|
|
protected:
|
|
Size2 get_minimum_size() const override;
|
|
virtual void _update_theme_item_cache() override;
|
|
virtual void _queue_update_size_cache() override;
|
|
void _notification(int p_what);
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
|
void _validate_property(PropertyInfo &p_property) const;
|
|
static void _bind_methods();
|
|
virtual void shortcut_input(const Ref<InputEvent> &p_event) override;
|
|
|
|
public:
|
|
// ATTENTION: This is used by the POT generator's scene parser. If the number of properties returned by `_get_items()` ever changes,
|
|
// this value should be updated to reflect the new size.
|
|
static const int ITEM_PROPERTY_SIZE = 5;
|
|
|
|
void add_icon_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1);
|
|
void add_item(const String &p_label, int p_id = -1);
|
|
|
|
void set_item_text(int p_idx, const String &p_text);
|
|
void set_item_icon(int p_idx, const Ref<Texture2D> &p_icon);
|
|
void set_item_id(int p_idx, int p_id);
|
|
void set_item_metadata(int p_idx, const Variant &p_metadata);
|
|
void set_item_disabled(int p_idx, bool p_disabled);
|
|
void set_item_tooltip(int p_idx, const String &p_tooltip);
|
|
|
|
String get_item_text(int p_idx) const;
|
|
Ref<Texture2D> get_item_icon(int p_idx) const;
|
|
int get_item_id(int p_idx) const;
|
|
int get_item_index(int p_id) const;
|
|
Variant get_item_metadata(int p_idx) const;
|
|
bool is_item_disabled(int p_idx) const;
|
|
bool is_item_separator(int p_idx) const;
|
|
String get_item_tooltip(int p_idx) const;
|
|
|
|
bool has_selectable_items() const;
|
|
int get_selectable_item(bool p_from_last = false) const;
|
|
|
|
void set_item_count(int p_count);
|
|
int get_item_count() const;
|
|
void set_fit_to_longest_item(bool p_fit);
|
|
bool is_fit_to_longest_item() const;
|
|
|
|
void set_allow_reselect(bool p_allow);
|
|
bool get_allow_reselect() const;
|
|
|
|
void add_separator(const String &p_text = "");
|
|
|
|
void clear();
|
|
|
|
void select(int p_idx);
|
|
int get_selected() const;
|
|
int get_selected_id() const;
|
|
Variant get_selected_metadata() const;
|
|
|
|
void remove_item(int p_idx);
|
|
|
|
PopupMenu *get_popup() const;
|
|
void show_popup();
|
|
|
|
void set_disable_shortcuts(bool p_disabled);
|
|
|
|
OptionButton(const String &p_text = String());
|
|
~OptionButton();
|
|
};
|
|
|
|
#endif // OPTION_BUTTON_H
|