Reference

# Module `awful.widget.progressbar`

A progressbar widget.

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2009 Julien Danjou

Release: v3.4.11

## Functions

new (args) | Create a progressbar widget.
set_background_color (progressbar, color) | Set the progressbar background color.
set_border_color (progressbar, color) | Set the progressbar border color.
set_color (progressbar, color) | Set the progressbar foreground color.
set_gradient_colors (progressbar, gradient_colors) | Set the progressbar foreground color as a gradient.
set_height (progressbar, height) | Set the progressbar height.
set_max_value (progressbar, value) | Set the maximum value the progressbar should handle.
set_ticks (progressbar, ticks) | Set the progressbar to draw ticks.
set_ticks_gap (progressbar, value) | Set the progressbar ticks gap.
set_ticks_size (progressbar, value) | Set the progressbar ticks size.
set_value (pbar, value) | Set the progressbar value.
set_vertical (progressbar, vertical) | Set the progressbar to draw vertically.
set_width (progressbar, width) | Set the progressbar width.

## Functions

new (args)
  Create a progressbar widget.

  ### Parameters

  - args: Standard widget() arguments. You should add width and height key to set progressbar geometry.

  ### Return value:

  A progressbar widget.
set_background_color (progressbar, color)
  Set the progressbar background color.

  ### Parameters

  - progressbar: The progressbar.
  - color: The progressbar background color.
set_border_color (progressbar, color)
  Set the progressbar border color. If the value is nil, no border will be drawn.

  ### Parameters

  - progressbar: The progressbar.
  - color: The border color to set.
set_color (progressbar, color)
  Set the progressbar foreground color.

  ### Parameters

  - progressbar: The progressbar.
  - color: The progressbar color.
set_gradient_colors (progressbar, gradient_colors)
  Set the progressbar foreground color as a gradient.

  ### Parameters

  - progressbar: The progressbar.
  - 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_height (progressbar, height)
  Set the progressbar height.

  ### Parameters

  - progressbar: The progressbar.
  - height: The height to set.
set_max_value (progressbar, value)
  Set the maximum value the progressbar should handle.

  ### Parameters

  - progressbar: The progressbar.
  - value: The value.
set_ticks (progressbar, ticks)
  Set the progressbar to draw ticks. Default is false.

  ### Parameters

  - progressbar: The progressbar.
  - ticks: A boolean value.
set_ticks_gap (progressbar, value)
  Set the progressbar ticks gap.

  ### Parameters

  - progressbar: The progressbar.
  - value: The value.
set_ticks_size (progressbar, value)
  Set the progressbar ticks size.

  ### Parameters

  - progressbar: The progressbar.
  - value: The value.
set_value (pbar, value)
  Set the progressbar value.

  ### Parameters

  - pbar: The progress bar.
  - value: The progress bar value between 0 and 1.
set_vertical (progressbar, vertical)
  Set the progressbar to draw vertically. Default is false.

  ### Parameters

  - progressbar: The progressbar.
  - vertical: A boolean value.
set_width (progressbar, width)
  Set the progressbar width.

  ### Parameters

  - progressbar: The progressbar.
  - width: The width to set.