Class wibox.container.radialprogressbar

A circular progressbar wrapper.

If no child widget is set, then the radialprogressbar will take all the available size. Use a wibox.container.constraint to prevent this.

Info:

  • Copyright: 2013 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee <elv1313@gmail.com>

Functions

radialprogressbar:get_children () Get the children elements
radialprogressbar:set_children (children) Replace the layout children This layout only accept one children, all others will be ignored
radialprogressbar:reset () Reset this container.
wibox.container.radialprogressbar ([widget]) Returns a new radialprogressbar layout.

Object properties

wibox.container.radialprogressbar.widget The widget to wrap in a radial proggressbar.
wibox.container.radialprogressbar.paddings The padding between the outline and the progressbar.
wibox.container.radialprogressbar.value The progressbar value.
wibox.container.radialprogressbar.border_color The border background color.
wibox.container.radialprogressbar.color The border foreground color.
wibox.container.radialprogressbar.border_width The border width.
wibox.container.radialprogressbar.min_value The minimum value.
wibox.container.radialprogressbar.max_value The maximum value.

Theme variables

beautiful.radialprogressbar_border_color The progressbar border background color.
beautiful.radialprogressbar_color The progressbar foreground color.
beautiful.radialprogressbar_border_width The progressbar border width.
beautiful.radialprogressbar_paddings The padding between the outline and the progressbar.


Functions

radialprogressbar:get_children ()
Get the children elements

Returns:

    table The children
radialprogressbar:set_children (children)
Replace the layout children This layout only accept one children, all others will be ignored
  • children table A table composed of valid widgets
radialprogressbar:reset ()
Reset this container.
wibox.container.radialprogressbar ([widget])
Returns a new radialprogressbar layout. A radialprogressbar layout radialprogressbars a given widget. Use .widget to set the widget.
  • widget The widget to display.

Object properties

wibox.container.radialprogressbar.widget
The widget to wrap in a radial proggressbar.

Type:

wibox.container.radialprogressbar.paddings
The padding between the outline and the progressbar.

Type:

  • paddings A number or a table
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)
wibox.container.radialprogressbar.value
The progressbar value.

Type:

  • value number Between min_value and max_value
wibox.container.radialprogressbar.border_color
The border background color.

wibox.container.radialprogressbar.color
The border foreground color.

wibox.container.radialprogressbar.border_width
The border width.

Type:

  • border_width number (default 3)
wibox.container.radialprogressbar.min_value
The minimum value.
wibox.container.radialprogressbar.max_value
The maximum value.

Theme variables

beautiful.radialprogressbar_border_color
The progressbar border background color.
beautiful.radialprogressbar_color
The progressbar foreground color.
beautiful.radialprogressbar_border_width
The progressbar border width.
beautiful.radialprogressbar_paddings
The padding between the outline and the progressbar.

Type:

  • paddings A number or a table
    • top number (default 0)
    • bottom number (default 0)
    • left number (default 0)
    • right number (default 0)
generated by LDoc 1.4.2