Class wibox.widget.progressbar

A progressbar widget.

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

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:

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:

    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:

  • Copyright: 2009 Julien Danjou
  • Author: Julien Danjou <julien@danjou.info>

Functions

progressbar:set_value (value) Set the progressbar value.
wibox.widget.progressbar (args) Create a progressbar widget.

Object properties

wibox.widget.progressbar.border_color The progressbar border color.
wibox.widget.progressbar.border_width The progressbar border width.
wibox.widget.progressbar.bar_border_color The progressbar inner border color.
wibox.widget.progressbar.bar_border_width The progressbar inner border width.
wibox.widget.progressbar.color The progressbar foreground color.
wibox.widget.progressbar.background_color The progressbar background color.
wibox.widget.progressbar.bar_shape The progressbar inner shape.
wibox.widget.progressbar.shape The progressbar shape.
wibox.widget.progressbar.clip Force the inner part (the bar) to fit in the background shape.
wibox.widget.progressbar.ticks The progressbar to draw ticks.
wibox.widget.progressbar.ticks_gap The progressbar ticks gap.
wibox.widget.progressbar.ticks_size The progressbar ticks size.
wibox.widget.progressbar.max_value The maximum value the progressbar should handle.
wibox.widget.progressbar.margins The progressbar margins.
wibox.widget.progressbar.paddings The progressbar padding.

Theme variables

beautiful.progressbar_bg The progressbar background color.
beautiful.progressbar_fg The progressbar foreground color.
beautiful.progressbar_shape The progressbar shape.
beautiful.progressbar_border_color The progressbar border color.
beautiful.progressbar_border_width The progressbar outer border width.
beautiful.progressbar_bar_shape The progressbar inner shape.
beautiful.progressbar_bar_border_width The progressbar bar border width.
beautiful.progressbar_bar_border_color The progressbar bar border color.
beautiful.progressbar_margins The progressbar margins.
beautiful.progressbar_paddings The progressbar padding.

Deprecated functions

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


Functions

progressbar:set_value (value)
Set the progressbar value.
  • value The progress bar value between 0 and 1.
wibox.widget.progressbar (args)
Create a progressbar widget.
  • args Standard widget() arguments. You should add width and height key to set progressbar geometry.

Returns:

    A progressbar widget.

Object properties

wibox.widget.progressbar.border_color
The progressbar border color. If the value is nil, no border will be drawn.

Type:

  • color gears.color The border color to set.

See also:

wibox.widget.progressbar.border_width
The progressbar border width.
wibox.widget.progressbar.bar_border_color
The progressbar inner border color. If the value is nil, no border will be drawn.

Type:

  • color gears.color The border color to set.

See also:

wibox.widget.progressbar.bar_border_width
The progressbar inner border width.
wibox.widget.progressbar.color
The progressbar foreground color.

Type:

  • color gears.color The progressbar color.

See also:

wibox.widget.progressbar.background_color
The progressbar background color.

Type:

  • color gears.color The progressbar background color.

See also:

wibox.widget.progressbar.bar_shape
The progressbar inner shape.

Type:

  • shape gears.shape (default gears.shape.rectangle)

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
wibox.widget.progressbar.shape
The progressbar shape.

Type:

  • shape gears.shape (default gears.shape.rectangle)

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
wibox.widget.progressbar.clip
Force the inner part (the bar) to fit in the background shape.

Type:

  • clip boolean (default true)

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,
    }
wibox.widget.progressbar.ticks
The progressbar to draw ticks. Default is false.

Type:

  • boolean
wibox.widget.progressbar.ticks_gap
The progressbar ticks gap.

Type:

  • number
wibox.widget.progressbar.ticks_size
The progressbar ticks size.

Type:

  • number
wibox.widget.progressbar.max_value
The maximum value the progressbar should handle.

Type:

  • number
wibox.widget.progressbar.margins
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:

  • 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:

wibox.widget.progressbar.paddings
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:

  • 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:

Theme variables

beautiful.progressbar_bg
The progressbar background color.
beautiful.progressbar_fg
The progressbar foreground color.
beautiful.progressbar_shape
The progressbar shape.

See also:

beautiful.progressbar_border_color
The progressbar border color.
beautiful.progressbar_border_width
The progressbar outer border width.
beautiful.progressbar_bar_shape
The progressbar inner shape.

See also:

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

Type:

  • 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
The progressbar padding. Note that if the clip is disabled, this allows the bar to be taller than the background.

Type:

  • 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
Set the progressbar to draw vertically. This doesn't do anything anymore, use a wibox.container.rotate widget.

param:

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

param:

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

param:

  • width The width to set.
generated by LDoc 1.4.2