From 7739a6a7edee7f137902872194d4484e41203abc Mon Sep 17 00:00:00 2001
From: Uli Schlachter <psychon@znc.in>
Date: Wed, 2 Mar 2016 20:04:19 +0100
Subject: [PATCH] Add a property::visible signal to tooltips

As requested here:
https://github.com/awesomeWM/awesome/commit/b4224a651f5a1bd28f9835e5fbc0342e696d7067#commitcomment-16402861

Signed-off-by: Uli Schlachter <psychon@znc.in>
---
 lib/awful/tooltip.lua | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

diff --git a/lib/awful/tooltip.lua b/lib/awful/tooltip.lua
index f38cd3652..6c37aeadb 100644
--- a/lib/awful/tooltip.lua
+++ b/lib/awful/tooltip.lua
@@ -42,6 +42,7 @@
 
 local mouse = mouse
 local timer = require("gears.timer")
+local object = require("gears.object")
 local wibox = require("wibox")
 local a_placement = require("awful.placement")
 local abutton = require("awful.button")
@@ -101,6 +102,7 @@ local function show(self)
     set_geometry(self)
     self.wibox.visible = true
     self.visible = true
+    self:emit_signal("property::visible")
 end
 
 -- Hide a tooltip.
@@ -116,6 +118,7 @@ local function hide(self)
     end
     self.wibox.visible = false
     self.visible = false
+    self:emit_signal("property::visible")
 end
 
 --- Change displayed text.
@@ -155,25 +158,26 @@ end
 --- Add tooltip to an object.
 --
 -- @tparam tooltip self The tooltip.
--- @tparam gears.object object An object with `mouse::enter` and
+-- @tparam gears.object obj An object with `mouse::enter` and
 --   `mouse::leave` signals.
-tooltip.add_to_object = function(self, object)
-    object:connect_signal("mouse::enter", self.show)
-    object:connect_signal("mouse::leave", self.hide)
+tooltip.add_to_object = function(self, obj)
+    obj:connect_signal("mouse::enter", self.show)
+    obj:connect_signal("mouse::leave", self.hide)
 end
 
 --- Remove tooltip from an object.
 --
 -- @tparam tooltip self The tooltip.
--- @tparam gears.object object An object with `mouse::enter` and
+-- @tparam gears.object obj An object with `mouse::enter` and
 --   `mouse::leave` signals.
-tooltip.remove_from_object = function(self, object)
-    object:disconnect_signal("mouse::enter", self.show)
-    object:disconnect_signal("mouse::leave", self.hide)
+tooltip.remove_from_object = function(self, obj)
+    obj:disconnect_signal("mouse::enter", self.show)
+    obj:disconnect_signal("mouse::leave", self.hide)
 end
 
 
 --- Create a new tooltip and link it to a widget.
+-- Tooltips emit `property::visible` when their visibility changes.
 -- @tparam table args Arguments for tooltip creation.
 -- @tparam[opt=1] number args.timeout The timeout value for
 --   `timer_function`.
@@ -191,9 +195,9 @@ end
 -- @see set_text
 -- @see set_markup
 tooltip.new = function(args)
-    local self = setmetatable({
-        visible = false,
-    }, instance_mt)
+    local self = setmetatable(object(), instance_mt)
+    self:add_signal("property::visible")
+    self.visible = false
 
     -- private data
     if args.delay_show then
@@ -265,8 +269,8 @@ tooltip.new = function(args)
 
     -- Add tooltip to objects
     if args.objects then
-        for _, object in ipairs(args.objects) do
-            self:add_to_object(object)
+        for _, obj in ipairs(args.objects) do
+            self:add_to_object(obj)
         end
     end