ui: top menu items show tooltips

Author: dalerank

src/graphics/elements/generic_button.h

@@ -37,7 +37,7 @@ struct generic_button {
     generic_button &onrclick(onclick_void f) { return onrclick([f] (int, int) { f(); }); }
 
     generic_button &tooltip(textid t);
-    generic_button &tooltip(pcstr t) { _tooltip = t; return *this; }
+    generic_button &tooltip(const xstring &t) { _tooltip = t; return *this; }
     generic_button &tooltip(const std::initializer_list<int> &t);
 };
 

src/graphics/elements/menu.h

@@ -13,7 +13,7 @@ struct menu_item {
     void (*left_click_handler)(int) = nullptr;
     int parameter;
     int hidden = false;
-    bstring64 text;
+    xstring text;
     xstring id;
 };
 

src/graphics/elements/tooltip.cpp

@@ -76,10 +76,10 @@ static void draw_button_tooltip(tooltip_context* c) {
     }
 
     int width = 200;
-    int lines = text_measure_multiline(c->text, width - 5, FONT_SMALL_SHADED);
+    int lines = text_measure_multiline((const uint8_t *)c->text.c_str(), width - 5, FONT_SMALL_SHADED);
     if (lines > 2) {
         width = 300;
-        lines = text_measure_multiline(c->text, width - 5, FONT_SMALL_SHADED);
+        lines = text_measure_multiline((const uint8_t*)c->text.c_str(), width - 5, FONT_SMALL_SHADED);
     }
 
     int height = 16 * lines + 10;
@@ -137,7 +137,7 @@ static void draw_button_tooltip(tooltip_context* c) {
 
     //save_window_under_tooltip_to_buffer(x, y, width, height);
     draw_tooltip_box(x, y, width, height);
-    text_draw_multiline(c->text, x + 5, y + 7, width - 5, FONT_SMALL_SHADED, COLOR_TOOLTIP_TEXT);
+    text_draw_multiline((const uint8_t *)c->text.c_str(), x + 5, y + 7, width - 5, FONT_SMALL_SHADED, COLOR_TOOLTIP_TEXT);
 }
 
 static void draw_overlay_tooltip(tooltip_context* c) {
@@ -149,7 +149,7 @@ static void draw_overlay_tooltip(tooltip_context* c) {
         text = overlay_string;
     } else if (c->num_extra_values > 0) {
         text = overlay_string;
-        int offset = text.len();
+        size_t offset = text.len();
         overlay_string[offset++] = ':';
         overlay_string[offset++] = '\n';
         for (int i = 0; i < c->num_extra_values; i++) {

src/graphics/elements/tooltip.h

@@ -2,6 +2,7 @@
 
 #include "core/vec2i.h"
 #include "core/string.h"
+#include "core/xstring.h"
 
 #include <functional>
 
@@ -11,7 +12,7 @@ struct mouse;
 struct tooltip_context {
     vec2i mpos;
     int high_priority = 0;
-    bstring256 text;
+    xstring text;
     int has_numeric_prefix = 0;
     int numeric_prefix = 0;
     int num_extra_values = 0;

src/graphics/elements/ui.cpp

@@ -29,6 +29,10 @@ namespace ui {
         return tooltipctx;
     }
 
+    void set_tooltip(const xstring &text) {
+        tooltipctx.text = text;
+    }
+
     struct universal_button {
         enum e_btn_type {
             unknown = -1,
@@ -937,6 +941,8 @@ void ui::emenu_header::load(archive arch, element *parent, items &elems) {
     assert(!strcmp(type, "menu_header"));
 
     _font = (e_font)arch.r_int("font", FONT_NORMAL_BLACK_ON_LIGHT);
+    _tooltip = arch.r_string("tooltip");
+
     impl.text = arch.r_string("text");
     if (!!impl.text && impl.text[0u] == '#') {
         impl.text = lang_text_from_key(impl.text.c_str());

src/graphics/elements/ui.h

@@ -49,6 +49,7 @@ namespace ui {
 struct img_button_offsets { int data[4] = {0, 1, 2, 3}; };
 
 const tooltip_context &get_tooltip();
+void set_tooltip(const xstring &text);
 void begin_frame();
 void end_frame();
 void begin_widget(vec2i offset, bool relative = false);
@@ -126,7 +127,7 @@ struct element {
     virtual int value() const { return 0; }
     virtual void select(bool v) {}
     virtual void max_value(int v) {}
-    virtual pcstr tooltip() const { return ""; }
+    virtual const xstring &tooltip() const { return xstring(); }
     virtual element &onclick(std::function<void(int, int)>) { return *this; }
             element &onclick(std::function<void()> f) { onclick([f] (int, int) { f(); });  return *this; }
     virtual void onevent(std::function<void()>) { }
@@ -256,7 +257,7 @@ struct elabel : public element {
     virtual void text_color(color) override;
     virtual void font(int) override;
     virtual e_font font() const override { return _font; }
-    virtual pcstr tooltip() const override { return _tooltip.c_str(); }
+    virtual const xstring &tooltip() const override { return _tooltip; }
     virtual void width(int) override;
 };
 
@@ -277,13 +278,15 @@ struct escrollbar : public element {
 
 struct emenu_header : public element {
     menu_header impl;
+    xstring _tooltip;
     e_font _font;
 
     virtual void load(archive elem, element *parent, items &elems) override;
             void load_items(archive elem, pcstr section);
     virtual void draw() override;
     virtual void font(int v) override { _font = (e_font)v; }
     virtual void text(pcstr text) override { impl.text = text; }
+    virtual const xstring &tooltip() const override { return _tooltip; }
     virtual int text_width() override;
             menu_item &item(int i) { static menu_item dummy; return i < impl.items.size() ? impl.items[i] : dummy; }
             menu_item &item(pcstr key);

src/scripts/ui.js

@@ -59,9 +59,9 @@ top_menu_widget = {
 	offset_rotate_basic : 200,
 
 	headers : {
-		file 					: { type: "menu_header", text: {group:7, id:0} },
-		options				: { type: "menu_header", text: {group:2, id:0} },
-		help		   		: { type: "menu_header", text: {group:3, id:0} },
+		file 					: { type: "menu_header", text: {group:7, id:0}, tooltip:[68, 51] },
+		options				: { type: "menu_header", text: {group:2, id:0}, tooltip:[68, 52] },
+		help		   		: { type: "menu_header", text: {group:3, id:0}, tooltip:[68, 53] },
 		advisors  		: { type: "menu_header", text: {group:4, id:0} },
 		debug		   		: { type: "menu_header", text: "Debug" },
 		debug_render  : { type: "menu_header", text: "Render" },

src/widget/widget_top_menu_game.cpp

@@ -279,11 +279,17 @@ void widget_top_menu_draw_elements() {
             continue;
         }
 
+        const bool is_hovered = (it->id == data.focus_menu_id);
+
         header->impl.x_start = offset.x;
-        header->font((it->id == data.focus_menu_id) ? hightlight_font : FONT_NORMAL_BLACK_ON_LIGHT);
+        header->font(is_hovered ? hightlight_font : FONT_NORMAL_BLACK_ON_LIGHT);
         header->pos = vec2i{offset.x, data.offset.y};
         header->draw();
 
+        if (is_hovered) {
+            ui::set_tooltip(header->tooltip());
+        }
+
         offset.x += header->text_width();
         header->impl.x_end = offset.x;
         offset.x += data.spacing;
@@ -321,7 +327,7 @@ static void top_menu_calculate_menu_dimensions(menu_header& menu) {
             continue;
         }
 
-        int width_pixels = lang_text_get_width(item.text, FONT_NORMAL_BLACK_ON_LIGHT);
+        int width_pixels = lang_text_get_width(item.text.c_str(), FONT_NORMAL_BLACK_ON_LIGHT);
         max_width = std::max(max_width, width_pixels);
 
         height_pixels += data.item_height;
@@ -346,7 +352,7 @@ void top_menu_menu_draw(const xstring header, const xstring focus_item_id) {
             continue;
         }
         // Set color/font on the menu item mouse hover
-        lang_text_draw(item.text, vec2i{impl.x_start + 8, y_offset}, item.id == focus_item_id ? FONT_NORMAL_YELLOW : FONT_NORMAL_BLACK_ON_LIGHT);
+        lang_text_draw(item.text.c_str(), vec2i{impl.x_start + 8, y_offset}, item.id == focus_item_id ? FONT_NORMAL_YELLOW : FONT_NORMAL_BLACK_ON_LIGHT);
         y_offset += menu.item_height;
     }
 }