doc: Document the beautiful vars used by the systray and textbox

This commit is contained in:
Emmanuel Lepage Vallee 2016-05-23 03:13:15 -04:00
parent 9d0693ce3a
commit 3c2aa09b86
2 changed files with 11 additions and 0 deletions

View File

@ -23,6 +23,14 @@ local base_size = nil
local reverse = false local reverse = false
local display_on_screen = "primary" local display_on_screen = "primary"
--- The systray background color.
-- @beautiful beautiful.bg_systray
-- @param string The color (string like "#ff0000" only)
--- The systray icon spacing.
-- @beautiful beautiful.systray_icon_spacing
-- @tparam[opt=0] integer The icon spacing
local function should_display_on(s) local function should_display_on(s)
if display_on_screen == "primary" then if display_on_screen == "primary" then
return s == capi.screen.primary return s == capi.screen.primary

View File

@ -18,6 +18,9 @@ local pairs = pairs
local textbox = { mt = {} } local textbox = { mt = {} }
--- The textbox font.
-- @beautiful beautiful.font
--- Set the DPI of a Pango layout --- Set the DPI of a Pango layout
local function setup_dpi(box, dpi) local function setup_dpi(box, dpi)
if box.dpi ~= dpi then if box.dpi ~= dpi then