CoCalc -- native

GitHub Repository: godotengine/godot
Path: blob/master/servers/display/native_menu.h
²¹⁰⁸⁵ views
1
/**************************************************************************/
2
/*  native_menu.h                                                         */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#pragma once
32

33
#include "core/input/input_event.h"
34
#include "core/templates/rb_map.h"
35
#include "core/variant/callable.h"
36

37
class Texture2D;
38

39
class NativeMenu : public Object {
40
	GDCLASS(NativeMenu, Object)
41

42
	static NativeMenu *singleton;
43

44
protected:
45
	static void _bind_methods();
46

47
public:
48
	_FORCE_INLINE_ static NativeMenu *get_singleton() {
49
		return singleton;
50
	}
51

52
	enum Feature {
53
		FEATURE_GLOBAL_MENU,
54
		FEATURE_POPUP_MENU,
55
		FEATURE_OPEN_CLOSE_CALLBACK,
56
		FEATURE_HOVER_CALLBACK,
57
		FEATURE_KEY_CALLBACK,
58
	};
59

60
	enum SystemMenus {
61
		INVALID_MENU_ID,
62
		MAIN_MENU_ID,
63
		APPLICATION_MENU_ID,
64
		WINDOW_MENU_ID,
65
		HELP_MENU_ID,
66
		DOCK_MENU_ID,
67
	};
68

69
	virtual bool has_feature(Feature p_feature) const;
70

71
	virtual bool has_system_menu(SystemMenus p_menu_id) const;
72
	virtual RID get_system_menu(SystemMenus p_menu_id) const;
73
	virtual String get_system_menu_name(SystemMenus p_menu_id) const;
74

75
	virtual String get_system_menu_text(SystemMenus p_menu_id) const;
76
	virtual void set_system_menu_text(SystemMenus p_menu_id, const String &p_name);
77

78
	virtual RID create_menu();
79
	virtual bool has_menu(const RID &p_rid) const;
80
	virtual void free_menu(const RID &p_rid);
81

82
	virtual Size2 get_size(const RID &p_rid) const;
83
	virtual void popup(const RID &p_rid, const Vector2i &p_position);
84

85
	virtual void set_interface_direction(const RID &p_rid, bool p_is_rtl);
86

87
	virtual void set_popup_open_callback(const RID &p_rid, const Callable &p_callback);
88
	virtual Callable get_popup_open_callback(const RID &p_rid) const;
89
	virtual void set_popup_close_callback(const RID &p_rid, const Callable &p_callback);
90
	virtual Callable get_popup_close_callback(const RID &p_rid) const;
91
	virtual void set_minimum_width(const RID &p_rid, float p_width);
92
	virtual float get_minimum_width(const RID &p_rid) const;
93

94
	virtual bool is_opened(const RID &p_rid) const;
95

96
	virtual int add_submenu_item(const RID &p_rid, const String &p_label, const RID &p_submenu_rid, const Variant &p_tag = Variant(), int p_index = -1);
97
	virtual int add_item(const RID &p_rid, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
98
	virtual int add_check_item(const RID &p_rid, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
99
	virtual int add_icon_item(const RID &p_rid, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
100
	virtual int add_icon_check_item(const RID &p_rid, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
101
	virtual int add_radio_check_item(const RID &p_rid, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
102
	virtual int add_icon_radio_check_item(const RID &p_rid, const Ref<Texture2D> &p_icon, const String &p_label, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
103
	virtual int add_multistate_item(const RID &p_rid, const String &p_label, int p_max_states, int p_default_state, const Callable &p_callback = Callable(), const Callable &p_key_callback = Callable(), const Variant &p_tag = Variant(), Key p_accel = Key::NONE, int p_index = -1);
104
	virtual int add_separator(const RID &p_rid, int p_index = -1);
105

106
	virtual int find_item_index_with_text(const RID &p_rid, const String &p_text) const;
107
	virtual int find_item_index_with_tag(const RID &p_rid, const Variant &p_tag) const;
108
	virtual int find_item_index_with_submenu(const RID &p_rid, const RID &p_submenu_rid) const;
109

110
	virtual bool is_item_checked(const RID &p_rid, int p_idx) const;
111
	virtual bool is_item_checkable(const RID &p_rid, int p_idx) const;
112
	virtual bool is_item_radio_checkable(const RID &p_rid, int p_idx) const;
113
	virtual Callable get_item_callback(const RID &p_rid, int p_idx) const;
114
	virtual Callable get_item_key_callback(const RID &p_rid, int p_idx) const;
115
	virtual Variant get_item_tag(const RID &p_rid, int p_idx) const;
116
	virtual String get_item_text(const RID &p_rid, int p_idx) const;
117
	virtual RID get_item_submenu(const RID &p_rid, int p_idx) const;
118
	virtual Key get_item_accelerator(const RID &p_rid, int p_idx) const;
119
	virtual bool is_item_disabled(const RID &p_rid, int p_idx) const;
120
	virtual bool is_item_hidden(const RID &p_rid, int p_idx) const;
121
	virtual String get_item_tooltip(const RID &p_rid, int p_idx) const;
122
	virtual int get_item_state(const RID &p_rid, int p_idx) const;
123
	virtual int get_item_max_states(const RID &p_rid, int p_idx) const;
124
	virtual Ref<Texture2D> get_item_icon(const RID &p_rid, int p_idx) const;
125
	virtual int get_item_indentation_level(const RID &p_rid, int p_idx) const;
126

127
	virtual void set_item_checked(const RID &p_rid, int p_idx, bool p_checked);
128
	virtual void set_item_checkable(const RID &p_rid, int p_idx, bool p_checkable);
129
	virtual void set_item_radio_checkable(const RID &p_rid, int p_idx, bool p_checkable);
130
	virtual void set_item_callback(const RID &p_rid, int p_idx, const Callable &p_callback);
131
	virtual void set_item_key_callback(const RID &p_rid, int p_idx, const Callable &p_key_callback);
132
	virtual void set_item_hover_callbacks(const RID &p_rid, int p_idx, const Callable &p_callback);
133
	virtual void set_item_tag(const RID &p_rid, int p_idx, const Variant &p_tag);
134
	virtual void set_item_text(const RID &p_rid, int p_idx, const String &p_text);
135
	virtual void set_item_submenu(const RID &p_rid, int p_idx, const RID &p_submenu_rid);
136
	virtual void set_item_accelerator(const RID &p_rid, int p_idx, Key p_keycode);
137
	virtual void set_item_disabled(const RID &p_rid, int p_idx, bool p_disabled);
138
	virtual void set_item_hidden(const RID &p_rid, int p_idx, bool p_hidden);
139
	virtual void set_item_tooltip(const RID &p_rid, int p_idx, const String &p_tooltip);
140
	virtual void set_item_state(const RID &p_rid, int p_idx, int p_state);
141
	virtual void set_item_max_states(const RID &p_rid, int p_idx, int p_max_states);
142
	virtual void set_item_icon(const RID &p_rid, int p_idx, const Ref<Texture2D> &p_icon);
143
	virtual void set_item_indentation_level(const RID &p_rid, int p_idx, int p_level);
144
	virtual int set_item_index(const RID &p_rid, int p_idx, int p_target_idx);
145

146
	virtual int get_item_count(const RID &p_rid) const;
147
	virtual bool is_system_menu(const RID &p_rid) const;
148

149
	virtual void remove_item(const RID &p_rid, int p_idx);
150
	virtual void clear(const RID &p_rid);
151

152
	NativeMenu() {
153
		singleton = this;
154
	}
155

156
	~NativeMenu() {
157
		singleton = nullptr;
158
	}
159
};
160

161
VARIANT_ENUM_CAST(NativeMenu::Feature);
162
VARIANT_ENUM_CAST(NativeMenu::SystemMenus);
163

164
Product

Resources

Company
