Miroirs/awesome
1
0
Fork 0
mirror of https://github.com/awesomeWM/awesome synced 2024-11-16 07:47:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update lib/awful/wallpaper.lua

Browse source 
Co-authored-by: Aire-One <aireone@aireone.xyz>
This commit is contained in:
Emmanuel Lepage Vallée 2021-09-25 12:49:19 -07:00 committed by Emmanuel Lepage Vallee
parent 546ac6aec9
commit eb07ca4c47
1 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
lib/awful/wallpaper.lua
View file

@ -808,19 +808,24 @@ end
--- Create a wallpaper.
--
-- Note that all parameters are not required. Please refer to the
-- module description and examples to understand parameters usages.
--
-- @constructorfct awful.wallpaper
-- @tparam table args
-- @tparam wibox.widget args.widget The wallpaper widget.
-- @tparam number args.dpi The wallpaper DPI (dots per inch).
-- @tparam screen args.screen The wallpaper screen.
-- @tparam table args.screens A list of screen for this wallpaper.
-- @tparam gears.color args.bg The background color.
-- @tparam gears.color args.fg The foreground color.
-- @tparam gears.color args.uncovered_areas_color The color for the uncovered areas.
-- @tparam boolean args.honor_workarea Honor the workarea.
-- @tparam boolean args.honor_padding Honor the screen padding.
-- @tparam table args.uncovered_areas Returns the list of screen(s) area which won't be covered by the wallpaper.
-- @tparam function|string args.panning_area Defines where the wallpaper is placed when there is multiple screens.
-- @tparam[opt] wibox.widget args.widget The wallpaper widget.
-- @tparam[opt] number args.dpi The wallpaper DPI (dots per inch).
-- @tparam[opt] screen args.screen The wallpaper screen.
-- @tparam[opt] table args.screens A list of screen for this wallpaper.
-- Use this parameter as a remplacement for `args.screen` to manage multiscreen wallpaper.
-- (Note: the expected table should be an array-like table `{screen1, screen2, ...}`)
-- @tparam[opt] gears.color args.bg The background color.
-- @tparam[opt] gears.color args.fg The foreground color.
-- @tparam[opt] gears.color args.uncovered_areas_color The color for the uncovered areas.
-- @tparam[opt] boolean args.honor_workarea Honor the workarea.
-- @tparam[opt] boolean args.honor_padding Honor the screen padding.
-- @tparam[opt] table args.uncovered_areas Returns the list of screen(s) area which won't be covered by the wallpaper.
-- @tparam[opt] function|string args.panning_area Defines where the wallpaper is placed when there is multiple screens.
local function new(_, args)
args = args or {}