awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update docs for shape_input 

I grepped for shape_clip and edited places that needed editing.

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2017-01-26 11:15:28 +01:00
parent 70834848e4
commit 47d69e7824
3 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/common/wibox.ldoc
View File

@ -161,6 +161,15 @@
-- @property shape_clip -- @property shape_clip
-- @param surface._native -- @param surface._native
--- The wibox's input shape as a (native) cairo surface.
--
-- **Signal:**
--
-- * *property::shape_input*
--
-- @property shape_input
-- @param surface._native
--- Get or set mouse buttons bindings to a wibox. --- Get or set mouse buttons bindings to a wibox.
-- --
-- @param buttons_table A table of buttons objects, or nothing. -- @param buttons_table A table of buttons objects, or nothing.

1
lib/awful/wibar.lua
View File

@ -288,6 +288,7 @@ end
-- @tparam wibox.widget arg.widget The widget that the wibox displays. -- @tparam wibox.widget arg.widget The widget that the wibox displays.
-- @param arg.shape_bounding The wibox’s bounding shape as a (native) cairo surface. -- @param arg.shape_bounding The wibox’s bounding shape as a (native) cairo surface.
-- @param arg.shape_clip The wibox’s clip shape as a (native) cairo surface. -- @param arg.shape_clip The wibox’s clip shape as a (native) cairo surface.
-- @param arg.shape_input The wibox’s input shape as a (native) cairo surface.
-- @tparam color arg.bg The background of the wibox. -- @tparam color arg.bg The background of the wibox.
-- @tparam surface arg.bgimage The background image of the drawable. -- @tparam surface arg.bgimage The background image of the drawable.
-- @tparam color arg.fg The foreground (text) of the wibox. -- @tparam color arg.fg The foreground (text) of the wibox.

3
lib/wibox/init.lua
View File

@ -31,6 +31,7 @@ wibox.hierarchy = require("wibox.hierarchy")
local force_forward = { local force_forward = {
shape_bounding = true, shape_bounding = true,
shape_clip = true, shape_clip = true,
shape_input = true,
} }
--@DOC_wibox_COMMON@ --@DOC_wibox_COMMON@
@ -120,6 +121,7 @@ local function setup_signals(_wibox)
clone_signal("property::geometry") clone_signal("property::geometry")
clone_signal("property::shape_bounding") clone_signal("property::shape_bounding")
clone_signal("property::shape_clip") clone_signal("property::shape_clip")
clone_signal("property::shape_input")
obj = _wibox._drawable obj = _wibox._drawable
clone_signal("button::press") clone_signal("button::press")
@ -147,6 +149,7 @@ end
-- @tparam wibox.widget args.widget The widget that the wibox displays. -- @tparam wibox.widget args.widget The widget that the wibox displays.
-- @param args.shape_bounding The wibox’s bounding shape as a (native) cairo surface. -- @param args.shape_bounding The wibox’s bounding shape as a (native) cairo surface.
-- @param args.shape_clip The wibox’s clip shape as a (native) cairo surface. -- @param args.shape_clip The wibox’s clip shape as a (native) cairo surface.
-- @param args.shape_input The wibox’s input shape as a (native) cairo surface.
-- @tparam color args.bg The background of the wibox. -- @tparam color args.bg The background of the wibox.
-- @tparam surface args.bgimage The background image of the drawable. -- @tparam surface args.bgimage The background image of the drawable.
-- @tparam color args.fg The foreground (text) of the wibox. -- @tparam color args.fg The foreground (text) of the wibox.