Module: wibox.widget.checkbox

A boolean display widget.

If necessary, themes can implement custom shape:

Usage example

wibox.widget {
    checked       = true,
    color         = beautiful.bg_normal,
    paddings      = 2,
    check_shape   = function(cr, width, height)
        local rs = math.min(width, height)
        cr:move_to( 0  , 0  )
        cr:line_to( rs , 0  )
        cr:move_to( 0  , 0  )
        cr:line_to( 0  , rs )
        cr:move_to( 0  , rs )
        cr:line_to( rs , rs )
        cr:move_to( rs , 0  )
        cr:line_to( rs , rs )
        cr:move_to( 0  , 0  )
        cr:line_to( rs , rs )
        cr:move_to( 0  , rs )
        cr:line_to( rs , 0  )
    end,
    check_border_color = "#ff0000",
    check_color        = "#00000000",
    check_border_width = 1,
    widget             = wibox.widget.checkbox
}

Usage example

Usage:

    wibox.widget {
    checked       = true,
    color         = beautiful.bg_normal,
    paddings      = 2,
    shape         = gears.shape.circle,
    widget        = wibox.widget.checkbox
}

Class Hierarchy

Info:

  • Copyright: 2010 Emmanuel Lepage Vallee
  • Originally authored by: Emmanuel Lepage Valle
    (Full contributors list available on our github project)

Constructors

wibox.widget.checkbox ([checked=false[, args]]) Create a new checkbox.

Object properties

border_width number The outer (unchecked area) border width.
bg color The outer (unchecked area) background color, pattern or gradient.
border_color color The outer (unchecked area) border color.
check_border_color color The checked part border color.
check_border_width number The checked part border width.
check_color color The checked part filling color.
shape gears.shape The outer (unchecked area) shape.
check_shape gears.shape The checked part shape.
paddings table or number The padding between the outline and the progressbar.
color color The checkbox color.
checked boolean If the checkbox is checked.
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.checkbox_border_width number The outer (unchecked area) border width.
beautiful.checkbox_bg color The outer (unchecked area) background color, pattern or gradient.
beautiful.checkbox_border_color color The outer (unchecked area) border color.
beautiful.checkbox_check_border_color color The checked part border color.
beautiful.checkbox_check_border_width number The checked part border width.
beautiful.checkbox_check_color number The checked part filling color.
beautiful.checkbox_shape gears.shape or function The outer (unchecked area) shape.
beautiful.checkbox_check_shape gears.shape or function The checked part shape.
beautiful.checkbox_paddings table or number The padding between the outline and the progressbar.
beautiful.checkbox_color color The checkbox 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.checkbox ([checked=false[, args]])
Create a new checkbox.

Parameters:

  • checked boolean (default false)
  • args
    • color gears.color The color.

Object properties

border_width number · 1 signal · 1 theme variable
The outer (unchecked area) border width.
Click to display more

Emit signals:

  • property::border_width When the border_width value changes.
    • self wibox.widget.checkbox 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.checkbox_border_widthFallback when border_width isn't set.
bg color · 1 signal · 1 theme variable
The outer (unchecked area) background color, pattern or gradient.

Usage example

Usage:

    wibox.widget {
    checked            = true,
    color              = beautiful.bg_normal,
    bg                 = "#ff00ff",
    border_width       = 3,
    paddings           = 4,
    border_color       = "#0000ff",
    check_color        = "#ff0000",
    check_border_color = "#ffff00",
    check_border_width = 1,
    widget             = wibox.widget.checkbox
}

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable Usage
beautiful.checkbox_bgFallback when bg isn't set.
border_color color · 1 signal · 1 theme variable
The outer (unchecked area) border color.
Click to display more

Emit signals:

  • property::border_color When the border_color value changes.
    • self wibox.widget.checkbox 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.checkbox_border_colorFallback when border_color isn't set.
check_border_color color · 1 signal · 1 theme variable
The checked part border color.
Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.checkbox_check_border_colorFallback when check_border_color isn't set.
check_border_width number · 1 signal · 1 theme variable
The checked part border width.
Click to display more

Emit signals:

Consumed theme variables:

Theme variable Usage
beautiful.checkbox_check_border_widthFallback when check_border_width isn't set.
check_color color · 1 signal · 1 theme variable
The checked part filling color.
Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable Usage
beautiful.checkbox_check_colorFallback when check_color isn't set.
shape gears.shape · 1 signal · 1 theme variable
The outer (unchecked area) shape.

Usage example

See also:

Usage:

    for _, s in ipairs {"rectangle", "circle", "losange", "octogon"} do
    wibox.widget {
        checked       = true,
        color         = beautiful.bg_normal,
        paddings      = 2,
        shape         = gears.shape[s],
        widget        = wibox.widget.checkbox
    }
end

Click to display more

Emit signals:

  • property::shape When the shape value changes.
    • self wibox.widget.checkbox 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.checkbox_shapeFallback when shape isn't set.
check_shape gears.shape · 1 signal · 1 theme variable
The checked part shape.

If none is set, then the shape property will be used.

Usage example

See also:

Usage:

    for _, s in ipairs {"rectangle", "circle", "losange", "octogon"} do
    wibox.widget {
        checked       = true,
        color         = beautiful.bg_normal,
        paddings      = 2,
        check_shape   = gears.shape[s],
        widget        = wibox.widget.checkbox
    }
end

Click to display more

Emit signals:

  • property::check_shape When the check_shape value changes.
    • self wibox.widget.checkbox 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.checkbox_check_shapeFallback when check_shape isn't set.
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.widget.checkbox The object which changed (useful when connecting many object to the same callback).

Consumed theme variables:

Theme variable Usage
beautiful.checkbox_paddingsFallback when paddings isn't set.
color color · 1 signal · 1 theme variable
The checkbox color.

This will be used for the unchecked part border color and the checked part filling color. Note that check_color and border_color have priority over this property.

Click to display more

Emit signals:

  • property::color When the color value changes.
    • self wibox.widget.checkbox 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.checkbox_colorFallback when color isn't set.
checked boolean
If the checkbox is checked.
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:

Theme variables

beautiful.checkbox_border_width number
The outer (unchecked area) border width.
beautiful.checkbox_bg color
The outer (unchecked area) background color, pattern or gradient.
beautiful.checkbox_border_color color
The outer (unchecked area) border color.
beautiful.checkbox_check_border_color color
The checked part border color.
beautiful.checkbox_check_border_width number
The checked part border width.
beautiful.checkbox_check_color number
The checked part filling color.
beautiful.checkbox_shape gears.shape or function
The outer (unchecked area) shape.

See also:

beautiful.checkbox_check_shape gears.shape or function
The checked part shape.

If none is set, then the shape property will be used.

See also:

beautiful.checkbox_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)
beautiful.checkbox_color color
The checkbox color.

This will be used for the unchecked part border color and the checked part filling color. Note that check_color and border_color have priority over this property.

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

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:

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

generated by LDoc 1.4.6 Last updated 2021-11-13 00:35:50