Module: `wibox.widget.checkbox`

A boolean display widget.

If necessary, themes can implement custom shape:

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:

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

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.widget.checkbox

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, args)

Create a new checkbox.

Object properties

border_width	number or nil	The outer (unchecked area) border width.
bg	color or nil	The outer (unchecked area) background color, pattern or gradient.
border_color	color or nil	The outer (unchecked area) border color.
check_border_color	color or nil	The checked part border color.
check_border_width	number or nil	The checked part border width.
check_color	color or nil	The checked part filling color.
shape	shape or nil	The outer (unchecked area) shape.
check_shape	shape or nil	The checked part shape.
paddings	table or number or nil	The padding between the outline and the progressbar.
color	color or nil	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)	Disconnect 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, args)

Create a new checkbox.

Parameters:

Name		Type(s)	Description	Default value
checked	Optional	boolean		`false`
args	Optional	table		Undefined
color		gears.color	The color.	Not applicable

Object properties

🔗 border_width number or nil · 1 signal · 1 theme variable

The outer (unchecked area) border width.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_border_width`
Type description:
nil	: Fallback to the current value of `beautiful.checkbox_border_width`.
Unit	: pixel
Negative allowed	: false

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_width	Fallback when border_width isn't set.

🔗 bg color or nil · 1 signal · 1 theme variable

The outer (unchecked area) background color, pattern or gradient.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_bg`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.checkbox_bg`.

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_bg	Fallback when bg isn't set.

🔗 border_color color or nil · 1 signal · 1 theme variable

The outer (unchecked area) border color.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_border_color`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.checkbox_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_color	Fallback when border_color isn't set.

🔗 check_border_color color or nil · 1 signal · 1 theme variable

The checked part border color.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_check_border_color`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.checkbox_check_border_color`.

Click to display more

Emit signals:

property::check_border_color When the check_border_color value changes.

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

Consumed theme variables:

Theme variable	Usage
beautiful.checkbox_check_border_color	Fallback when check_border_color isn't set.

🔗 check_border_width number or nil · 1 signal · 1 theme variable

The checked part border width.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_check_border_width`
Type description:
nil	: Fallback to the current value of `beautiful.checkbox_check_border_width`.
Unit	: pixel
Negative allowed	: false

Click to display more

Emit signals:

property::check_border_width When the check_border_width value changes.

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

Consumed theme variables:

Theme variable	Usage
beautiful.checkbox_check_border_width	Fallback when check_border_width isn't set.

🔗 check_color color or nil · 1 signal · 1 theme variable

The checked part filling color.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_check_color`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.checkbox_check_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_color	Fallback when check_color isn't set.

🔗 shape shape or nil · 1 signal · 1 theme variable

The outer (unchecked area) shape.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_shape`
Type description:
gears.shape	: Like gears.shape.circle
function:	: This can be used for custom shapes or to set parameters of existing shapes.
Function prototype:
Parameters:
cr (cairo.context)	: A Cairo context
width (number)	: The area width.
height (number)	: The area height.
Return	: The function returns nothing.
nil	: Fallback to the current value of `beautiful.checkbox_shape`.

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_shape	Fallback when shape isn't set.

🔗 check_shape shape or nil · 1 signal · 1 theme variable

The checked part shape.

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

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_check_shape`
Type description:
gears.shape	: Like gears.shape.circle
function:	: This can be used for custom shapes or to set parameters of existing shapes.
Function prototype:
Parameters:
cr (cairo.context)	: A Cairo context
width (number)	: The area width.
height (number)	: The area height.
Return	: The function returns nothing.
nil	: Fallback to the current value of `beautiful.checkbox_check_shape`.

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 check_shape The new value affected to the property.

Consumed theme variables:

Theme variable	Usage
beautiful.checkbox_check_shape	Fallback when check_shape isn't set.

🔗 paddings table or number or nil · 1 signal · 1 theme variable

The padding between the outline and the progressbar.

Constraints:

Default value	: `0`
Type description:
number	: A single number for all sides.
table:	: A different value for each sides:
top (number)
bottom (number)
left (number)
right (number)
nil	: Fallback to the current value of `beautiful.checkbox_paddings`.
Unit	: pixel
Negative allowed	: true
Valid values	: A number or a table

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_paddings	Fallback when paddings isn't set.

🔗 color color or nil · 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.

Constraints:

Default value	: `beautiful.wibox_widget_checkbox_color`
Type description:
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
nil	: Fallback to the current value of `beautiful.checkbox_color`.

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_color	Fallback when color isn't set.

🔗 checked boolean

If the checkbox is checked.

Constraints:

Default value	: `false`
Valid values	: `true` or `false`.

🔗 children table · Inherited from wibox.widget.base

Get or set the children elements.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the height. Usually using the widget native height.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the width. Usually using the widget native width.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `1.0`
Unit	: A gradient between transparent (`0.0`) and opaque (`1.0`).
Minimum value	: 0.0
Maximum value	: 1.0

Constraints:

Default value	: `true`
Valid values	: `true` or `false`.

Constraints:

Default value	: `{}`
Table content	: A list of awful.button.

Theme variables

🔗 beautiful.checkbox_border_width number

The outer (unchecked area) border width.
Click to display more

Used by:

border_width The outer (unchecked area) border width.

🔗 beautiful.checkbox_bg color

The outer (unchecked area) background color, pattern or gradient.
Click to display more

Used by:

bg The outer (unchecked area) background color, pattern or gradient.

🔗 beautiful.checkbox_border_color color

The outer (unchecked area) border color.
Click to display more

Used by:

border_color The outer (unchecked area) border color.

🔗 beautiful.checkbox_check_border_color color

The checked part border color.
Click to display more

Used by:

check_border_color The checked part border color.

🔗 beautiful.checkbox_check_border_width number

The checked part border width.
Click to display more

Used by:

check_border_width The checked part border width.

🔗 beautiful.checkbox_check_color number

The checked part filling color.
Click to display more

Used by:

check_color The checked part filling color.

🔗 beautiful.checkbox_shape gears.shape or function

The outer (unchecked area) shape.

Used by:

shape The outer (unchecked area) shape.

🔗 beautiful.checkbox_check_shape gears.shape or function

The checked part shape.

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

Used by:

check_shape The checked part shape.

🔗 beautiful.checkbox_paddings table or number

The padding between the outline and the progressbar.

Type constraints:

Name		Type(s)	Description	Default value
paddings	Optional	table	A number or a table	`0`
top	Optional	number		`0`
bottom	Optional	number		`0`
left	Optional	number		`0`
right	Optional	number		`0`

Click to display more

Used by:

paddings The padding between the outline and the progressbar.

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

Click to display more

Used by:

color The checkbox color.

Object methods

🔗 :add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

Name		Type(s)	Description
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:

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.
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).
If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name		Type(s)	Description
signal_name		string
...			Other arguments

🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

Name		Type(s)	Description
widget		widget	The widget to look for.
recursive	Optional	boolean	Recursively check accross the sub-widgets hierarchy.
...	Optional	widget	Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

number The widget index.
widget The parent widget.
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		Type(s)	Description
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		Type(s)	Description
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

Disconnect from a signal.

Parameters:

Name		Type(s)	Description
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		Type(s)	Description
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.

Arguments:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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.

awesome

Contents

Widgets

Core components

Input handling

Declarative rules

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.widget.checkbox

Usage:

Class Hierarchy

Info:

Constructors

Object properties

Theme variables

Object methods

Signals

Constructors

Parameters:

Object properties

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Usage:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Usage:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Usage:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Theme variables

Used by:

Used by:

Module: `wibox.widget.checkbox`