Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tooltip: improve doc, call self.timer_function with self (#381)

This commit is contained in:
Daniel Hahler 2016-06-03 00:40:02 +02:00
parent 12f42fc9cc
commit 51ce375f01
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lib/awful/tooltip.lua
View File

@ -18,7 +18,7 @@
-- end, -- end,
-- }) -- })
-- --
-- How to add the same tooltip to several objects? -- How to add the same tooltip to multiple objects?
-- --- -- ---
-- --
-- myclock_t:add_to_object(obj1) -- myclock_t:add_to_object(obj1)
@ -26,7 +26,7 @@
-- --
-- Now the same tooltip is attached to `myclock`, `obj1`, `obj2`. -- Now the same tooltip is attached to `myclock`, `obj1`, `obj2`.
-- --
-- How to remove tooltip from many objects? -- How to remove a tooltip from several objects?
-- --- -- ---
-- --
-- myclock_t:remove_from_object(obj1) -- myclock_t:remove_from_object(obj1)
@ -95,7 +95,7 @@ local function show(self)
if self.visible then return end if self.visible then return end
if self.timer then if self.timer then
if not self.timer.started then if not self.timer.started then
self.timer_function() self:timer_function()
self.timer:start() self.timer:start()
end end
end end
@ -179,11 +179,11 @@ end
--- Create a new tooltip and link it to a widget. --- Create a new tooltip and link it to a widget.
-- Tooltips emit `property::visible` when their visibility changes. -- Tooltips emit `property::visible` when their visibility changes.
-- @tparam table args Arguments for tooltip creation. -- @tparam table args Arguments for tooltip creation.
-- @tparam[opt=1] number args.timeout The timeout value for
-- `timer_function`.
-- @tparam function args.timer_function A function to dynamically set the -- @tparam function args.timer_function A function to dynamically set the
-- tooltip text. Its return value will be passed to -- tooltip text. Its return value will be passed to
-- `wibox.widget.textbox.set_markup`. -- `wibox.widget.textbox.set_markup`.
-- @tparam[opt=1] number args.timeout The timeout value for
-- `timer_function`.
-- @tparam[opt] table args.objects A list of objects linked to the tooltip. -- @tparam[opt] table args.objects A list of objects linked to the tooltip.
-- @tparam[opt] number args.delay_show Delay showing the tooltip by this many -- @tparam[opt] number args.delay_show Delay showing the tooltip by this many
-- seconds. -- seconds.