Border_marked naming consistency (#3084)

* finish renaming border_marked to border_color_marked

* doc: document border_color_fullscreen, update border_color_marked and fix typo

* deprecate instead of removing

* doc: fix border_color_marked
This commit is contained in:
Unai 2020-05-04 10:42:09 +02:00 committed by GitHub
parent 6f1702541c
commit 1518b0f4c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 40 additions and 22 deletions

View File

@ -1,6 +1,15 @@
*/
/**
* The border color when the client is marked.
* It has priority over the rest of beautiful border color properties.
* Note that only solid colors are supported.
* @beautiful beautiful.border_color_marked
* @param color
* @see request::border
*/
/**
* The fallback border color when the client is floating.
*
@ -14,9 +23,9 @@
*/
/**
* The fallback border color when the client is mazimized.
* The fallback border color when the client is maximized.
*
* @beautiful beautiful.border_color_mazimized
* @beautiful beautiful.border_color_maximized
* @param color
* @see request::border
* @see beautiful.border_color_maximized_active
@ -25,6 +34,18 @@
* @see beautiful.border_color_maximized_new
*/
/**
* The fallback border color when the client is fullscreen.
*
* @beautiful beautiful.border_color_fullscreen
* @param color
* @see request::border
* @see beautiful.border_color_fullscreen_active
* @see beautiful.border_color_fullscreen_normal
* @see beautiful.border_color_fullscreen_urgent
* @see beautiful.border_color_fullscreen_new
*/
/**
* The border color when the client is active.
*
@ -160,7 +181,7 @@
* @param integer
* @see request::border
* @see beautiful.border_width_floating
* @see beautiful.border_width_mazimized
* @see beautiful.border_width_maximized
* @see beautiful.border_width_floating_active
* @see beautiful.border_width_floating_normal
* @see beautiful.border_width_floating_urgent
@ -184,9 +205,9 @@
*/
/**
* The fallback border width when the client is mazimized.
* The fallback border width when the client is maximized.
*
* @beautiful beautiful.border_width_mazimized
* @beautiful beautiful.border_width_maximized
* @param integer
* @see request::border
* @see beautiful.border_width_maximized_active
@ -482,11 +503,4 @@
* @see request::border
*/
/**
* The marked clients border color.
* Note that only solid colors are supported.
* @beautiful beautiful.border_marked
* @param color
*/
/*

View File

@ -630,12 +630,6 @@ end
-- @emits unmarker (for legacy reasons, use `property::marked`)
-- @emits property::marked
--- The border color when the client is focused.
--
-- @beautiful beautiful.border_marked
-- @param string
--
function client.object.set_marked(self, value)
local is_marked = self.marked

View File

@ -543,6 +543,7 @@ end, "mouse_enter")
-- (urgent, new, active, normal)
--
-- @signalhandler awful.ewmh.update_border
-- @usebeautiful beautiful.border_color_marked
-- @usebeautiful beautiful.border_color_active
-- @usebeautiful beautiful.border_color_normal
-- @usebeautiful beautiful.border_color_new
@ -637,9 +638,18 @@ function permissions.update_border(c, context)
-- never have been added to the core. The documentation claims it works,
-- even if it has been broken for 90% of AwesomeWM releases ever since
-- it was added.
if c.marked and beautiful.border_marked then
c._border_color = beautiful.border_marked
return
if c.marked then
if beautiful.border_color_marked then
c._border_color = beautiful.border_color_marked
return
elseif beautiful.border_marked then
gdebug.deprecate(
"Use `beautiful.border_color_marked` instead of `beautiful.border_marked`",
{deprecated_in=5}
)
c._border_color = beautiful.border_marked
return
end
end
local tv = beautiful["border_color"..suffix]

View File

@ -29,7 +29,7 @@ theme.useless_gap = dpi(0)
theme.border_width = dpi(1)
theme.border_color_normal = "#000000"
theme.border_color_active = "#535d6c"
theme.border_marked = "#91231c"
theme.border_color_marked = "#91231c"
-- There are other variable sets
-- overriding the default one when