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
    }
    

Info:

  • Copyright: 2010 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Valle

Constructors

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

Functions

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

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.
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.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 The outer (unchecked area) shape.
beautiful.checkbox_check_shape gears.shape 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.


Constructors

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

Parameters:

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

Functions

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

Parameters:

  • button awful.button The button to add.

Object properties

border_width (number)
The outer (unchecked area) border width.
bg (color)
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
    }
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.

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
check_shape (gears.shape)
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
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)
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.
checked (boolean)
If the checkbox is checked.
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.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)
The outer (unchecked area) shape.

See also:

beautiful.checkbox_check_shape (gears.shape)
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.
generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00