Merge pull request #2128 from Alan-Kuan/image-tooltip

Image tooltip

include/modules/image.hpp

@@ -24,12 +24,15 @@ class Image : public AModule {
  private:
   void delayWorker();
   void handleEvent();
+  void parseOutputRaw();
 
   Gtk::Box box_;
   Gtk::Image image_;
   std::string path_;
+  std::string tooltip_;
   int size_;
   int interval_;
+  util::command::res output_;
 
   util::SleeperThread thread_;
 };

man/waybar-image.5.scd

@@ -57,6 +57,20 @@ The *image* module displays an image from a path.
 	typeof: double ++
 	Threshold to be used when scrolling.
 
+*tooltip*: ++
+	typeof: bool ++
+	default: true ++
+	Option to enable tooltip on hover.
+
+# SCRIPT OUTPUT
+
+Similar to the *custom* module, output values of the script is *newline* separated.
+The following is the output format:
+
+```
+$path\\n$tooltip
+```
+
 # EXAMPLES
 
 ```

src/modules/image.cpp

@@ -41,14 +41,12 @@ void waybar::modules::Image::refresh(int sig) {
 }
 
 auto waybar::modules::Image::update() -> void {
-  util::command::res output_;
-
   Glib::RefPtr<Gdk::Pixbuf> pixbuf;
   if (config_["path"].isString()) {
     path_ = config_["path"].asString();
   } else if (config_["exec"].isString()) {
     output_ = util::command::exec(config_["exec"].asString());
-    path_ = output_.out;
+    parseOutputRaw();
   } else {
     path_ = "";
   }
@@ -58,6 +56,11 @@ auto waybar::modules::Image::update() -> void {
     pixbuf = {};
 
   if (pixbuf) {
+    if (tooltipEnabled() && !tooltip_.empty()) {
+      if (box_.get_tooltip_markup() != tooltip_) {
+        box_.set_tooltip_markup(tooltip_);
+      }
+    }
     image_.set(pixbuf);
     image_.show();
   } else {
@@ -67,3 +70,19 @@ auto waybar::modules::Image::update() -> void {
 
   AModule::update();
 }
+
+void waybar::modules::Image::parseOutputRaw() {
+  std::istringstream output(output_.out);
+  std::string line;
+  int i = 0;
+  while (getline(output, line)) {
+    if (i == 0) {
+      path_ = line;
+    } else if (i == 1) {
+      tooltip_ = line;
+    } else {
+      break;
+    }
+    i++;
+  }
+}