summaryrefslogtreecommitdiffstats
path: root/editor/editor_help.h
diff options
context:
space:
mode:
Diffstat (limited to 'editor/editor_help.h')
-rw-r--r--editor/editor_help.h31
1 files changed, 29 insertions, 2 deletions
diff --git a/editor/editor_help.h b/editor/editor_help.h
index 1f1528945b..0ca3942e0b 100644
--- a/editor/editor_help.h
+++ b/editor/editor_help.h
@@ -157,7 +157,7 @@ class EditorHelp : public VBoxContainer {
//void _button_pressed(int p_idx);
void _add_type(const String &p_type, const String &p_enum = String(), bool p_is_bitfield = false);
void _add_type_icon(const String &p_type, int p_size = 0, const String &p_fallback = "");
- void _add_method(const DocData::MethodDoc &p_method, bool p_overview = true);
+ void _add_method(const DocData::MethodDoc &p_method, bool p_overview, bool p_override = true);
void _add_bulletpoint();
@@ -177,7 +177,7 @@ class EditorHelp : public VBoxContainer {
Error _goto_desc(const String &p_class);
//void _update_history_buttons();
- void _update_method_list(const Vector<DocData::MethodDoc> p_methods);
+ void _update_method_list(const Vector<DocData::MethodDoc> p_methods, MethodType p_method_type);
void _update_method_descriptions(const DocData::ClassDoc p_classdoc, const Vector<DocData::MethodDoc> p_methods, MethodType p_method_type);
void _update_doc();
@@ -232,6 +232,12 @@ public:
class EditorHelpBit : public MarginContainer {
GDCLASS(EditorHelpBit, MarginContainer);
+ inline static HashMap<StringName, String> doc_class_cache;
+ inline static HashMap<StringName, HashMap<StringName, String>> doc_property_cache;
+ inline static HashMap<StringName, HashMap<StringName, String>> doc_method_cache;
+ inline static HashMap<StringName, HashMap<StringName, String>> doc_signal_cache;
+ inline static HashMap<StringName, HashMap<StringName, String>> doc_theme_item_cache;
+
RichTextLabel *rich_text = nullptr;
void _go_to_help(String p_what);
void _meta_clicked(String p_select);
@@ -243,9 +249,30 @@ protected:
void _notification(int p_what);
public:
+ String get_class_description(const StringName &p_class_name) const;
+ String get_property_description(const StringName &p_class_name, const StringName &p_property_name) const;
+ String get_method_description(const StringName &p_class_name, const StringName &p_method_name) const;
+ String get_signal_description(const StringName &p_class_name, const StringName &p_signal_name) const;
+ String get_theme_item_description(const StringName &p_class_name, const StringName &p_theme_item_name) const;
+
RichTextLabel *get_rich_text() { return rich_text; }
void set_text(const String &p_text);
+
EditorHelpBit();
};
+class EditorHelpTooltip : public EditorHelpBit {
+ GDCLASS(EditorHelpTooltip, EditorHelpBit);
+
+ String tooltip_text;
+
+protected:
+ void _notification(int p_what);
+
+public:
+ void parse_tooltip(const String &p_text);
+
+ EditorHelpTooltip(const String &p_text = String());
+};
+
#endif // EDITOR_HELP_H