Module: wibox.widget.slider

An interactive mouse based slider widget.

Usage example

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

Info:

Constructors

wibox.widget.slider {[args]} Create a slider widget.

Functions

wibox.widget.slider.add_button (button) Add a new awful.button to this 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 numbergb 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.
all_children table Get all direct and indirect children widgets.
forced_height number or nil Force a widget height.
forced_width number or nil Force a widget width.
opacity number The widget opacity (transparency).
visible boolean The widget visibility.
buttons table The widget buttons.

Object methods

:setup {[args]} Set a declarative widget hierarchy description.
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
:emit_signal (name, ...) Emit a signal.
:connect_signal (name, func) Connect to a signal.
:weak_connect_signal (name, func) Connect to a signal weakly.

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


Constructors

wibox.widget.slider {[args]}
Create a slider widget.

Parameters:

  • args table (default {})

Functions

wibox.widget.slider.add_button (button)
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.

Object properties

handle_shape (gears.shape)
The slider handle shape.

Usage example

See also:

handle_color (color)
The slider handle color.

Usage example

handle_margins (table)
The slider handle margins.

Usage example

handle_width (number)
The slider handle width.

Usage example

handle_border_color (color)
The handle border_color.

Usage example

handle_border_width (number)
The handle border width.
bar_shape (gears.shape)
The bar (background) shape.

Usage example

See also:

bar_height (number)
The bar (background) height.

Usage example

bar_color (color)
The bar (background) color.

Usage example

bar_active_color (color)
The bar (active) color.

Usage example

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

bar_margins (table)
The bar (background) margins.

Usage example

bar_border_width (numbergb)
The bar (background) border width.
bar_border_color (color)
The bar (background) border_color.

Usage example

value (number)
The slider value.

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

Usage example

minimum (number)
The slider minimum value.
maximum (number)
The slider maximum value.
children (table)
Get or set the children elements.

Type constraints:

all_children (table)
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:

forced_height (number or nil)
Force a widget height.

Type constraints:

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

Type constraints:

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

Type constraints:

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

The table contains a list of awful.button objects.

See also:

Object methods

:setup {[args]}
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
: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.

Parameters:

  • signal_name string
  • ... Other arguments
:emit_signal (name, ...)
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)
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)
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
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.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 .
beautiful.slider_handle_shape (gears.shape)
The handle shape.

See also:

beautiful.slider_bar_shape (gears.shape)
The bar (background) shape.

See also:

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
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00