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

228 lines
8.6 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see". Backported from #70885.
2023-01-10 14:26:54 +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
#include "scene/gui/popup.h"
class PopupMenu : public Popup {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GDCLASS(PopupMenu, Popup);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
struct Item {
Ref<Texture> icon;
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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool checked;
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,
} checkable_type;
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
int max_states;
int state;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
bool separator;
bool disabled;
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 id;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Variant metadata;
String submenu;
String tooltip;
uint32_t accel;
int _ofs_cache;
Click the inspected objet name to see all subresources.
2016-09-17 22:01:11 +00:00
int h_ofs;
-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
Ref<ShortCut> shortcut;
-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
bool shortcut_is_global;
Entirely new (and much improved) animation editor.
2018-06-07 15:46:14 +00:00
bool shortcut_is_disabled;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Item() {
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
checkable_type = CHECKABLE_TYPE_NONE;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
separator = false;
Implemented skeleton visibility Removed code visibility code from popup menu
2017-11-22 21:29:27 +00:00
max_states = 0;
state = 0;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
accel = 0;
disabled = false;
_ofs_cache = 0;
h_ofs = 0;
shortcut_is_global = false;
Entirely new (and much improved) animation editor.
2018-06-07 15:46:14 +00:00
shortcut_is_disabled = false;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Make `Menu/OptionButton` item auto-highlight behave better (cherry picked from commit 50506e19a6fd0a8c692bab8e642a71dfa3ed26d2)
2022-08-19 18:19:34 +00:00
bool activated_by_keyboard;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Timer *submenu_timer;
List<Rect2> autohide_areas;
Vector<Item> items;
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
int initial_button_mask;
bool during_grabbed_click;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int mouse_over;
int submenu_over;
Rect2 parent_rect;
-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
String _get_accel_text(int p_item) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
int _get_mouse_over(const Point2 &p_over) const;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
virtual Size2 get_minimum_size() const;
Allow popup menu scrolling without mouse wheel
2018-01-06 15:21:27 +00:00
void _scroll(float p_factor, const Point2 &p_over);
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
void _gui_input(const Ref<InputEvent> &p_event);
Make `Menu/OptionButton` item auto-highlight behave better (cherry picked from commit 50506e19a6fd0a8c692bab8e642a71dfa3ed26d2)
2022-08-19 18:19:34 +00:00
void _activate_submenu(int over, bool p_by_keyboard = false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _submenu_timeout();
-Work in progress visual shader editor *DOES NOT WORK YET*
2015-01-03 19:52:37 +00:00
bool invalidated_click;
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
bool hide_on_item_selection;
Update PopupMenu hiding Make PopupMenu hiding distinguish between checkable item and non checkable item.
2017-04-14 11:49:00 +00:00
bool hide_on_checkable_item_selection;
Change statable to multistate, remove extra separator
2017-12-12 02:37:37 +00:00
bool hide_on_multistate_item_selection;
context menu improvements
2018-01-02 07:10:49 +00:00
bool hide_on_window_lose_focus;
-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
Array _get_items() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _set_items(const Array &p_items);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Map<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
void _ref_shortcut(Ref<ShortCut> p_sc);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _unref_shortcut(Ref<ShortCut> p_sc);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Improvements to incremental search
2019-05-11 16:32:53 +00:00
bool allow_search;
uint64_t search_time_msec;
String search_string;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
protected:
virtual bool has_point(const Point2 &p_point) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class MenuButton;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
remove trailing whitespace
2016-03-08 23:00:52 +00:00
static void _bind_methods();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
public:
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 add_item(const String &p_label, int p_id = -1, uint32_t p_accel = 0);
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_icon_item(const Ref<Texture> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
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 add_check_item(const String &p_label, int p_id = -1, uint32_t p_accel = 0);
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_icon_check_item(const Ref<Texture> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
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 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<Texture> &p_icon, const String &p_label, int p_id = -1, uint32_t p_accel = 0);
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_multistate_item(const String &p_label, int p_max_states, int p_default_state = 0, int p_id = -1, uint32_t p_accel = 0);
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 add_shortcut(const Ref<ShortCut> &p_shortcut, int p_id = -1, bool p_global = false);
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_icon_shortcut(const Ref<Texture> &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
void add_check_shortcut(const Ref<ShortCut> &p_shortcut, int p_id = -1, bool p_global = false);
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_icon_check_shortcut(const Ref<Texture> &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
void add_radio_check_shortcut(const Ref<ShortCut> &p_shortcut, int p_id = -1, bool p_global = false);
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_icon_radio_check_shortcut(const Ref<Texture> &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
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_item_text(int p_idx, const String &p_text);
void set_item_icon(int p_idx, const Ref<Texture> &p_icon);
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);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
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);
GODOT IS OPEN SOURCE
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);
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);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
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);
Click the inspected objet name to see all subresources.
2016-09-17 22:01:11 +00:00
void set_item_h_offset(int p_idx, int p_offset);
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 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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<Texture> get_item_icon(int p_idx) const;
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;
GODOT IS OPEN SOURCE
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;
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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String get_item_tooltip(int p_idx) const;
-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
Ref<ShortCut> get_item_shortcut(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
Make popup menus focus items automatically when not using the mouse
2022-02-04 20:20:26 +00:00
void set_current_index(int p_idx);
PopupMenu.get_current_index() bound to ClassDB (cherry picked from commit 35f30086de7069df2854949948ae26642c5a1452)
2020-05-06 20:27:35 +00:00
int get_current_index() const;
Make popup menus focus items automatically when not using the mouse
2022-02-04 20:20:26 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int get_item_count() const;
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);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void activate_item(int p_item);
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` (cherry picked from commit ca8c794d0422f2e64a0afa0dab9b31a6589c7024)
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
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void clear();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_parent_rect(const Rect2 &p_rect);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual String get_tooltip(const Point2 &p_pos) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void get_translatable_strings(List<String> *p_strings) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void add_autohide_area(const Rect2 &p_area);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
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;
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
virtual void popup(const Rect2 &p_bounds = Rect2());
context menu improvements
2018-01-02 07:10:49 +00:00
void set_hide_on_window_lose_focus(bool p_enabled);
bool is_hide_on_window_lose_focus() const;
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-25 10:33:41 +00:00
#endif // POPUP_MENU_H