lib/awful/widget/progressbar.lua.in

   1 ---------------------------------------------------------------------------
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2009 Julien Danjou
   4 -- @release @AWESOME_VERSION@
   5 ---------------------------------------------------------------------------
   6
   7 local setmetatable = setmetatable
   8 local ipairs = ipairs
   9 local math = math
  10 local base = require("wibox.widget.base")
  11 local color = require("gears.color")
  12
  13 --- A progressbar widget.
  14 -- awful.widget.progressbar
  15 local progressbar = { mt = {} }
  16
  17 local data = setmetatable({}, { __mode = "k" })
  18
  19 --- Set the progressbar border color.
  20 -- If the value is nil, no border will be drawn.
  21 -- @name set_border_color
  22 -- @class function
  23 -- @param progressbar The progressbar.
  24 -- @param color The border color to set.
  25
  26 --- Set the progressbar foreground color.
  27 -- @name set_color
  28 -- @class function
  29 -- @param progressbar The progressbar.
  30 -- @param color The progressbar color.
  31
  32 --- Set the progressbar background color.
  33 -- @name set_background_color
  34 -- @class function
  35 -- @param progressbar The progressbar.
  36 -- @param color The progressbar background color.
  37
  38 --- Set the progressbar to draw vertically. Default is false.
  39 -- @name set_vertical
  40 -- @class function
  41 -- @param progressbar The progressbar.
  42 -- @param vertical A boolean value.
  43
  44 --- Set the progressbar to draw ticks. Default is false.
  45 -- @name set_ticks
  46 -- @class function
  47 -- @param progressbar The progressbar.
  48 -- @param ticks A boolean value.
  49
  50 --- Set the progressbar ticks gap.
  51 -- @name set_ticks_gap
  52 -- @class function
  53 -- @param progressbar The progressbar.
  54 -- @param value The value.
  55
  56 --- Set the progressbar ticks size.
  57 -- @name set_ticks_size
  58 -- @class function
  59 -- @param progressbar The progressbar.
  60 -- @param value The value.
  61
  62 --- Set the maximum value the progressbar should handle.
  63 -- @name set_max_value
  64 -- @class function
  65 -- @param progressbar The progressbar.
  66 -- @param value The value.
  67
  68 local properties = { "width", "height", "border_color",
  69                      "color", "background_color",
  70                      "vertical", "value", "max_value",
  71                      "ticks", "ticks_gap", "ticks_size" }
  72
  73 function progressbar.draw(pbar, wibox, cr, width, height)
  74     local ticks_gap = data[pbar].ticks_gap or 1
  75     local ticks_size = data[pbar].ticks_size or 4
  76
  77     -- We want one pixel wide lines
  78     cr:set_line_width(1)
  79
  80     local value = data[pbar].value
  81     local max_value = data[pbar].max_value
  82     if value >= 0 then
  83         value = value / max_value
  84     end
  85
  86     local over_drawn_width = width
  87     local over_drawn_height = height
  88     local border_width = 0
  89     if data[pbar].border_color then
  90         -- Draw border
  91         cr:rectangle(0.5, 0.5, width - 1, height - 1)
  92         cr:set_source(color(data[pbar].border_color))
  93         cr:stroke()
  94
  95         over_drawn_width = width - 2 -- remove 2 for borders
  96         over_drawn_height = height - 2 -- remove 2 for borders
  97         border_width = 1
  98     end
  99
 100     cr:rectangle(border_width, border_width,
 101                  over_drawn_width, over_drawn_height)
 102     cr:set_source(color(data[pbar].color or "#ff0000"))
 103     cr:fill()
 104
 105     -- Cover the part that is not set with a rectangle
 106     if data[pbar].vertical then
 107         local rel_height = over_drawn_height * (1 - value)
 108         cr:rectangle(border_width,
 109                      border_width,
 110                      over_drawn_width,
 111                      rel_height)
 112         cr:set_source(color(data[pbar].background_color or "#000000aa"))
 113         cr:fill()
 114
 115         -- Place smaller pieces over the gradient if ticks are enabled
 116         if data[pbar].ticks then
 117             for i=0, height / (ticks_size+ticks_gap)-border_width do
 118                 local rel_offset = over_drawn_height / 1 - (ticks_size+ticks_gap) * i
 119
 120                 if rel_offset >= rel_height then
 121                     cr:rectangle(border_width,
 122                                  rel_offset,
 123                                  over_drawn_width,
 124                                  ticks_gap)
 125                 end
 126             end
 127             cr:set_source(color(data[pbar].background_color or "#000000aa"))
 128             cr:fill()
 129         end
 130     else
 131         local rel_x = over_drawn_width * value
 132         cr:rectangle(border_width + rel_x,
 133                      border_width,
 134                      over_drawn_width - rel_x,
 135                      over_drawn_height)
 136         cr:set_source(color(data[pbar].background_color or "#000000aa"))
 137         cr:fill()
 138
 139         if data[pbar].ticks then
 140             for i=0, width / (ticks_size+ticks_gap)-border_width do
 141                 local rel_offset = over_drawn_width / 1 - (ticks_size+ticks_gap) * i
 142
 143                 if rel_offset <= rel_x then
 144                     cr:rectangle(rel_offset,
 145                                  border_width,
 146                                  ticks_gap,
 147                                  over_drawn_height)
 148                 end
 149             end
 150             cr:set_source(color(data[pbar].background_color or "#000000aa"))
 151             cr:fill()
 152         end
 153     end
 154 end
 155
 156 function progressbar.fit(pbar, width, height)
 157     return data[pbar].width, data[pbar].height
 158 end
 159
 160 --- Set the progressbar value.
 161 -- @param value The progress bar value between 0 and 1.
 162 function progressbar:set_value(value)
 163     local value = value or 0
 164     local max_value = data[self].max_value
 165     data[self].value = math.min(max_value, math.max(0, value))
 166     self:emit_signal("widget::updated")
 167     return self
 168 end
 169
 170 --- Set the progressbar height.
 171 -- @param height The height to set.
 172 function progressbar:set_height(height)
 173     data[self].height = height
 174     self:emit_signal("widget::updated")
 175     return self
 176 end
 177
 178 --- Set the progressbar width.
 179 -- @param width The width to set.
 180 function progressbar:set_width(width)
 181     data[self].width = width
 182     self:emit_signal("widget::updated")
 183     return self
 184 end
 185
 186 -- Build properties function
 187 for _, prop in ipairs(properties) do
 188     if not progressbar["set_" .. prop] then
 189         progressbar["set_" .. prop] = function(pbar, value)
 190             data[pbar][prop] = value
 191             pbar:emit_signal("widget::updated")
 192             return pbar
 193         end
 194     end
 195 end
 196
 197 --- Create a progressbar widget.
 198 -- @param args Standard widget() arguments. You should add width and height
 199 -- key to set progressbar geometry.
 200 -- @return A progressbar widget.
 201 function progressbar.new(args)
 202     local args = args or {}
 203     local width = args.width or 100
 204     local height = args.height or 20
 205
 206     args.type = "imagebox"
 207
 208     local pbar = base.make_widget()
 209
 210     data[pbar] = { width = width, height = height, value = 0, max_value = 1 }
 211
 212     -- Set methods
 213     for _, prop in ipairs(properties) do
 214         pbar["set_" .. prop] = progressbar["set_" .. prop]
 215     end
 216
 217     pbar.draw = progressbar.draw
 218     pbar.fit = progressbar.fit
 219
 220     return pbar
 221 end
 222
 223 function progressbar.mt:__call(...)
 224     return progressbar.new(...)
 225 end
 226
 227 return setmetatable(progressbar, progressbar.mt)
 228
 229 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80