Module: `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.

Usage example

Usage:

{
    {
        text   = "After",
        align  = "center",
        valign = "center",
        widget = wibox.widget.textbox,
    },
    value     = 0.5,
    max_value = 1,
    min_value = 0,
    widget    = wibox.container.radialprogressbar
},

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.container.radialprogressbar

Info:

Copyright: 2013 Emmanuel Lepage Vallee
Originally authored by: Emmanuel Lepage Vallee <elv1313@gmail.com>
(Full contributors list available on our github project)

Constructors

wibox.container.radialprogressbar ([widget])

Returns a new radialprogressbar layout.

Object properties

widget	widget	The widget to wrap in a radial proggressbar.
paddings	table or number	The padding between the outline and the progressbar.
value	number	The progressbar value.
border_color	color	The border background color.
color	color	The border foreground color.
border_width	number	The border width.
min_value	number	The minimum value.
max_value	number	The maximum value.
children	table	Get or set the children elements.	Inherited from wibox.widget.base
all_children	table	Get all direct and indirect children widgets.	Inherited from wibox.widget.base
forced_height	number or nil	Force a widget height.	Inherited from wibox.widget.base
forced_width	number or nil	Force a widget width.	Inherited from wibox.widget.base
opacity	number	The widget opacity (transparency).	Inherited from wibox.widget.base
visible	boolean	The widget visibility.	Inherited from wibox.widget.base
buttons	table	The widget buttons.	Inherited from wibox.widget.base

Object methods

:reset ()	Reset this container.
:add_button (button)	Add a new awful.button to this widget.	Inherited from wibox.widget.base
:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.	Inherited from wibox.widget.base
:index (widget[, recursive[, ...]]) -> (number, widget, table)	Get the index of a widget.	Inherited from wibox.widget.base
:connect_signal (name, func)	Connect to a signal.	Inherited from gears.object
:weak_connect_signal (name, func)	Connect to a signal weakly.	Inherited from gears.object
:disconnect_signal (name, func)	Disonnect from a signal.	Inherited from gears.object
:emit_signal (name, ...)	Emit a signal.	Inherited from gears.object

Theme variables

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

Signals

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

Constructors

wibox.container.radialprogressbar ([widget])

Returns a new radialprogressbar layout.

A radialprogressbar layout radialprogressbars a given widget. Use .widget to set the widget.

Parameters:

widget widget The widget to display. (optional)

Object properties

widget widget

The widget to wrap in a radial proggressbar.

Type constraints:

widget widget The widget

paddings table or number · 1 signal · 1 theme variable

The padding between the outline and the progressbar.

Usage example

Type constraints:

paddings A number or a table
- top number (default 0)
- bottom number (default 0)
- left number (default 0)
- right number (default 0)

Click to display more

Emit signals:

property::paddings When the paddings value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).

Consumed theme variables:

Theme variable	Usage
beautiful.radialprogressbar_paddings	Fallback when paddings isn't set.

value number · 1 signal

The progressbar value.

Usage example

Type constraints:

value number Between minvalue and maxvalue.

Click to display more

Emit signals:

property::value When the value value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value value The new value affected to the property.

border_color color · 1 signal · 1 theme variable

The border background color.

Usage example

Click to display more

Emit signals:

property::border_color When the border_color value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value border_color The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.radialprogressbar_border_color	Fallback when border_color isn't set.

color color · 1 signal · 1 theme variable

The border foreground color.

Usage example

Click to display more

Emit signals:

property::color When the color value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value color The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.radialprogressbar_color	Fallback when color isn't set.

border_width number · 1 signal · 1 theme variable

The border width.

Usage example

Click to display more

Emit signals:

property::border_width When the border_width value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value border_width The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.radialprogressbar_border_width	Fallback when border_width isn't set.

min_value number · 1 signal

The minimum value.
Click to display more

Emit signals:

property::min_value When the min_value value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value min_value The new value affected to the property.

max_value number · 1 signal

The maximum value.
Click to display more

Emit signals:

property::max_value When the max_value value changes.

self wibox.container.radialprogressbar The object which changed (useful when connecting many object to the same callback).
new_value max_value The new value affected to the property.

children table · Inherited from wibox.widget.base

Get or set the children elements.

Type constraints:

children table The children.

all_children table · Inherited from wibox.widget.base

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a widget, or any of its children, contain (directly or indirectly) itself.

Type constraints:

children table The children.

forced_height number or nil · Inherited from wibox.widget.base

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget.base

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget.base

The widget opacity (transparency).

Type constraints:

opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget.base

The widget visibility.

buttons table · Inherited from wibox.widget.base

The widget buttons.

The table contains a list of awful.button objects.

Object methods

:reset ()

Reset this container.

:add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

button awful.button The button to add.

:emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget.base

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.

Note that this function has some flaws:

The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

signal_name string
... Other arguments

:index (widget[, recursive[, ...]]) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

widget widget The widget to look for.
recursive boolean Recursively check accross the sub-widgets hierarchy. (optional)
... widget Additional widgets to add at the end of the sub-widgets hierarchy "path". (optional)

Returns:

number The widget index.
widget The parent widget.
table The hierarchy path between "self" and "widget".

:connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

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

Usage:

local o = gears.object{}
-- Function can be attached to signals
local function slot(obj, a, b, c)
    print("In slot", obj, a, b, c)
end
o:connect_signal("my_signal", slot)
-- Emitting can be done without arguments. In that case, the object will be
-- implicitly added as an argument.
o:emit_signal "my_signal"
-- It is also possible to add as many random arguments are required.
o:emit_signal("my_signal", "foo", "bar", 42)
-- Finally, to allow the object to be garbage collected (the memory freed), it
-- is necessary to disconnect the signal or use weak_connect_signal
o:disconnect_signal("my_signal", slot)
-- This time, the slot wont be called as it is no longer connected.
o:emit_signal "my_signal"

:weak_connect_signal (name, func) · Inherited from gears.object

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.

:disconnect_signal (name, func) · Inherited from gears.object

Disonnect from a signal.

Parameters:

name string The name of the signal.
func function The callback that should be disconnected.

:emit_signal (name, ...) · Inherited from gears.object

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()

Theme variables

beautiful.radialprogressbar_border_color color

The progressbar border background color.

beautiful.radialprogressbar_color color

The progressbar foreground color.

beautiful.radialprogressbar_border_width number

The progressbar border width.

beautiful.radialprogressbar_paddings table or number

The padding between the outline and the progressbar.

Type constraints:

paddings A number or a table
- top number (default 0)
- bottom number (default 0)
- left number (default 0)
- right number (default 0)

Signals

widget::layout_changed · Inherited from wibox.widget.base

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.

Arguments:

self table The current object instance itself.
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.

Arguments:

self table The current object instance itself.
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.

Arguments:

self table The current object instance itself.
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.

Arguments:

self table The current object instance itself.
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.

awesome

Contents

Widget containers

Core components

Input handling

Declarative rules

Widgets

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Client tiling

Libraries

Sample files

Classes

Documentation

Module: wibox.container.radialprogressbar

Usage:

Class Hierarchy

Info:

Constructors

Object properties

Object methods

Theme variables

Signals

Constructors

Parameters:

Object properties

Type constraints:

Type constraints:

Emit signals:

Consumed theme variables:

Type constraints:

Emit signals:

Emit signals:

Consumed theme variables:

Emit signals:

Consumed theme variables:

Emit signals:

Consumed theme variables:

Emit signals:

Emit signals:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Theme variables

Type constraints:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `wibox.container.radialprogressbar`