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.
Info:
- Copyright: 2013 Emmanuel Lepage Vallee
- Author: Emmanuel Lepage Vallee <[email protected]>
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 |
all_children | table | Get all direct and indirect children widgets. | Inherited from wibox.widget |
forced_height | number or nil | Force a widget height. | Inherited from wibox.widget |
forced_width | number or nil | Force a widget width. | Inherited from wibox.widget |
opacity | number | The widget opacity (transparency). | Inherited from wibox.widget |
visible | boolean | The widget visibility. | Inherited from wibox.widget |
buttons | table | The widget buttons. | Inherited from wibox.widget |
Object methods
:reset () | Reset this container. | |
:setup {[args]} | Set a declarative widget hierarchy description. | Inherited from wibox.widget |
:add_button (button) | Add a new awful.button to this widget. | Inherited from wibox.widget |
:emit_signal_recursive (signal_name, ...) | Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. | Inherited from wibox.widget |
:emit_signal (name, ...) | Emit a signal. | Inherited from gears.object |
: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 |
Signals
widget::layout_changed | When the layout (size) change. | Inherited from wibox.widget |
widget::redraw_needed | When the widget content changed. | Inherited from wibox.widget |
button::press | When a mouse button is pressed over the widget. | Inherited from wibox.widget |
button::release | When a mouse button is released over the widget. | Inherited from wibox.widget |
mouse::enter | When the mouse enter a widget. | Inherited from wibox.widget |
mouse::leave | When the mouse leave a widget. | Inherited from wibox.widget |
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. |
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.
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. - paddings A number or a table
- value number · 1 signal
-
The progressbar value.
Type constraints:
- value number Between min_value and max_value.
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.
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.
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.
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
-
Get or set the children elements.
Type constraints:
- children table The children.
- all_children table · Inherited from wibox.widget
-
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:
- children table The children.
- forced_height number or nil · Inherited from wibox.widget
-
Force a widget height.
Type constraints:
- height
number or nil
The height (
nil
for automatic)
- height
number or nil
The height (
- forced_width number or nil · Inherited from wibox.widget
-
Force a widget width.
Type constraints:
- width
number or nil
The width (
nil
for automatic)
- width
number or nil
The width (
- opacity number · Inherited from wibox.widget
-
The widget opacity (transparency).
Type constraints:
- opacity number The opacity (between 0 and 1) (default 1)
- visible boolean · Inherited from wibox.widget
- The widget visibility.
- buttons table · Inherited from wibox.widget
-
The widget buttons.
The table contains a list of awful.button objects.
See also:
Object methods
- :reset ()
- Reset this container.
- :setup {[args]} · Inherited from wibox.widget
-
Set a declarative widget hierarchy description.
See The declarative layout system
Parameters:
- args An array containing the widgets disposition
- :add_button (button) · Inherited from wibox.widget
-
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
-
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, ...) · 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().
- :connect_signal (name, func) · Inherited from gears.object
-
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) · 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.
Signals
- widget::layout_changed · Inherited from wibox.widget
-
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 · Inherited from wibox.widget
-
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 · Inherited from wibox.widget
-
When a mouse button is pressed over the widget.
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.
See also:
- button::release · Inherited from wibox.widget
-
When a mouse button is released over the widget.
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.
See also:
- mouse::enter · Inherited from wibox.widget
-
When the mouse enter a widget.
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.
See also:
- mouse::leave · Inherited from wibox.widget
-
When the mouse leave a widget.
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.
See also:
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)
- paddings A number or a table