awesome

• Index

Contents

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

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.clipboard
• ruled.notifications
• ruled.screen
• ruled.tag

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
• wibox.container.tile

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

Client tiling

• dynamite
• dynamite.layout.conditional
• dynamite.layout.ratio
• dynamite.layout.stack
• dynamite.layout.tabbed
• dynamite.utils
• dynamite.widget.placeholder

Libraries

• awful.completion
• awful.hotkeys_popup
• awful.layout
• awful.permissions
• awful.placement
• awful.prompt
• awful.spawn
• awful.util
• dbus
• dynamite.widget.pager
• dynamite.widget.spawn
• gears.matcher
• gears.surface
• lib.lain.layout.centerwork
• menubar.menu_gen
• menubar.utils
• naughty
• selection
• wibox.widget

Sample files

• rc.lua
• theme.lua

Classes

• awful.widget.common
• gears.cache
• gears.connection
• gears.history
• gears.matrix
• gears.reactive
• gears.watcher
• menubar.icon_theme
• menubar.index_theme
• signals
• wibox.container.conditional
• wibox.container.scale
• wibox.container.template
• wibox.drawable
• wibox.hierarchy
• wibox.widget.base
• wibox.widget.status
• xproperties

Documentation

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

Module: wibox.widget.slider

An interactive mouse based slider widget.

Usage:

wibox.widget {
    bar_shape           = gears.shape.rounded_rect,
    bar_height          = 3,
    bar_color           = beautiful.border_color,
    handle_color        = beautiful.bg_normal,
    handle_shape        = gears.shape.circle,
    handle_border_color = beautiful.border_color,
    handle_border_width = 1,
    value               = 25,
    widget              = wibox.widget.slider,
}

Constructors

wibox.widget.slider {[args]}

Create a slider widget.

Object properties

handle_shape	gears.shape	The slider handle shape.
handle_color	color	The slider handle color.
handle_margins	table	The slider handle margins.
handle_width	number	The slider handle width.
handle_border_color	color	The handle border_color.
handle_border_width	number	The handle border width.
bar_shape	gears.shape	The bar (background) shape.
bar_height	number	The bar (background) height.
bar_color	color	The bar (background) color.
bar_active_color	color	The bar (active) color.
bar_margins	table	The bar (background) margins.
bar_border_width	number	The bar (background) border width.
bar_border_color	color	The bar (background) border_color.
value	number	The slider value.
minimum	number	The slider minimum value.
maximum	number	The slider 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

Theme variables

beautiful.slider_bar_border_width	number	The bar (background) border width.
beautiful.slider_bar_border_color	color	The bar (background) border color.
beautiful.slider_handle_border_color	color	The handle border_color.
beautiful.slider_handle_border_width	number	The handle border width.
beautiful.slider_handle_width	number	The handle width.
beautiful.slider_handle_color	color	The handle color.
beautiful.slider_handle_shape	gears.shape	The handle shape.
beautiful.slider_bar_shape	gears.shape	The bar (background) shape.
beautiful.slider_bar_height	number	The bar (background) height.
beautiful.slider_bar_margins	table	The bar (background) margins.
beautiful.slider_handle_margins	table	The slider handle margins.
beautiful.slider_bar_color	color	The bar (background) color.
beautiful.slider_bar_active_color	color	The bar (active) color.

Object methods

: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

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.widget.slider {[args]}

Create a slider widget.

Parameters:

• args table (default {})

Object properties

handle_shape gears.shape · 1 signal · 1 theme variable

The slider handle shape.

See also:

gears.shape

Click to display more

Emit signals:

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

handle_color color · 1 signal · 1 theme variable

The slider handle color.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_handle_color	Fallback when handle_color isn't set.

handle_margins table · 1 signal · 1 theme variable

The slider handle margins.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_handle_margins	Fallback when handle_margins isn't set.

handle_width number · 1 signal · 1 theme variable

The slider handle width.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_handle_width	Fallback when handle_width isn't set.

handle_border_color color · 1 signal · 1 theme variable

The handle border_color.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_handle_border_color	Fallback when handle_border_color isn't set.

handle_border_width number · 1 signal · 1 theme variable

The handle border width.
Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_handle_border_width	Fallback when handle_border_width isn't set.

bar_shape gears.shape · 1 signal · 1 theme variable

The bar (background) shape.

See also:

gears.shape

Click to display more

Emit signals:

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

bar_height number · 1 signal · 1 theme variable

The bar (background) height.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_bar_height	Fallback when bar_height isn't set.

bar_color color · 1 signal · 1 theme variable

The bar (background) color.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_bar_color	Fallback when bar_color isn't set.

bar_active_color color · 1 signal · 1 theme variable

The bar (active) color.

Only works when both bar_active_color and bar_color are passed as hex color string

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_bar_active_color	Fallback when bar_active_color isn't set.

bar_margins table · 1 signal · 1 theme variable

The bar (background) margins.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_bar_margins	Fallback when bar_margins isn't set.

bar_border_width number · 1 signal

The bar (background) border width.
Click to display more

Emit signals:

• property::bar_border_width When the bar_border_width value changes.
• self wibox.widget.slider 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.

bar_border_color color · 1 signal · 1 theme variable

The bar (background) border_color.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable	Usage
beautiful.slider_bar_border_color	Fallback when bar_border_color isn't set.

value number · 1 signal

The slider value.

Signal: property::value notify the value is changed.

Click to display more

Emit signals:

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

minimum number · 1 signal

The slider minimum value.
Click to display more

Emit signals:

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

maximum number · 1 signal

The slider maximum value.
Click to display more

Emit signals:

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

See also:

awful.button

Theme variables

beautiful.slider_bar_border_width number

The bar (background) border width.

beautiful.slider_bar_border_color color

The bar (background) border color.

beautiful.slider_handle_border_color color

The handle border_color.

beautiful.slider_handle_border_width number

The handle border width.

beautiful.slider_handle_width number

The handle width.

beautiful.slider_handle_color color

The handle color.

beautiful.slider_handle_shape gears.shape

The handle shape.

See also:

gears.shape

beautiful.slider_bar_shape gears.shape

The bar (background) shape.

See also:

gears.shape

beautiful.slider_bar_height number

The bar (background) height.

beautiful.slider_bar_margins table

The bar (background) margins.

beautiful.slider_handle_margins table

The slider handle margins.

beautiful.slider_bar_color color

The bar (background) color.

beautiful.slider_bar_active_color color

The bar (active) color.

Only works when both beautiful.slider_bar_color and beautiful.slider_bar_active_color are hex color strings

Object methods

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

1. 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.
2. 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).
3. 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:

1. number The widget index.
2. widget The parent widget.
3. 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()

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.

See also:

widget::redraw_needed

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

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

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

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

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

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