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

awful.client.shape: Turn into a client submodule.

This commit is contained in:
Emmanuel Lepage Vallee 2016-04-10 23:27:19 -04:00
parent 608f3eb7cf
commit 587fc1fbb4
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/awful/client/shape.lua
View File

@ -4,7 +4,7 @@
-- @author Uli Schlachter <psychon@znc.in> -- @author Uli Schlachter <psychon@znc.in>
-- @copyright 2014 Uli Schlachter -- @copyright 2014 Uli Schlachter
-- @release @AWESOME_VERSION@ -- @release @AWESOME_VERSION@
-- @module awful.client.shape -- @submodule client
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- Grab environment we need -- Grab environment we need
@ -18,7 +18,8 @@ local capi =
local shape = {} local shape = {}
shape.update = {} shape.update = {}
--- Get one of a client's shapes and transform it to include window decorations --- Get one of a client's shapes and transform it to include window decorations.
-- @function awful.shape.get_transformed
-- @client c The client whose shape should be retrieved -- @client c The client whose shape should be retrieved
-- @tparam string shape_name Either "bounding" or "clip" -- @tparam string shape_name Either "bounding" or "clip"
function shape.get_transformed(c, shape_name) function shape.get_transformed(c, shape_name)
@ -51,7 +52,8 @@ function shape.get_transformed(c, shape_name)
return result return result
end end
--- Update a client's bounding shape from the shape the client set itself --- Update a client's bounding shape from the shape the client set itself.
-- @function awful.shape.update.bounding
-- @client c The client to act on -- @client c The client to act on
function shape.update.bounding(c) function shape.update.bounding(c)
local res = shape.get_transformed(c, "bounding") local res = shape.get_transformed(c, "bounding")
@ -62,7 +64,8 @@ function shape.update.bounding(c)
end end
end end
--- Update a client's clip shape from the shape the client set itself --- Update a client's clip shape from the shape the client set itself.
-- @function awful.shape.update.clip
-- @client c The client to act on -- @client c The client to act on
function shape.update.clip(c) function shape.update.clip(c)
local res = shape.get_transformed(c, "clip") local res = shape.get_transformed(c, "clip")
@ -73,7 +76,8 @@ function shape.update.clip(c)
end end
end end
--- Update all of a client's shapes from the shapes the client set itself --- Update all of a client's shapes from the shapes the client set itself.
-- @function awful.shape.update.all
-- @client c The client to act on -- @client c The client to act on
function shape.update.all(c) function shape.update.all(c)
shape.update.bounding(c) shape.update.bounding(c)