godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/scene/gui/popup_menu.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

359 lines
13 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* popup_menu.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. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef POPUP_MENU_H
#define POPUP_MENU_H
Entirely removes BIND_VMETHOD in favor of GDVIRTUAL * `_gui_input`, `_input`, `_unhandled_input` and `_unhandled_key_input` are now regular C++ virutal functions. * Everything else converted to GDVIRTUAL * BIND_VMETHOD is gone, always use the new syntax from now on. Creating `_gui_input` method and using the binder to register events will no longer work, simply override the virtual function now.
2021-08-22 15:37:22 +00:00
#include "core/input/shortcut.h"
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
#include "scene/gui/margin_container.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "scene/gui/popup.h"
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
#include "scene/gui/scroll_container.h"
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
#include "scene/property_list_helper.h"
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
#include "scene/resources/text_line.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
class PopupMenu : public Popup {
ObjectTypeDB was renamed to ClassDB. Types are meant to be more generic to Variant. All usages of "type" to refer to classes were renamed to "class" ClassDB has been exposed to GDScript. OBJ_TYPE() macro is now GDCLASS()
2017-01-03 02:03:46 +00:00
GDCLASS(PopupMenu, Popup);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
[macOS] Add default Window and Help menus, allow special menu customization.
2023-10-15 17:52:56 +00:00
static HashMap<String, PopupMenu *> system_menus;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
struct Item {
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> icon;
Make icons of scripted and custom classes fit the editor UI Also: - Add an option to limit the icon size in PopupMenu. This is similar to how this works in Tree and TreeItem. - Add the same option to TabBar. - Add a theme constant for Tree, PopupMenu, Button, and TabBar to apply this limit on the control level. Co-authored-by: Daylily-Zeleen <daylily-zeleen@foxmail.com>
2023-03-31 19:17:59 +00:00
int icon_max_width = 0;
Add icon_modulate functionality to PopupMenu
2022-12-19 05:38:08 +00:00
Color icon_modulate = Color(1, 1, 1, 1);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String text;
-Translation text will change automatically for in-game buttons, labels, poups when translation is changed. -Added a NOTIFICATION_TRANSLATION_CHANGED for controls that need custom code -Sorry, editor will not update automatically because it uses a different translatio method.
2017-01-09 19:43:44 +00:00
String xl_text;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
Ref<TextLine> text_buf;
Ref<TextLine> accel_text_buf;
String language;
Control::TextDirection text_direction = Control::TEXT_DIRECTION_AUTO;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
bool checked = false;
Add radio-button-looking entries to PopupMenu They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually. `is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button. Keeping check in the name adds an additional clue about these facts. Closes #13055.
2018-03-23 20:55:40 +00:00
enum {
CHECKABLE_TYPE_NONE,
CHECKABLE_TYPE_CHECK_BOX,
CHECKABLE_TYPE_RADIO_BUTTON,
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
} checkable_type = CHECKABLE_TYPE_NONE;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int max_states = 0;
int state = 0;
bool separator = false;
bool disabled = false;
bool dirty = true;
int id = 0;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Variant metadata;
String submenu;
String tooltip;
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
Key accel = Key::NONE;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int _ofs_cache = 0;
int _height_cache = 0;
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
int indent = 0;
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 19:53:24 +00:00
Ref<Shortcut> shortcut;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
bool shortcut_is_global = false;
bool shortcut_is_disabled = false;
Add option to allow echo events in menu shortcuts
2020-02-23 21:23:34 +00:00
bool allow_echo = false;
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
bool submenu_bound = false;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
// Returns (0,0) if icon is null.
Size2 get_icon_size() const {
return icon.is_null() ? Size2() : icon->get_size();
}
-Changed most project settings in the engine, so they have major and minor categories. -Changed SectionedPropertyEditor to support this -Renamed Globals singleton to GlobalConfig, makes more sense. -Changed the logic behind persisten global settings, instead of the persist checkbox, a revert button is now available
2017-01-05 12:16:00 +00:00
Item() {
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
text_buf.instantiate();
accel_text_buf.instantiate();
Add radio-button-looking entries to PopupMenu They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually. `is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button. Keeping check in the name adds an additional clue about these facts. Closes #13055.
2018-03-23 20:55:40 +00:00
checkable_type = CHECKABLE_TYPE_NONE;
-Changed most project settings in the engine, so they have major and minor categories. -Changed SectionedPropertyEditor to support this -Renamed Globals singleton to GlobalConfig, makes more sense. -Changed the logic behind persisten global settings, instead of the persist checkbox, a revert button is now available
2017-01-05 12:16:00 +00:00
}
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
Item(bool p_dummy) {}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
static inline PropertyListHelper base_property_helper;
PropertyListHelper property_helper;
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
String global_menu_name;
[macOS] Add default Window and Help menus, allow special menu customization.
2023-10-15 17:52:56 +00:00
String system_menu_name;
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
Added hysteresis for popup sub-menus This adds a small lag effect when opening submenus which allow the user to move directly to an item on the submenu without worrying about avoiding the autohide regions.
2020-09-07 12:57:50 +00:00
bool close_allowed = false;
Fix sub-menu keyboard navigation.
2022-04-13 06:58:38 +00:00
bool activated_by_keyboard = false;
Added hysteresis for popup sub-menus This adds a small lag effect when opening submenus which allow the user to move directly to an item on the submenu without worrying about avoiding the autohide regions.
2020-09-07 12:57:50 +00:00
Timer *minimum_lifetime_timer = nullptr;
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
Timer *submenu_timer = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
List<Rect2> autohide_areas;
Vector<Item> items;
Fix selecting popup menu items on mouse release
2024-01-08 05:07:24 +00:00
bool mouse_is_pressed = true;
bool drag_to_press = true;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
int mouse_over = -1;
int submenu_over = -1;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
String _get_accel_text(const Item &p_item) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int _get_mouse_over(const Point2 &p_over) const;
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Size2 _get_contents_minimum_size() const override;
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
Unify item indexing in `PopupMenu`
2023-05-24 13:58:50 +00:00
int _get_item_height(int p_idx) const;
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
int _get_items_total_height() const;
Unify item indexing in `PopupMenu`
2023-05-24 13:58:50 +00:00
Size2 _get_item_icon_size(int p_idx) const;
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
Unify item indexing in `PopupMenu`
2023-05-24 13:58:50 +00:00
void _shape_item(int p_idx);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
Fix sub-menu keyboard navigation.
2022-04-13 06:58:38 +00:00
void _activate_submenu(int p_over, bool p_by_keyboard = false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _submenu_timeout();
Fix popup menu item selected when opening the menu In order to allow selecting items by either holding left click, or click to open and click again to select, mouse button release was invalidated based on the amount of mouse motion. This was causing issues in some scenarios where an item could be selected while opening the menu if the mouse moved enough between button press and release. This case could happen in the language selection of the project manager, especially on linux, because of the order and timing of the mouse events on x11. This change invalidates mouse release based on a timing condition rather than moved distance to handle any case from the display server properly.
2020-09-18 18:45:59 +00:00
uint64_t popup_time_msec = 0;
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
bool hide_on_item_selection = true;
bool hide_on_checkable_item_selection = true;
bool hide_on_multistate_item_selection = false;
-Work in progress visual shader editor *DOES NOT WORK YET*
2015-01-03 19:52:37 +00:00
Vector2 moved;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<Ref<Shortcut>, int> shortcut_refcount;
-customizable shortcuts in editor -editor settings now save to .tres instead of .xml -buttons can now hold a shortcut
2016-06-05 00:31:29 +00:00
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 19:53:24 +00:00
void _ref_shortcut(Ref<Shortcut> p_sc);
void _unref_shortcut(Ref<Shortcut> p_sc);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ensure popup menu redraws items when shortcuts update.
2022-09-26 13:21:04 +00:00
void _shortcut_changed();
Initialize class variables with default values in scene/ [2/2]
2021-02-09 17:24:36 +00:00
bool allow_search = true;
uint64_t search_time_msec = 0;
String search_string = "";
Improvements to incremental search
2019-05-11 16:32:53 +00:00
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
MarginContainer *margin_container = nullptr;
ScrollContainer *scroll_container = nullptr;
Control *control = nullptr;
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
feat(gamepad): improve gamepad behavior with slider and popup_menu
2023-02-09 16:25:56 +00:00
const float DEFAULT_GAMEPAD_EVENT_DELAY_MS = 0.5;
const float GAMEPAD_EVENT_REPEAT_RATE_MS = 1.0 / 20;
float gamepad_event_delay_ms = DEFAULT_GAMEPAD_EVENT_DELAY_MS;
Add dumb and manual theme caching systems to Window
2022-09-01 10:38:08 +00:00
struct ThemeCache {
Ref<StyleBox> panel_style;
Ref<StyleBox> hover_style;
Ref<StyleBox> separator_style;
Ref<StyleBox> labeled_separator_left;
Ref<StyleBox> labeled_separator_right;
int v_separation = 0;
int h_separation = 0;
int indent = 0;
int item_start_padding = 0;
int item_end_padding = 0;
Make icons of scripted and custom classes fit the editor UI Also: - Add an option to limit the icon size in PopupMenu. This is similar to how this works in Tree and TreeItem. - Add the same option to TabBar. - Add a theme constant for Tree, PopupMenu, Button, and TabBar to apply this limit on the control level. Co-authored-by: Daylily-Zeleen <daylily-zeleen@foxmail.com>
2023-03-31 19:17:59 +00:00
int icon_max_width = 0;
Add dumb and manual theme caching systems to Window
2022-09-01 10:38:08 +00:00
Ref<Texture2D> checked;
Ref<Texture2D> checked_disabled;
Ref<Texture2D> unchecked;
Ref<Texture2D> unchecked_disabled;
Ref<Texture2D> radio_checked;
Ref<Texture2D> radio_checked_disabled;
Ref<Texture2D> radio_unchecked;
Ref<Texture2D> radio_unchecked_disabled;
Ref<Texture2D> submenu;
Ref<Texture2D> submenu_mirrored;
Ref<Font> font;
int font_size = 0;
Ref<Font> font_separator;
int font_separator_size = 0;
Color font_color;
Color font_hover_color;
Color font_disabled_color;
Color font_accelerator_color;
int font_outline_size = 0;
Color font_outline_color;
Color font_separator_color;
int font_separator_outline_size = 0;
Color font_separator_outline_color;
} theme_cache;
PopupMenu rework and enhancements Many scrolling behaviour improvements and the ability to limit popup size.
2020-08-29 12:05:59 +00:00
void _draw_items();
void _draw_background();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Added hysteresis for popup sub-menus This adds a small lag effect when opening submenus which allow the user to move directly to an item on the submenu without worrying about avoiding the autohide regions.
2020-09-07 12:57:50 +00:00
void _minimum_lifetime_timeout();
void _close_pressed();
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
void _menu_changed();
Fix internal events not being delivered to some Window types `AcceptDialog`, `Popup` and `PopupMenu` no longer subscribe to "window_input" signal, because that is only sent if it is not an internal signal. Instead they receive events in `_input_from_window`. They ensure that the event is also propagated to their super-function, just like previously the signals would be treated.
2023-09-01 06:40:35 +00:00
void _input_from_window_internal(const Ref<InputEvent> &p_event);
[PopupMenu] Handle physical_keycode and key_label of shortcuts.
2023-10-06 06:36:42 +00:00
bool _set_item_accelerator(int p_index, const Ref<InputEventKey> &p_ie);
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
void _set_item_checkable_type(int p_index, int p_checkable_type);
int _get_item_checkable_type(int p_index) const;
Added hysteresis for popup sub-menus This adds a small lag effect when opening submenus which allow the user to move directly to an item on the submenu without worrying about avoiding the autohide regions.
2020-09-07 12:57:50 +00:00
Popups are now windows also (broken!)
2020-03-12 12:37:40 +00:00
protected:
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
virtual void add_child_notify(Node *p_child) override;
virtual void remove_child_notify(Node *p_child) override;
Fix internal events not being delivered to some Window types `AcceptDialog`, `Popup` and `PopupMenu` no longer subscribe to "window_input" signal, because that is only sent if it is not an internal signal. Instead they receive events in `_input_from_window`. They ensure that the event is also propagated to their super-function, just like previously the signals would be treated.
2023-09-01 06:40:35 +00:00
virtual void _input_from_window(const Ref<InputEvent> &p_event) override;
Register theme properties with ThemeDB
2023-09-08 19:00:10 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
Implement inspector property array for `PopupMenu` and `MenuButton`
2021-11-03 02:08:58 +00:00
bool _set(const StringName &p_name, const Variant &p_value);
Add PropertyListHelper to PopupMenu
2024-02-11 11:09:55 +00:00
bool _get(const StringName &p_name, Variant &r_ret) const { return property_helper.property_get_value(p_name, r_ret); }
void _get_property_list(List<PropertyInfo> *p_list) const { property_helper.get_property_list(p_list, items.size()); }
bool _property_can_revert(const StringName &p_name) const { return property_helper.property_can_revert(p_name); }
bool _property_get_revert(const StringName &p_name, Variant &r_property) const { return property_helper.property_get_revert(p_name, r_property); }
remove trailing whitespace
2016-03-08 23:00:52 +00:00
static void _bind_methods();
Add option to allow echo events in menu shortcuts
2020-02-23 21:23:34 +00:00
#ifndef DISABLE_DEPRECATED
void _add_shortcut_bind_compat_36493(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
void _add_icon_shortcut_bind_compat_36493(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false);
Free submenu children when clearing PopupMenu
2023-07-27 17:50:31 +00:00
void _clear_bind_compat_79965();
Add option to allow echo events in menu shortcuts
2020-02-23 21:23:34 +00:00
static void _bind_compatibility_methods();
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
Make some enhancements to the POT generation
2021-08-01 05:53:36 +00:00
// 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 = 10;
Single-window mode popups and edited scene windows fixes. Fix single-window mode popup not closing when OptionBox is clicked. Fix single-window mode submenus closing when parent menu item, that was used to open it is clicked (using same safe-area logic as platform specific code). Disallow windows that are part of an edited scene from being set as exclusive or popup to prevent it from locking up the editor.
2022-06-09 08:59:01 +00:00
virtual void _parent_focused() override;
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
String bind_global_menu();
void unbind_global_menu();
[macOS] Add default Window and Help menus, allow special menu customization.
2023-10-15 17:52:56 +00:00
bool is_system_menu() const;
void set_system_menu_root(const String &p_special);
String get_system_menu_root() const;
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
void add_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
void add_icon_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
void add_check_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
void add_icon_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
void add_radio_check_item(const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
void add_icon_radio_check_item(const Ref<Texture2D> &p_icon, const String &p_label, int p_id = -1, Key p_accel = Key::NONE);
Change "ID" to lowercase "id" Reasoning: ID is not an acronym, it is simply short for identification, so it logically should not be capitalized. But even if it was an acronym, other acronyms in Godot are not capitalized, like p_rid, p_ip, and p_json.
2019-05-09 09:21:49 +00:00
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
void add_multistate_item(const String &p_label, int p_max_states, int p_default_state = 0, int p_id = -1, Key p_accel = Key::NONE);
PopupMenu: Reorder add_* methods in more natural order Also adds `add_icon_radio_check_shortcut` matching `add_icon_radio_check_item`, binds them for scripting languages, and binds `add_multistate_item`.
2019-10-08 06:28:26 +00:00
Add option to allow echo events in menu shortcuts
2020-02-23 21:23:34 +00:00
void add_shortcut(const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false, bool p_allow_echo = false);
void add_icon_shortcut(const Ref<Texture2D> &p_icon, const Ref<Shortcut> &p_shortcut, int p_id = -1, bool p_global = false, bool p_allow_echo = false);
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 19:53:24 +00:00
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);
Change "ID" to lowercase "id" Reasoning: ID is not an acronym, it is simply short for identification, so it logically should not be capitalized. But even if it was an acronym, other acronyms in Godot are not capitalized, like p_rid, p_ip, and p_json.
2019-05-09 09:21:49 +00:00
PopupMenu: Reorder add_* methods in more natural order Also adds `add_icon_radio_check_shortcut` matching `add_icon_radio_check_item`, binds them for scripting languages, and binds `add_multistate_item`.
2019-10-08 06:28:26 +00:00
void add_submenu_item(const String &p_label, const String &p_submenu, int p_id = -1);
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void set_item_text(int p_idx, const String &p_text);
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
void set_item_text_direction(int p_idx, Control::TextDirection p_text_direction);
void set_item_language(int p_idx, const String &p_language);
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
void set_item_icon(int p_idx, const Ref<Texture2D> &p_icon);
Make icons of scripted and custom classes fit the editor UI Also: - Add an option to limit the icon size in PopupMenu. This is similar to how this works in Tree and TreeItem. - Add the same option to TabBar. - Add a theme constant for Tree, PopupMenu, Button, and TabBar to apply this limit on the control level. Co-authored-by: Daylily-Zeleen <daylily-zeleen@foxmail.com>
2023-03-31 19:17:59 +00:00
void set_item_icon_max_width(int p_idx, int p_width);
Add icon_modulate functionality to PopupMenu
2022-12-19 05:38:08 +00:00
void set_item_icon_modulate(int p_idx, const Color &p_modulate);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
void set_item_checked(int p_idx, bool p_checked);
Change "ID" to lowercase "id" Reasoning: ID is not an acronym, it is simply short for identification, so it logically should not be capitalized. But even if it was an acronym, other acronyms in Godot are not capitalized, like p_rid, p_ip, and p_json.
2019-05-09 09:21:49 +00:00
void set_item_id(int p_idx, int p_id);
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
void set_item_accelerator(int p_idx, Key p_accel);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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);
void set_item_as_separator(int p_idx, bool p_separator);
void set_item_as_checkable(int p_idx, bool p_checkable);
Add radio-button-looking entries to PopupMenu They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually. `is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button. Keeping check in the name adds an additional clue about these facts. Closes #13055.
2018-03-23 20:55:40 +00:00
void set_item_as_radio_checkable(int p_idx, bool p_radio_checkable);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void set_item_tooltip(int p_idx, const String &p_tooltip);
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 19:53:24 +00:00
void set_item_shortcut(int p_idx, const Ref<Shortcut> &p_shortcut, bool p_global = false);
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
void set_item_indent(int p_idx, int p_indent);
Expose PopupMenu get_item_multistate(), get_item_multistate_max() and set_item_multistate_max()
2024-01-20 06:10:28 +00:00
void set_item_max_states(int p_idx, int p_max_states);
Change statable to multistate, remove extra separator
2017-12-12 02:37:37 +00:00
void set_item_multistate(int p_idx, int p_state);
void toggle_item_multistate(int p_idx);
Entirely new (and much improved) animation editor.
2018-06-07 15:46:14 +00:00
void set_item_shortcut_disabled(int p_idx, bool p_disabled);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
PopupMenu: added toggle_item_checked and exposed set_item_tooltip and get_item_tooltip
2016-10-01 13:50:54 +00:00
void toggle_item_checked(int p_idx);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String get_item_text(int p_idx) const;
Fix invalid minimum size for translated messages in option button
2023-06-27 14:22:58 +00:00
String get_item_xl_text(int p_idx) const;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 11:22:16 +00:00
Control::TextDirection get_item_text_direction(int p_idx) const;
String get_item_language(int p_idx) const;
Fix uncheckable checkboxes in RMB menu. closes #9625
2017-07-14 08:45:24 +00:00
int get_item_idx_from_text(const String &text) const;
Texture refactor -Texture renamed to Texture2D -TextureLayered as base now inherits 2Darray, cubemap and cubemap array -Removed all references to flags in textures (they will go in the shader) -Texture3D gone for now (will come back later done properly) -Create base rasterizer for RenderDevice, RasterizerRD
2019-06-11 18:43:37 +00:00
Ref<Texture2D> get_item_icon(int p_idx) const;
Make icons of scripted and custom classes fit the editor UI Also: - Add an option to limit the icon size in PopupMenu. This is similar to how this works in Tree and TreeItem. - Add the same option to TabBar. - Add a theme constant for Tree, PopupMenu, Button, and TabBar to apply this limit on the control level. Co-authored-by: Daylily-Zeleen <daylily-zeleen@foxmail.com>
2023-03-31 19:17:59 +00:00
int get_item_icon_max_width(int p_idx) const;
Add icon_modulate functionality to PopupMenu
2022-12-19 05:38:08 +00:00
Color get_item_icon_modulate(int p_idx) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool is_item_checked(int p_idx) const;
Makes all Godot API's methods Lower Case
2017-08-07 10:17:31 +00:00
int get_item_id(int p_idx) const;
Change "ID" to lowercase "id" Reasoning: ID is not an acronym, it is simply short for identification, so it logically should not be capitalized. But even if it was an acronym, other acronyms in Godot are not capitalized, like p_rid, p_ip, and p_json.
2019-05-09 09:21:49 +00:00
int get_item_index(int p_id) const;
Use "enum class" for input enums
2021-08-13 21:31:57 +00:00
Key get_item_accelerator(int p_idx) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Variant get_item_metadata(int p_idx) const;
bool is_item_disabled(int p_idx) const;
Synchronize parameter names in definition and declaration Fixes #10244.
2017-08-11 19:10:05 +00:00
String get_item_submenu(int p_idx) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool is_item_separator(int p_idx) const;
bool is_item_checkable(int p_idx) const;
Add radio-button-looking entries to PopupMenu They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually. `is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button. Keeping check in the name adds an additional clue about these facts. Closes #13055.
2018-03-23 20:55:40 +00:00
bool is_item_radio_checkable(int p_idx) const;
Entirely new (and much improved) animation editor.
2018-06-07 15:46:14 +00:00
bool is_item_shortcut_disabled(int p_idx) const;
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
bool is_item_shortcut_global(int p_idx) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String get_item_tooltip(int p_idx) const;
Rename ShortCut to Shortcut which is more grammatically correct See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980.
2020-09-09 19:53:24 +00:00
Ref<Shortcut> get_item_shortcut(int p_idx) const;
Implement `MenuBar` control to wrap `PopupMenu`s or native menu, use native menu for editor.
2022-08-01 09:28:16 +00:00
int get_item_indent(int p_idx) const;
int get_item_max_states(int p_idx) const;
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
int get_item_state(int p_idx) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename `PopupMenu`'s `set/get_current_index()` to `set/get_focused_item()`
2022-09-06 13:51:14 +00:00
void set_focused_item(int p_idx);
int get_focused_item() const;
Implement inspector property array for `PopupMenu` and `MenuButton`
2021-11-03 02:08:58 +00:00
void set_item_count(int p_count);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int get_item_count() const;
Unify item indexing in `PopupMenu`
2023-05-24 13:58:50 +00:00
void scroll_to_item(int p_idx);
Enhancements and fixes for `OptionButton` and `PopupMenu`
2022-02-06 02:47:00 +00:00
Removal of InputEvent as built-in Variant type.. this might cause bugs I haven't found yet..
2017-05-20 15:38:03 +00:00
bool activate_item_by_event(const Ref<InputEvent> &p_event, bool p_for_global_only = false);
Unify item indexing in `PopupMenu`
2023-05-24 13:58:50 +00:00
void activate_item(int p_idx);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
[macOS] Add `about_to_open` and `popup_hide` callback for the global menus, move part of logic to the PopupMenu to allow live menu modification.
2023-07-11 08:17:35 +00:00
void _about_to_popup();
void _about_to_close();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void remove_item(int p_idx);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Added optional id parameter to `PopupMenu::add_separator`
2020-12-27 12:18:47 +00:00
void add_separator(const String &p_text = String(), int p_id = -1);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Free submenu children when clearing PopupMenu
2023-07-27 17:50:31 +00:00
void clear(bool p_free_submenus = true);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_tooltip(const Point2 &p_pos) const;
void add_autohide_area(const Rect2 &p_area);
void clear_autohide_areas();
PopupMenu upgrade: Hide on item selection (#7306) * Added the option to set hide on item selection. Usable in GDScript and from within the source code when you want to specify popup menus you don't want to close immediately when selecting an item * Renamed getter from get_ to is_, fixed parent/child behavior, renamed bool variable to match most code and added ADD_PROPERTYNO to save some memory
2016-12-23 14:43:45 +00:00
void set_hide_on_item_selection(bool p_enabled);
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
bool is_hide_on_item_selection() const;
-Work in progress visual shader editor *DOES NOT WORK YET*
2015-01-03 19:52:37 +00:00
Update PopupMenu hiding Make PopupMenu hiding distinguish between checkable item and non checkable item.
2017-04-14 11:49:00 +00:00
void set_hide_on_checkable_item_selection(bool p_enabled);
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
bool is_hide_on_checkable_item_selection() const;
Change statable to multistate, remove extra separator
2017-12-12 02:37:37 +00:00
void set_hide_on_multistate_item_selection(bool p_enabled);
bool is_hide_on_multistate_item_selection() const;
Update PopupMenu hiding Make PopupMenu hiding distinguish between checkable item and non checkable item.
2017-04-14 11:49:00 +00:00
Add ability to set submenu's popup delay time on mouse hovering This allows to set delay time for the submenu to popup. Setting this value low can increase responsiveness. If the popup menu is added as a child of another (acting as a submenu), it will inherit the delay time of the parent menu item.
2018-07-09 12:16:06 +00:00
void set_submenu_popup_delay(float p_time);
float get_submenu_popup_delay() const;
Improvements to incremental search
2019-05-11 16:32:53 +00:00
void set_allow_search(bool p_allow);
bool get_allow_search() const;
[macOS] Implement optional native file selection dialog support for sandboxed apps.
2021-03-30 12:42:50 +00:00
virtual void popup(const Rect2i &p_bounds = Rect2i()) override;
Improve popup menus usability It seems that popups were intended to "grab" the mouse click that triggered them, but their intent was being lost. This commit does the necessary changes to let it happen and updates items that were trying to get advantage of it, because the semantics of `Control::grab_click_focus()` have changed a bit. Namely, it must be called **before** showing the modal. This allows to popup a menu and activate an item in it in a single click-point-release cycle, instead of having to click once to open the menu and once more to pick an item. This ability is extended even to context menus activated with the RMB (or any other mouse button, for that matter). The editor benefits from this in the context menu of the tree dock, which has been patched to opt-in for this feature. This improves UX a bit by saving unnecessary clicks. From now on, `PopupMenu` always grabs the click and also invalidates the first button release unless the mouse has moved (that's what `set_invalidate_click_until_motion()` was doing and now it's removed), so there is no longer the need of doing both things at every point a pop-up menu is shown.
2018-03-27 21:41:27 +00:00
Popups have also been converted to windows Controls using the old modal API have been replaced to use popups.
2020-03-20 02:32:09 +00:00
void take_mouse_focus();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
PopupMenu();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
~PopupMenu();
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // POPUP_MENU_H