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.

Usage example

Info:

  • Copyright: 2013 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee <[email protected]>

Functions

wibox.container.radialprogressbar ([widget]) Returns a new radialprogressbar layout.

Object properties

widget The widget to wrap in a radial proggressbar.
paddings The padding between the outline and the progressbar.
value The progressbar value.
border_color The border background color.
color The border foreground color.
border_width The border width.
min_value The minimum value.
max_value The maximum value.
forced_height Force a widget height.
forced_width Force a widget width.
opacity The widget opacity (transparency).
visible The widget visibility.

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.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.

Methods

wibox.container.radialprogressbar:get_children () Get the children elements
wibox.container.radialprogressbar:set_children (children) Replace the layout children This layout only accept one children, all others will be ignored
wibox.container.radialprogressbar:reset () Reset this container.
wibox.container.radialprogressbar:get_all_children () Get all direct and indirect children widgets.
wibox.container.radialprogressbar:setup (args) Set a declarative widget hierarchy description.
wibox.container.radialprogressbar:buttons (_buttons) Set/get a widget’s buttons.
wibox.container.radialprogressbar:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
wibox.container.radialprogressbar:emit_signal (name, ...) Emit a signal.
wibox.container.radialprogressbar:connect_signal (name, func) Connect to a signal.
wibox.container.radialprogressbar:weak_connect_signal (name, func) Connect to a signal weakly.


Functions

Methods
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. (optional)

Object properties

widget
The widget to wrap in a radial proggressbar.

Type:

paddings
The padding between the outline and the progressbar.

Usage example

Type:

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

Usage example

Type:

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

Usage example

color
The border foreground color.

Usage example

border_width
The border width.

Usage example

Type:

  • border_width number (default 3)
min_value
The minimum value.
max_value
The maximum value.
forced_height
Force a widget height.

Type:

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

Type:

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

Type:

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

Type:

  • boolean

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

Methods

wibox.container.radialprogressbar:get_children ()
Get the children elements

Returns:

    table The children
wibox.container.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
wibox.container.radialprogressbar:reset ()
Reset this container.
wibox.container.radialprogressbar:get_all_children ()
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.

Returns:

    table The children
wibox.container.radialprogressbar:setup (args)
Set a declarative widget hierarchy description. See The declarative layout system
  • args An array containing the widgets disposition
wibox.container.radialprogressbar:buttons (_buttons)
Set/get a widget’s buttons.
  • _buttons The table of buttons that should bind to the widget.
wibox.container.radialprogressbar: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.
  • signal_name string
  • ... Other arguments
wibox.container.radialprogressbar:emit_signal (name, ...)
Emit a signal.
  • 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().
wibox.container.radialprogressbar:connect_signal (name, func)
Connect to a signal.
  • name string The name of the signal.
  • func function The callback to call when the signal is emitted.
wibox.container.radialprogressbar: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.

  • name string The name of the signal.
  • func function The callback to call when the signal is emitted.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00