mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
doc: Document all client layout theme properties.
This commit is contained in:
parent
85334faffd
commit
280973c9cb
7 changed files with 80 additions and 0 deletions
|
@ -14,6 +14,26 @@ local math = math
|
|||
local capi = {screen = screen}
|
||||
local tag = require("awful.tag")
|
||||
|
||||
--- The cornernw layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_cornernw
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The cornerne layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_cornerne
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The cornersw layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_cornersw
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The cornerse layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_cornerse
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- Actually arrange clients of p.clients for corner layout
|
||||
-- @param p Mandatory table containing required informations for layouts
|
||||
-- (clients to arrange, workarea geometry, etc.)
|
||||
|
|
|
@ -11,6 +11,16 @@
|
|||
local ipairs = ipairs
|
||||
local math = math
|
||||
|
||||
--- The fairh layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_fairh
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The fairv layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_fairv
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
local fair = {}
|
||||
|
||||
local function do_fair(p, orientation)
|
||||
|
|
|
@ -15,6 +15,11 @@ local capi =
|
|||
mousegrabber = mousegrabber
|
||||
}
|
||||
|
||||
--- The floating layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_floating
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
local floating = {}
|
||||
|
||||
--- Jump mouse cursor to the client's corner when resizing it.
|
||||
|
|
|
@ -18,6 +18,11 @@ local capi =
|
|||
mousegrabber = mousegrabber
|
||||
}
|
||||
|
||||
--- The magnifier layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_magnifier
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
local magnifier = {}
|
||||
|
||||
function magnifier.mouse_resize_handler(c, corner, x, y)
|
||||
|
|
|
@ -12,6 +12,16 @@ local pairs = pairs
|
|||
|
||||
local max = {}
|
||||
|
||||
--- The max layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_max
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The fullscreen layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_fullscreen
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
local function fmax(p, fs)
|
||||
-- Fullscreen?
|
||||
local area
|
||||
|
|
|
@ -13,6 +13,16 @@
|
|||
local ipairs = ipairs
|
||||
local math = math
|
||||
|
||||
--- The spiral layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_spiral
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The dwindle layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_dwindle
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
local spiral = {}
|
||||
|
||||
local function do_spiral(p, _spiral)
|
||||
|
|
|
@ -23,6 +23,26 @@ local capi =
|
|||
|
||||
local tile = {}
|
||||
|
||||
--- The tile layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_tile
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The tile top layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_tiletop
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The tile bottom layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_tilebottom
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- The tile left layout layoutbox icon.
|
||||
-- @beautiful beautiful.layout_tileleft
|
||||
-- @param surface
|
||||
-- @see gears.surface
|
||||
|
||||
--- Jump mouse cursor to the client's corner when resizing it.
|
||||
tile.resize_jump_to_corner = true
|
||||
|
||||
|
|
Loading…
Reference in a new issue