Merge pull request #2019 from Elv13/doc_tests_and_notif_p1_9
Add a separator widget.
This commit is contained in:
Emmanuel Lepage Vallée
GitHub
commit
6a4414eb3d
|
|
@ -20,6 +20,7 @@ local widget = {
|
|||
piechart = require("wibox.widget.piechart");
|
||||
slider = require("wibox.widget.slider");
|
||||
calendar = require("wibox.widget.calendar");
|
||||
separator = require("wibox.widget.separator");
|
||||
}
|
||||
|
||||
setmetatable(widget, {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,205 @@
|
|||
---------------------------------------------------------------------------
|
||||
-- A flexible separator widget.
|
||||
--
|
||||
-- By default, this widget display a simple line, but can be extended by themes
|
||||
-- (or directly) to display much more complex visuals.
|
||||
--
|
||||
-- This widget is mainly intended to be used alongside the `spacing_widget`
|
||||
-- property supported by various layouts such as:
|
||||
--
|
||||
-- * `wibox.layout.fixed`
|
||||
-- * `wibox.layout.flex`
|
||||
-- * `wibox.layout.ratio`
|
||||
--
|
||||
-- When used with these layouts, it is also possible to provide custom clipping
|
||||
-- functions. This is useful when the layout has overlapping widgets (negative
|
||||
-- spacing).
|
||||
--
|
||||
--@DOC_wibox_widget_defaults_separator_EXAMPLE@
|
||||
--
|
||||
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
|
||||
-- @copyright 2014, 2017 Emmanuel Lepage Vallee
|
||||
-- @classmod wibox.widget.separator
|
||||
---------------------------------------------------------------------------
|
||||
local beautiful = require( "beautiful" )
|
||||
local base = require( "wibox.widget.base" )
|
||||
local color = require( "gears.color" )
|
||||
local gtable = require( "gears.table" )
|
||||
|
||||
local separator = {}
|
||||
|
||||
--- The separator's orientation.
|
||||
--
|
||||
-- Valid values are:
|
||||
--
|
||||
-- * *vertical*: From top to bottom
|
||||
-- * *horizontal*: From left to right
|
||||
-- * *auto*: Decide depending on the widget geometry (default)
|
||||
--
|
||||
-- The default value is selected automatically. If the widget is taller than
|
||||
-- large, it will use vertical and vice versa.
|
||||
--
|
||||
--@DOC_wibox_widget_separator_orientation_EXAMPLE@
|
||||
--
|
||||
-- @property orientation
|
||||
-- @param string
|
||||
|
||||
--- The separator's thickness.
|
||||
--
|
||||
-- This is used by the default line separator, but ignored when a shape is used.
|
||||
--
|
||||
-- @property thickness
|
||||
-- @param number
|
||||
|
||||
--- The separator's shape.
|
||||
--
|
||||
--@DOC_wibox_widget_separator_shape_EXAMPLE@
|
||||
--
|
||||
-- @property shape
|
||||
-- @tparam function shape A valid shape function
|
||||
-- @see gears.shape
|
||||
|
||||
--- The relative percentage covered by the bar.
|
||||
-- @property span_ratio
|
||||
-- @tparam[opt=1] number A number between 0 and 1.
|
||||
|
||||
--- The separator's color.
|
||||
-- @property color
|
||||
-- @param string
|
||||
-- @see gears.color
|
||||
|
||||
--- The separator's border color.
|
||||
--
|
||||
--@DOC_wibox_widget_separator_border_color_EXAMPLE@
|
||||
--
|
||||
-- @property border_color
|
||||
-- @param string
|
||||
-- @see gears.color
|
||||
|
||||
--- The separator's border width.
|
||||
-- @property border_width
|
||||
-- @param number
|
||||
|
||||
--- The separator thickness.
|
||||
-- @beautiful beautiful.separator_thickness
|
||||
-- @param number
|
||||
-- @see thickness
|
||||
|
||||
--- The separator border color.
|
||||
-- @beautiful beautiful.separator_border_color
|
||||
-- @param gears.color
|
||||
-- @see border_color
|
||||
|
||||
--- The separator border width.
|
||||
-- @beautiful beautiful.separator_border_width
|
||||
-- @param number
|
||||
-- @see border_width
|
||||
|
||||
--- The relative percentage covered by the bar.
|
||||
-- @beautiful beautiful.separator_span_ratio
|
||||
-- @tparam[opt=1] number A number between 0 and 1.
|
||||
|
||||
--- The separator's color.
|
||||
-- @beautiful beautiful.separator_color
|
||||
-- @param string
|
||||
-- @see gears.color
|
||||
|
||||
--- The separator's shape.
|
||||
--
|
||||
-- @beautiful beautiful.separator_shape
|
||||
-- @tparam function shape A valid shape function
|
||||
-- @see gears.shape
|
||||
|
||||
local function draw_shape(self, _, cr, width, height, shape)
|
||||
local bw = self._private.border_width or beautiful.separator_border_width or 0
|
||||
local bc = self._private.border_color or beautiful.separator_border_color
|
||||
|
||||
cr:translate(bw/2, bw/2)
|
||||
|
||||
shape(cr, width-bw, height-bw)
|
||||
|
||||
if bw == 0 then
|
||||
cr:fill()
|
||||
elseif bc then
|
||||
cr:fill_preserve()
|
||||
cr:set_source(color(bc))
|
||||
cr:set_line_width(bw)
|
||||
cr:stroke()
|
||||
end
|
||||
end
|
||||
|
||||
local function draw_line(self, _, cr, width, height)
|
||||
local thickness = self._private.thickness or beautiful.separator_thickness or 1
|
||||
|
||||
local orientation = self._private.orientation ~= "auto" and
|
||||
self._private.orientation or (width > height and "horizontal" or "vertical")
|
||||
|
||||
local span_ratio = self.span_ratio or 1
|
||||
|
||||
if orientation == "horizontal" then
|
||||
local w = width*span_ratio
|
||||
cr:rectangle((width-w)/2, height/2 - thickness/2, w, thickness)
|
||||
else
|
||||
local h = height*span_ratio
|
||||
cr:rectangle(width/2 - thickness/2, (height-h)/2, thickness, h)
|
||||
end
|
||||
|
||||
cr:fill()
|
||||
end
|
||||
|
||||
local function draw(self, _, cr, width, height)
|
||||
-- In case there is a specialized.
|
||||
local draw_custom = self._private.draw or beautiful.separator_draw
|
||||
if draw_custom then
|
||||
return draw_custom(self, _, cr, width, height)
|
||||
end
|
||||
|
||||
local col = self._private.color or beautiful.separator_color
|
||||
|
||||
if col then
|
||||
cr:set_source(color(col))
|
||||
end
|
||||
|
||||
local s = self._private.shape or beautiful.separator_shape
|
||||
|
||||
if s then
|
||||
draw_shape(self, _, cr, width, height, s)
|
||||
else
|
||||
draw_line(self, _, cr, width, height)
|
||||
end
|
||||
end
|
||||
|
||||
local function fit(_, _, width, height)
|
||||
return width, height
|
||||
end
|
||||
|
||||
for _, prop in ipairs {"orientation", "color", "thickness", "span_ratio",
|
||||
"border_width", "border_color", "shape" } do
|
||||
separator["set_"..prop] = function(self, value)
|
||||
self._private[prop] = value
|
||||
self:emit_signal("property::"..prop)
|
||||
self:emit_signal("widget::redraw_needed")
|
||||
end
|
||||
separator["get_"..prop] = function(self)
|
||||
return self._private[prop] or beautiful["separator_"..prop]
|
||||
end
|
||||
end
|
||||
|
||||
local function new(args)
|
||||
local ret = base.make_widget(nil, nil, {
|
||||
enable_properties = true,
|
||||
})
|
||||
gtable.crush(ret, separator, true)
|
||||
gtable.crush(ret, args or {})
|
||||
ret._private.orientation = ret._private.orientation or "auto"
|
||||
rawset(ret, "fit" , fit )
|
||||
rawset(ret, "draw", draw)
|
||||
return ret
|
||||
end
|
||||
|
||||
--@DOC_widget_COMMON@
|
||||
|
||||
--@DOC_object_COMMON@
|
||||
|
||||
return setmetatable(separator, { __call = function(_, ...) return new(...) end })
|
||||
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
local parent = ... --DOC_HIDE
|
||||
local wibox = require( "wibox" ) --DOC_HIDE
|
||||
|
||||
parent:add( --DOC_HIDE
|
||||
|
||||
wibox.widget {
|
||||
forced_height = 20, --DOC_HIDE
|
||||
forced_width = 100, --DOC_HIDE
|
||||
widget = wibox.widget.separator
|
||||
}
|
||||
|
||||
) --DOC_HIDE
|
||||
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
local parent = ... --DOC_HIDE
|
||||
local wibox = require("wibox") --DOC_HIDE
|
||||
local gears = {shape = require("gears.shape")}--DOC_HIDE
|
||||
local beautiful = require("beautiful")--DOC_HIDE
|
||||
|
||||
parent:add( --DOC_HIDE
|
||||
wibox.widget {
|
||||
shape = gears.shape.circle,
|
||||
color = "#00000000",
|
||||
border_width = 1,
|
||||
border_color = beautiful.bg_normal,
|
||||
widget = wibox.widget.separator,
|
||||
forced_height = 20, --DOC_HIDE
|
||||
forced_width = 20, --DOC_HIDE
|
||||
}
|
||||
) --DOC_HIDE
|
||||
|
||||
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
local parent = ... --DOC_HIDE_ALL
|
||||
local wibox = require("wibox")
|
||||
|
||||
parent:add(
|
||||
wibox.widget {
|
||||
{
|
||||
{
|
||||
markup = "<b>orientation</b> = <i>horizontal</i>",
|
||||
widget = wibox.widget.textbox
|
||||
},
|
||||
{
|
||||
orientation = "horizontal",
|
||||
widget = wibox.widget.separator,
|
||||
},
|
||||
forced_width = 200,
|
||||
layout = wibox.layout.fixed.vertical
|
||||
},
|
||||
{
|
||||
{
|
||||
markup = "<b>orientation</b> = <i>vertical</i>",
|
||||
widget = wibox.widget.textbox
|
||||
},
|
||||
{
|
||||
orientation = "vertical",
|
||||
widget = wibox.widget.separator,
|
||||
},
|
||||
forced_width = 200,
|
||||
layout = wibox.layout.fixed.vertical
|
||||
},
|
||||
forced_height = 30,
|
||||
forced_width = 400,
|
||||
layout = wibox.layout.fixed.horizontal
|
||||
}
|
||||
)
|
||||
|
||||
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
local parent = ... --DOC_HIDE
|
||||
local wibox = require("wibox") --DOC_HIDE
|
||||
local gears = {shape = require("gears.shape")}--DOC_HIDE
|
||||
|
||||
local wdgs = { --DOC_HIDE
|
||||
forced_height = 30, --DOC_HIDE
|
||||
forced_width = 30*4, --DOC_HIDE
|
||||
spacing = 5, --DOC_HIDE
|
||||
layout = wibox.layout.flex.horizontal --DOC_HIDE
|
||||
} --DOC_HIDE
|
||||
|
||||
|
||||
for _, s in ipairs { "losange" ,"circle", "isosceles_triangle", "cross" } do
|
||||
local w = wibox.widget {
|
||||
shape = gears.shape[s],
|
||||
widget = wibox.widget.separator,
|
||||
}
|
||||
table.insert(wdgs, w) --DOC_HIDE
|
||||
end
|
||||
|
||||
parent:add( wibox.layout(wdgs)) --DOC_HIDE
|
||||
|
||||
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|
||||
Loading…
Reference in New Issue