godot/scene/gui/popup_menu.h

246 lines
8.9 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* popup_menu.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* 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. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef POPUP_MENU_H
#define POPUP_MENU_H
#include "scene/gui/margin_container.h"
2014-02-10 01:10:30 +00:00
#include "scene/gui/popup.h"
#include "scene/gui/scroll_container.h"
2020-03-12 12:37:40 +00:00
#include "scene/gui/shortcut.h"
2014-02-10 01:10:30 +00:00
class PopupMenu : public Popup {
GDCLASS(PopupMenu, Popup);
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
struct Item {
Ref<Texture2D> icon;
2014-02-10 01:10:30 +00:00
String text;
String xl_text;
2014-02-10 01:10:30 +00:00
bool checked;
enum {
CHECKABLE_TYPE_NONE,
CHECKABLE_TYPE_CHECK_BOX,
CHECKABLE_TYPE_RADIO_BUTTON,
} checkable_type;
int max_states;
int state;
2014-02-10 01:10:30 +00:00
bool separator;
bool disabled;
int id;
2014-02-10 01:10:30 +00:00
Variant metadata;
String submenu;
String tooltip;
uint32_t accel;
int _ofs_cache;
int _height_cache;
int h_ofs;
Ref<Shortcut> shortcut;
bool shortcut_is_global;
bool shortcut_is_disabled;
2016-03-08 23:00:52 +00:00
// Returns (0,0) if icon is null.
Size2 get_icon_size() const {
return icon.is_null() ? Size2() : icon->get_size();
}
Item() {
checked = false;
checkable_type = CHECKABLE_TYPE_NONE;
separator = false;
max_states = 0;
state = 0;
accel = 0;
disabled = false;
_ofs_cache = 0;
_height_cache = 0;
h_ofs = 0;
shortcut_is_global = false;
shortcut_is_disabled = false;
}
2014-02-10 01:10:30 +00:00
};
2016-03-08 23:00:52 +00:00
bool close_allowed = false;
Timer *minimum_lifetime_timer = nullptr;
2014-02-10 01:10:30 +00:00
Timer *submenu_timer;
List<Rect2> autohide_areas;
Vector<Item> items;
int initial_button_mask;
bool during_grabbed_click;
2014-02-10 01:10:30 +00:00
int mouse_over;
int submenu_over;
Rect2 parent_rect;
String _get_accel_text(int p_item) const;
int _get_mouse_over(const Point2 &p_over) const;
2020-07-10 10:34:39 +00:00
virtual Size2 _get_contents_minimum_size() const override;
int _get_items_total_height() const;
void _scroll_to_item(int p_item);
void _gui_input(const Ref<InputEvent> &p_event);
void _activate_submenu(int p_over);
2014-02-10 01:10:30 +00:00
void _submenu_timeout();
uint64_t popup_time_msec = 0;
bool hide_on_item_selection;
bool hide_on_checkable_item_selection;
bool hide_on_multistate_item_selection;
Vector2 moved;
2014-02-10 01:10:30 +00:00
Array _get_items() const;
void _set_items(const Array &p_items);
2014-02-10 01:10:30 +00:00
Map<Ref<Shortcut>, int> shortcut_refcount;
void _ref_shortcut(Ref<Shortcut> p_sc);
void _unref_shortcut(Ref<Shortcut> p_sc);
2014-02-10 01:10:30 +00:00
2019-05-11 16:32:53 +00:00
bool allow_search;
uint64_t search_time_msec;
String search_string;
MarginContainer *margin_container;
ScrollContainer *scroll_container;
2020-03-12 12:37:40 +00:00
Control *control;
void _draw_items();
void _draw_background();
2014-02-10 01:10:30 +00:00
void _minimum_lifetime_timeout();
void _close_pressed();
2020-03-12 12:37:40 +00:00
protected:
friend class MenuButton;
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
2016-03-08 23:00:52 +00:00
static void _bind_methods();
public:
void add_item(const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_icon_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_check_item(const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_icon_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_radio_check_item(const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_icon_radio_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
void add_multistate_item(const String &p_label, int p_max_states, int p_default_state = 0, int p_id = -1, uint32_t p_accel = 0);
void add_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_icon_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_check_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_icon_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_radio_check_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_icon_radio_check_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void add_submenu_item(const String &p_label, const String &p_submenu, 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_checked(int p_idx, bool p_checked);
void set_item_id(int p_idx, int p_id);
void set_item_accelerator(int p_idx, uint32_t p_accel);
void set_item_metadata(int p_idx, const Variant &p_meta);
void set_item_disabled(int p_idx, bool p_disabled);
void set_item_submenu(int p_idx, const String &p_submenu);
2014-02-10 01:10:30 +00:00
void set_item_as_separator(int p_idx, bool p_separator);
void set_item_as_checkable(int p_idx, bool p_checkable);
void set_item_as_radio_checkable(int p_idx, bool p_radio_checkable);
void set_item_tooltip(int p_idx, const String &p_tooltip);
void set_item_shortcut(int p_idx, const Ref<Shortcut> &p_shortcut, bool p_global = false);
void set_item_h_offset(int p_idx, int p_offset);
void set_item_multistate(int p_idx, int p_state);
void toggle_item_multistate(int p_idx);
void set_item_shortcut_disabled(int p_idx, bool p_disabled);
2014-02-10 01:10:30 +00:00
void toggle_item_checked(int p_idx);
2014-02-10 01:10:30 +00:00
String get_item_text(int p_idx) const;
int get_item_idx_from_text(const String &text) const;
Ref<Texture2D> get_item_icon(int p_idx) const;
2014-02-10 01:10:30 +00:00
bool is_item_checked(int p_idx) const;
int get_item_id(int p_idx) const;
int get_item_index(int p_id) const;
2014-02-10 01:10:30 +00:00
uint32_t get_item_accelerator(int p_idx) const;
Variant get_item_metadata(int p_idx) const;
bool is_item_disabled(int p_idx) const;
String get_item_submenu(int p_idx) const;
2014-02-10 01:10:30 +00:00
bool is_item_separator(int p_idx) const;
bool is_item_checkable(int p_idx) const;
bool is_item_radio_checkable(int p_idx) const;
bool is_item_shortcut_disabled(int p_idx) const;
2014-02-10 01:10:30 +00:00
String get_item_tooltip(int p_idx) const;
Ref<Shortcut> get_item_shortcut(int p_idx) const;
int get_item_state(int p_idx) const;
2014-02-10 01:10:30 +00:00
int get_current_index() const;
2014-02-10 01:10:30 +00:00
int get_item_count() const;
bool activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only = false);
2014-02-10 01:10:30 +00:00
void activate_item(int p_item);
void remove_item(int p_idx);
2016-03-08 23:00:52 +00:00
2018-07-14 21:15:42 +00:00
void add_separator(const String &p_text = String());
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void clear();
void set_parent_rect(const Rect2 &p_rect);
2014-02-10 01:10:30 +00:00
virtual String get_tooltip(const Point2 &p_pos) const;
2014-02-10 01:10:30 +00:00
2020-07-10 10:34:39 +00:00
virtual void get_translatable_strings(List<String> *p_strings) const override;
2014-02-10 01:10:30 +00:00
void add_autohide_area(const Rect2 &p_area);
2014-02-10 01:10:30 +00:00
void clear_autohide_areas();
void set_hide_on_item_selection(bool p_enabled);
bool is_hide_on_item_selection() const;
void set_hide_on_checkable_item_selection(bool p_enabled);
bool is_hide_on_checkable_item_selection() const;
void set_hide_on_multistate_item_selection(bool p_enabled);
bool is_hide_on_multistate_item_selection() const;
void set_submenu_popup_delay(float p_time);
float get_submenu_popup_delay() const;
2019-05-11 16:32:53 +00:00
void set_allow_search(bool p_allow);
bool get_allow_search() const;
virtual void popup(const Rect2 &p_bounds = Rect2());
void take_mouse_focus();
2016-03-08 23:00:52 +00:00
PopupMenu();
2014-02-10 01:10:30 +00:00
~PopupMenu();
};
#endif