awful.widget.progressbar: import

Signed-off-by: Julien Danjou <julien@danjou.info>

lib/awful/widget/init.lua.in

@@ -9,6 +9,7 @@ require("awful.widget.tasklist")
 require("awful.widget.button")
 require("awful.widget.launcher")
 require("awful.widget.prompt")
+require("awful.widget.progressbar")
 
 --- Widget module for awful
 module("awful.widget")

lib/awful/widget/progressbar.lua.in

@@ -0,0 +1,179 @@
+---------------------------------------------------------------------------
+-- @author Julien Danjou <julien@danjou.info>
+-- @copyright 2009 Julien Danjou
+-- @release @AWESOME_VERSION@
+---------------------------------------------------------------------------
+
+local setmetatable = setmetatable
+local ipairs = ipairs
+local math = math
+local capi = { image = image,
+               widget = widget }
+
+--- A progressbar widget.
+module("awful.widget.progressbar")
+
+local data = setmetatable({}, { __mode = "k" })
+
+--- Set the progressbar border color.
+-- If the value is nil, no border will be drawn.
+-- @name set_border_color
+-- @class function
+-- @param progressbar The progressbar.
+-- @param color The border color to set.
+
+--- Set the progressbar foreground color as a gradient.
+-- @name set_gradient_colors
+-- @class function
+-- @param progressbar The progressbar.
+-- @param gradient_colors A table with gradients colors. The distance between each color
+-- can also be specified. Example: { "red", "blue" } or { "red", "green",
+-- "blue", blue = 10 } to specify blue distance from other colors.
+
+--- Set the progressbar foreground color.
+-- @name set_color
+-- @class function
+-- @param progressbar The progressbar.
+-- @param color The progressbar color.
+
+--- Set the progressbar background color.
+-- @name set_background_color
+-- @class function
+-- @param progressbar The progressbar.
+-- @param color The progressbar background color.
+
+--- Set the progressbar to draw vertically. Default is false.
+-- @name set_vertical
+-- @class function
+-- @param progressbar The progressbar.
+-- @param vertical A boolean value.
+
+local properties = { "width", "height", "border_color",
+                     "gradient_colors", "color", "background_color",
+                     "vertical", "value" }
+
+local function update(pbar)
+    local width = data[pbar].width or 100
+    local height  = data[pbar].height or 20
+
+    if data[pbar].width < 5 or data[pbar].height < 2 then return end
+
+    -- Create new empty image
+    local img = capi.image.argb32(width, height, nil)
+
+    local over_drawn_width = width
+    local over_drawn_height = height
+    local border_width = 0
+    if data[pbar].border_color then
+        -- Draw border
+        img:draw_rectangle(0, 0, width, height, false, data[pbar].border_color)
+        over_drawn_width = width - 2 -- remove 2 for borders
+        over_drawn_height = height - 2 -- remove 2 for borders
+        border_width = 1
+    end
+
+    local angle = 270
+    if data[pbar].vertical then
+        angle = 0
+    end
+
+    -- Draw full gradient
+    if data[pbar].gradient_colors then
+        img:draw_rectangle_gradient(border_width, border_width,
+                                    over_drawn_width, over_drawn_height,
+                                    data[pbar].gradient_colors, angle)
+    else
+        img:draw_rectangle(border_width, border_width,
+                           over_drawn_width, over_drawn_height,
+                           true, data[pbar].color or "red")
+    end
+
+    -- Cover the part that is not set with a rectangle
+    if data[pbar].vertical then
+        local rel_height = math.floor(over_drawn_height * (1 - data[pbar].value))
+        img:draw_rectangle(border_width,
+                           border_width,
+                           over_drawn_width,
+                           rel_height,
+                           true, data[pbar].background_color or "#000000aa")
+    else
+        local rel_x = math.floor(over_drawn_width * data[pbar].value)
+        img:draw_rectangle(border_width + rel_x,
+                           border_width,
+                           over_drawn_width - rel_x,
+                           over_drawn_height,
+                           true, data[pbar].background_color or "#000000aa")
+    end
+
+    -- Update the image
+    pbar.widget.image = img
+end
+
+-- Set the progressbar value.
+-- @param pbar The progress bar.
+-- @param value The progress bar value between 0 and 1.
+local function set_value(pbar, value)
+    local value = value or 0
+    data[pbar].value = math.min(1, math.max(0, value))
+end
+
+--- Set the progressbar height.
+-- @param progressbar The progressbar.
+-- @param height The height to set.
+local function set_height(progressbar, height)
+    if height >= 5 then
+        data[progressbar].height = height
+        update(progressbar)
+    end
+end
+
+--- Set the progressbar width.
+-- @param progressbar The progressbar.
+-- @param width The width to set.
+local function set_width(progressbar, width)
+    if width >= 5 then
+        data[progressbar].width = width
+        update(progressbar)
+    end
+end
+
+-- Build properties function
+for _, prop in ipairs(properties) do
+    if not _M["set_" .. prop] then
+        _M["set_" .. prop] = function(pbar, value)
+            data[pbar][prop] = value
+            update(pbar)
+        end
+    end
+end
+
+--- Create a progressbar widget.
+-- @param args Standard widget() arguments. You should add width and height
+-- key to set progressbar geometry.
+-- @return A progressbar widget.
+function new(args)
+    local args = args or {}
+    local width = args.width or 100
+    local height = args.height or 20
+
+    if width < 5 or height < 5 then return end
+
+    args.type = "imagebox"
+
+    local pbar = {}
+
+    pbar.widget = capi.widget(args)
+
+    data[pbar] = { width = width, height = height, value = 0 }
+
+    -- Set methods
+    for _, prop in ipairs(properties) do
+        pbar["set_" .. prop] = _M["set_" .. prop]
+    end
+
+    return pbar
+end
+
+setmetatable(_M, { __call = function(_, ...) return new(...) end })
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80