Module: wibox.widget.progressbar

A progressbar widget.

To add text on top of the progressbar, a wibox.layout.stack can be used:

Usage example

wibox.widget {
    {
        max_value     = 1,
        value         = 0.5,
        forced_height = 20,
        forced_width  = 100,
        paddings      = 1,
        border_width  = 1,
        border_color  = beautiful.border_color,
        widget        = wibox.widget.progressbar,
    },
    {
        text   = '50%',
        widget = wibox.widget.textbox,
    },
    layout = wibox.layout.stack
}

To display the progressbar vertically, use a wibox.container.rotate widget:

Usage example

wibox.widget {
    {
        max_value     = 1,
        value         = 0.33,
        widget        = wibox.widget.progressbar,
    },
    forced_height = 100,
    forced_width  = 20,
    direction     = 'east',
    layout        = wibox.container.rotate,
}

By default, this widget will take all the available size. To prevent this, a wibox.container.constraint widget or the forced_width/forced_height properties have to be used.

Usage example

Usage:

    wibox.widget {
        max_value     = 1,
        value         = 0.33,
        forced_height = 20,
        forced_width  = 100,
        shape         = gears.shape.rounded_bar,
        border_width  = 2,
        border_color  = beautiful.border_color,
        widget        = wibox.widget.progressbar,
    }
    

Info:

Constructors

wibox.widget.progressbar {[args]} Create a progressbar widget.

Functions

wibox.widget.progressbar.add_button (button) Add a new awful.button to this widget.

Object properties

border_color gears.color The progressbar border color.
border_width number The progressbar border width.
bar_border_color gears.color The progressbar inner border color.
bar_border_width number The progressbar inner border width.
color gears.color The progressbar foreground color.
background_color gears.color The progressbar background color.
bar_shape gears.shape The progressbar inner shape.
shape gears.shape The progressbar shape.
clip boolean Force the inner part (the bar) to fit in the background shape.
ticks boolean The progressbar to draw ticks.
ticks_gap number The progressbar ticks gap.
ticks_size number The progressbar ticks size.
max_value number The maximum value the progressbar should handle.
margins (table or number or nil) The progressbar margins.
paddings (table or number or nil) The progressbar padding.
value number Set the progressbar value.
children table Get or set the children elements.
all_children table Get all direct and indirect children widgets.
forced_height number or nil Force a widget height.
forced_width number or nil Force a widget width.
opacity number The widget opacity (transparency).
visible boolean The widget visibility.
buttons table The widget buttons.

Object methods

:setup {[args]} Set a declarative widget hierarchy description.
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
:emit_signal (name, ...) Emit a signal.
:connect_signal (name, func) Connect to a signal.
:weak_connect_signal (name, func) Connect to a signal weakly.

Signals

widget::layout_changed When the layout (size) change.
widget::redraw_needed When the widget content changed.
button::press When a mouse button is pressed over the widget.
button::release When a mouse button is released over the widget.
mouse::enter When the mouse enter a widget.
mouse::leave When the mouse leave a widget.

Theme variables

beautiful.progressbar_bg color The progressbar background color.
beautiful.progressbar_fg color The progressbar foreground color.
beautiful.progressbar_shape gears.shape The progressbar shape.
beautiful.progressbar_border_color color The progressbar border color.
beautiful.progressbar_border_width number The progressbar outer border width.
beautiful.progressbar_bar_shape gears.shape The progressbar inner shape.
beautiful.progressbar_bar_border_width number The progressbar bar border width.
beautiful.progressbar_bar_border_color color The progressbar bar border color.
beautiful.progressbar_margins (table or number or nil) The progressbar margins.
beautiful.progressbar_paddings (table or number or nil) The progressbar padding.

Deprecated functions

wibox.widget.progressbar.set_vertical [deprecated] Set the progressbar to draw vertically.
wibox.widget.progressbar.set_height [deprecated] Set the progressbar height.
wibox.widget.progressbar.set_width [deprecated] Set the progressbar width.


Constructors

wibox.widget.progressbar {[args]}
Create a progressbar widget.

Parameters:

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

Returns:

    A progressbar widget.

Functions

wibox.widget.progressbar.add_button (button)
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.

Object properties

border_color (gears.color)
The progressbar border color. If the value is nil, no border will be drawn.

Type constraints:

  • color gears.color The border color to set.

See also:

border_width (number)
The progressbar border width.
bar_border_color (gears.color)
The progressbar inner border color. If the value is nil, no border will be drawn.

Type constraints:

  • color gears.color The border color to set.

See also:

bar_border_width (number)
The progressbar inner border width.
color (gears.color)
The progressbar foreground color.

Type constraints:

  • color gears.color The progressbar color.

See also:

background_color (gears.color)
The progressbar background color.

Type constraints:

  • color gears.color The progressbar background color.

See also:

bar_shape (gears.shape)
The progressbar inner shape.

Usage example

See also:

Usage:

    for _, shape in ipairs {'rounded_bar', 'octogon', 'hexagon', 'powerline' } do
        l:add(wibox.widget {
              value            = 0.33,
              bar_shape        = gears.shape[shape],
              bar_border_color = beautiful.border_color,
              bar_border_width = 1,
              border_width     = 2,
              border_color     = beautiful.border_color,
              paddings         = 1,
              widget           = wibox.widget.progressbar,
          })
    end
shape (gears.shape)
The progressbar shape.

Usage example

See also:

Usage:

    for _, shape in ipairs {'rounded_bar', 'octogon', 'hexagon', 'powerline' } do
        l:add(wibox.widget {
              value         = 0.33,
              shape         = gears.shape[shape],
              border_width  = 2,
              border_color  = beautiful.border_color,
              widget        = wibox.widget.progressbar,
          })
    end
clip (boolean)
Force the inner part (the bar) to fit in the background shape.

Usage example

Usage:

    wibox.widget {
        value            = 75,
        max_value        = 100,
        border_width     = 2,
        border_color     = beautiful.border_color,
        color            = beautiful.border_color,
        shape            = gears.shape.rounded_bar,
        bar_shape        = gears.shape.rounded_bar,
        clip             = false,
        forced_height    = 30,
        forced_width     = 100,
        paddings         = 5,
        margins          = {
            top    = 12,
            bottom = 12,
        },
        widget = wibox.widget.progressbar,
    }
ticks (boolean)
The progressbar to draw ticks. Default is false.
ticks_gap (number)
The progressbar ticks gap.
ticks_size (number)
The progressbar ticks size.
max_value (number)
The maximum value the progressbar should handle.
margins ((table or number or nil))
The progressbar margins. Note that if the clip is disabled, this allows the background to be smaller than the bar.

See the clip example.

Type constraints:

  • margins A table for each side or a number
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)

See also:

paddings ((table or number or nil))
The progressbar padding. Note that if the clip is disabled, this allows the bar to be taller than the background.

See the clip example.

Type constraints:

  • padding A table for each side or a number
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)

See also:

value (number)
Set the progressbar value.

Type constraints:

  • number The progress bar value between 0 and 1.
children (table)
Get or set the children elements.

Type constraints:

all_children (table)
Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow id the widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

forced_height (number or nil)
Force a widget height.

Type constraints:

  • height number or nil The height (nil for automatic)
forced_width (number or nil)
Force a widget width.

Type constraints:

  • width number or nil The width (nil for automatic)
opacity (number)
The widget opacity (transparency).

Type constraints:

  • opacity number The opacity (between 0 and 1) (default 1)
visible (boolean)
The widget visibility.
buttons (table)
The widget buttons.

The table contains a list of awful.button objects.

See also:

Object methods

:setup {[args]}
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
:emit_signal_recursive (signal_name, ...)
Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. This is useful to track signals when there is a dynamic set of containers and layouts wrapping the widget.

Parameters:

  • signal_name string
  • ... Other arguments
:emit_signal (name, ...)
Emit a signal.

Parameters:

  • name string The name of the signal.
  • ... Extra arguments for the callback functions. Each connected function receives the object as first argument and then any extra arguments that are given to emit_signal().
:connect_signal (name, func)
Connect to a signal.

Parameters:

  • name string The name of the signal.
  • func function The callback to call when the signal is emitted.
:weak_connect_signal (name, func)
Connect to a signal weakly.

This allows the callback function to be garbage collected and automatically disconnects the signal when that happens.

Warning: Only use this function if you really, really, really know what you are doing.

Parameters:

  • name string The name of the signal.
  • func function The callback to call when the signal is emitted.

Signals

widget::layout_changed
When the layout (size) change. This signal is emitted when the previous results of :layout() and :fit() are no longer valid. Unless this signal is emitted, :layout() and :fit() must return the same result when called with the same arguments.

See also:

widget::redraw_needed
When the widget content changed. This signal is emitted when the content of the widget changes. The widget will be redrawn, it is not re-layouted. Put differently, it is assumed that :layout() and :fit() would still return the same results as before.

See also:

button::press
When a mouse button is pressed over the widget.

Arguments:

  • lx number The horizontal position relative to the (0,0) position in the widget.
  • ly number The vertical position relative to the (0,0) position in the widget.
  • button number The button number.
  • mods table The modifiers (mod4, mod1 (alt), Control, Shift)
  • find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
    • drawable wibox.drawable The drawable containing the widget.
    • widget widget The widget being displayed.
    • hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
    • x number An approximation of the X position that the widget is visible at on the surface.
    • y number An approximation of the Y position that the widget is visible at on the surface.
    • width number An approximation of the width that the widget is visible at on the surface.
    • height number An approximation of the height that the widget is visible at on the surface.
    • widget_width number The exact width of the widget in its local coordinate system.
    • widget_height number The exact height of the widget in its local coordinate system.

See also:

button::release
When a mouse button is released over the widget.

Arguments:

  • lx number The horizontal position relative to the (0,0) position in the widget.
  • ly number The vertical position relative to the (0,0) position in the widget.
  • button number The button number.
  • mods table The modifiers (mod4, mod1 (alt), Control, Shift)
  • find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
    • drawable wibox.drawable The drawable containing the widget.
    • widget widget The widget being displayed.
    • hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
    • x number An approximation of the X position that the widget is visible at on the surface.
    • y number An approximation of the Y position that the widget is visible at on the surface.
    • width number An approximation of the width that the widget is visible at on the surface.
    • height number An approximation of the height that the widget is visible at on the surface.
    • widget_width number The exact width of the widget in its local coordinate system.
    • widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse::enter
When the mouse enter a widget.

Arguments:

  • find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
    • drawable wibox.drawable The drawable containing the widget.
    • widget widget The widget being displayed.
    • hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
    • x number An approximation of the X position that the widget is visible at on the surface.
    • y number An approximation of the Y position that the widget is visible at on the surface.
    • width number An approximation of the width that the widget is visible at on the surface.
    • height number An approximation of the height that the widget is visible at on the surface.
    • widget_width number The exact width of the widget in its local coordinate system.
    • widget_height number The exact height of the widget in its local coordinate system.

See also:

mouse::leave
When the mouse leave a widget.

Arguments:

  • find_widgets_result The entry from the result of wibox.drawable:find_widgets for the position that the mouse hit.
    • drawable wibox.drawable The drawable containing the widget.
    • widget widget The widget being displayed.
    • hierarchy wibox.hierarchy The hierarchy managing the widget’s geometry.
    • x number An approximation of the X position that the widget is visible at on the surface.
    • y number An approximation of the Y position that the widget is visible at on the surface.
    • width number An approximation of the width that the widget is visible at on the surface.
    • height number An approximation of the height that the widget is visible at on the surface.
    • widget_width number The exact width of the widget in its local coordinate system.
    • widget_height number The exact height of the widget in its local coordinate system.

See also:

Theme variables

beautiful.progressbar_bg (color)
The progressbar background color.
beautiful.progressbar_fg (color)
The progressbar foreground color.
beautiful.progressbar_shape (gears.shape)
The progressbar shape.

See also:

beautiful.progressbar_border_color (color)
The progressbar border color.
beautiful.progressbar_border_width (number)
The progressbar outer border width.
beautiful.progressbar_bar_shape (gears.shape)
The progressbar inner shape.

See also:

beautiful.progressbar_bar_border_width (number)
The progressbar bar border width.
beautiful.progressbar_bar_border_color (color)
The progressbar bar border color.
beautiful.progressbar_margins ((table or number or nil))
The progressbar margins. Note that if the clip is disabled, this allows the background to be smaller than the bar.

Type constraints:

  • margins A table for each side or a number
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)

See also:

beautiful.progressbar_paddings ((table or number or nil))
The progressbar padding. Note that if the clip is disabled, this allows the bar to be taller than the background.

Type constraints:

  • padding A table for each side or a number
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)

See also:

Deprecated functions

wibox.widget.progressbar.set_vertical [deprecated]
Set the progressbar to draw vertically. This doesn’t do anything anymore, use a wibox.container.rotate widget.

Parameters:

  • vertical boolean
wibox.widget.progressbar.set_height [deprecated]
Set the progressbar height. This method is deprecated. Use a wibox.container.constraint widget or forced_height.

Parameters:

  • height The height to set.
wibox.widget.progressbar.set_width [deprecated]
Set the progressbar width. This method is deprecated. Use a wibox.container.constraint widget or forced_width.

Parameters:

  • width The width to set.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00