awesome

• Index

Contents

• Constructors
• Object properties
• Object methods
• Signals
• Theme variables
• Deprecated functions

Widgets

• awful.widget.button
• awful.widget.clienticon
• awful.widget.keyboardlayout
• awful.widget.launcher
• awful.widget.layoutbox
• awful.widget.layoutlist
• awful.widget.prompt
• awful.widget.taglist
• awful.widget.tasklist
• awful.widget.watch
• naughty.list.actions
• naughty.list.notifications
• naughty.widget.icon
• naughty.widget.message
• naughty.widget.title
• wibox.widget.calendar
• wibox.widget.checkbox
• wibox.widget.graph
• wibox.widget.imagebox
• wibox.widget.piechart
• wibox.widget.progressbar
• wibox.widget.separator
• wibox.widget.slider
• wibox.widget.systray
• wibox.widget.textbox
• wibox.widget.textclock

Core components

• awesome
• awful.keygrabber
• client and awful.client
• drawable
• gears.timer
• mousegrabber
• naughty.action
• naughty.notification
• root
• screen and awful.screen
• tag and awful.tag

Input handling

• awful.button
• awful.key
• awful.keyboard
• mouse

Declarative rules

• ruled.client
• ruled.notifications

Widget containers

• awful.widget.only_on_screen
• naughty.widget.background
• wibox.container.arcchart
• wibox.container.background
• wibox.container.constraint
• wibox.container.margin
• wibox.container.mirror
• wibox.container.place
• wibox.container.radialprogressbar
• wibox.container.rotate
• wibox.container.scroll

Widget layouts

• wibox.layout.align
• wibox.layout.fixed
• wibox.layout.flex
• wibox.layout.grid
• wibox.layout.manual
• wibox.layout.ratio
• wibox.layout.stack

Popups and bars

• awful.hotkeys_popup.widget
• awful.menu
• awful.popup
• awful.titlebar
• awful.tooltip
• awful.wibar
• awful.widget.calendar_popup
• menubar
• naughty.layout.box
• naughty.layout.legacy
• wibox

Utility libraries

• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.object
• gears.protected_call
• gears.sort
• gears.string
• gears.table
• gears.wallpaper

Theme related libraries

• beautiful
• gears.color
• gears.shape

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.rules
• awful.spawn
• awful.util
• dbus
• gears.matcher
• gears.surface
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.widget.common
• gears.cache
• gears.matrix
• menubar.icon_theme
• menubar.index_theme
• signals
• wibox.drawable
• wibox.hierarchy
• wibox.widget.base
• xproperties

Documentation

• Authors
• Readme
• Contributing
• The AwesomeWM widget system
• Creating new widget
• Default configuration file documentation
• Change Awesome appearance
• My first Awesome
• Startup options
• Using Cairo and LGI
• Tips for upgrading your configuration
• NEWS
• FAQ

Module: 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 <[email protected]>

Constructors

wibox.widget.progressbar {[args]}

Create a progressbar widget.

Object properties

border_color	color	The progressbar border color.
border_width	number	The progressbar border width.
bar_border_color	color	The progressbar inner border color.
bar_border_width	number	The progressbar inner border width.
color	color	The progressbar foreground color.
background_color	color	The progressbar background color.
bar_shape	gears.shape	The progressbar inner shape.
shape	gears.shape	The progressbar shape.
clip	boolean	Force the inner part (the bar) to fit in the background shape.
ticks	boolean	The progressbar to draw ticks.
ticks_gap	number	The progressbar ticks gap.
ticks_size	number	The progressbar ticks size.
max_value	number	The maximum value the progressbar should handle.
margins	(table or number or nil)	The progressbar margins.
paddings	(table or number or nil)	The progressbar padding.
value	number	Set the progressbar 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

: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.progressbar_bg	color	The progressbar background color.
beautiful.progressbar_fg	color	The progressbar foreground color.
beautiful.progressbar_shape	gears.shape	The progressbar shape.
beautiful.progressbar_border_color	color	The progressbar border color.
beautiful.progressbar_border_width	number	The progressbar outer border width.
beautiful.progressbar_bar_shape	gears.shape	The progressbar inner shape.
beautiful.progressbar_bar_border_width	number	The progressbar bar border width.
beautiful.progressbar_bar_border_color	color	The progressbar bar border color.
beautiful.progressbar_margins	(table or number or nil)	The progressbar margins.
beautiful.progressbar_paddings	(table or number or nil)	The progressbar padding.

Deprecated functions

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

Constructors

wibox.widget.progressbar {[args]}

Create a progressbar widget.

Parameters:

• args Standard widget() arguments. You should add width and height constructor parameters to set progressbar geometry.
  • width number The width.
  • height number The height.

Returns:

wibox.widget.progressbar A progressbar widget.

Object properties

border_color color · 1 signal · 1 theme variable

The progressbar border color.

If the value is nil, no border will be drawn.

Type constraints:

• color color The border color to set.

See also:

gears.color

Click to display more

Emit signals:

• property::border_color When the border_color value changes.
• self wibox.widget.progressbar 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.progressbar_border_color	Fallback when border_color isn't set.

border_width number · 1 signal · 1 theme variable

The progressbar border width.
Click to display more

Emit signals:

• property::border_width When the border_width value changes.
• self wibox.widget.progressbar 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.progressbar_border_width	Fallback when border_width isn't set.

bar_border_color color · 1 signal · 1 theme variable

The progressbar inner border color.

If the value is nil, no border will be drawn.

Type constraints:

• color color The border color to set.

See also:

gears.color

Click to display more

Emit signals:

• property::bar_border_color When the bar_border_color value changes.
• self wibox.widget.progressbar 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.progressbar_bar_border_color	Fallback when bar_border_color isn't set.

bar_border_width number · 1 signal · 1 theme variable

The progressbar inner border width.
Click to display more

Emit signals:

• property::bar_border_width When the bar_border_width value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value bar_border_width The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.progressbar_bar_border_width	Fallback when bar_border_width isn't set.

color color · 1 signal · 1 theme variable

The progressbar foreground color.

Type constraints:

• color color The progressbar color.

See also:

gears.color

Click to display more

Emit signals:

• property::color When the color value changes.
• self wibox.widget.progressbar 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.progressbar_fg

background_color color · 1 signal · 1 theme variable

The progressbar background color.

Type constraints:

• color color The progressbar background color.

See also:

gears.color

Click to display more

Emit signals:

• property::background_color When the background_color value changes.
• self wibox.widget.progressbar 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.progressbar_bg

bar_shape gears.shape · 1 signal · 1 theme variable

The progressbar inner shape.

See also:

gears.shape

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

Click to display more

Emit signals:

• property::bar_shape When the bar_shape value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value shape The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.progressbar_bar_shape	Fallback when bar_shape isn't set.

shape gears.shape · 1 signal · 1 theme variable

The progressbar shape.

See also:

gears.shape

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

Click to display more

Emit signals:

• property::shape When the shape value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value shape The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.progressbar_shape	Fallback when shape isn't set.

clip boolean · 1 signal

Force the inner part (the bar) to fit in the background shape.

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,
}

Click to display more

Emit signals:

• property::clip When the clip value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value clip The new value affected to the property.

ticks boolean · 1 signal

The progressbar to draw ticks. Default is false.
Click to display more

Emit signals:

• property::ticks When the ticks value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value ticks The new value affected to the property.

ticks_gap number · 1 signal

The progressbar ticks gap.
Click to display more

Emit signals:

• property::ticks_gap When the ticks_gap value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value ticks_gap The new value affected to the property.

ticks_size number · 1 signal

The progressbar ticks size.
Click to display more

Emit signals:

• property::ticks_size When the ticks_size value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value ticks_size The new value affected to the property.

max_value number · 1 signal

The maximum value the progressbar should handle.
Click to display more

Emit signals:

• property::max_value When the max_value value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value max_value The new value affected to the property.

margins (table or number or nil) · 1 signal · 1 theme variable

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

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

clip

Click to display more

Emit signals:

• property::margins When the margins value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).

Consumed theme variables:

Theme variable	Usage
beautiful.progressbar_margins	Fallback when margins isn't set.

paddings (table or number or nil) · 1 signal · 1 theme variable

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

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

clip

Click to display more

Emit signals:

• property::paddings When the paddings value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).

Consumed theme variables:

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

value number · 1 signal

Set the progressbar value.

Type constraints:

• value number The progress bar value between 0 and 1.

Click to display more

Emit signals:

• property::value When the value value changes.
• self wibox.widget.progressbar The object which changed (useful when connecting many object to the same callback).
• new_value 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)

forced_width number or nil · Inherited from wibox.widget

Force a widget width.

Type constraints:

• width number or nil The width (nil for automatic)

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:

awful.button

Object methods

: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

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:

widget::layout_changed

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:

mouse

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

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

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:

mouse

Theme variables

beautiful.progressbar_bg color

The progressbar background color.

beautiful.progressbar_fg color

The progressbar foreground color.

beautiful.progressbar_shape gears.shape

The progressbar shape.

See also:

gears.shape

beautiful.progressbar_border_color color

The progressbar border color.

beautiful.progressbar_border_width number

The progressbar outer border width.

beautiful.progressbar_bar_shape gears.shape

The progressbar inner shape.

See also:

gears.shape

beautiful.progressbar_bar_border_width number

The progressbar bar border width.

beautiful.progressbar_bar_border_color color

The progressbar bar border color.

beautiful.progressbar_margins (table or number or nil)

The progressbar margins.

Note that if the clip is disabled, this allows the background to be smaller than the bar.

Type constraints:

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

clip

beautiful.progressbar_paddings (table or number or nil)

The progressbar padding.

Note that if the clip is disabled, this allows the bar to be taller than the background.

Type constraints:

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

clip

Deprecated functions

wibox.widget.progressbar.set_vertical [deprecated]

Set the progressbar to draw vertically.

This doesn’t do anything anymore, use a wibox.container.rotate widget.

Parameters:

• vertical boolean

wibox.widget.progressbar.set_height [deprecated]

Set the progressbar height.

This method is deprecated. Use a wibox.container.constraint widget or forced_height.

Parameters:

• height number The height to set.

wibox.widget.progressbar.set_width [deprecated]

Set the progressbar width.

This method is deprecated. Use a wibox.container.constraint widget or forced_width.

Parameters:

• width number The width to set.