Module: wibox.widget.separator

A flexible separator widget.

By default, this widget display a simple line, but can be extended by themes (or directly) to display much more complex visuals.

This widget is mainly intended to be used alongside the spacing_widget property supported by various layouts such as:

When used with these layouts, it is also possible to provide custom clipping functions. This is useful when the layout has overlapping widgets (negative spacing).

Usage example

Usage:

    wibox.widget {
        widget = wibox.widget.separator
    }
    

Info:

  • Copyright: 2014, 2017 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee <[email protected]>

Constructors

wibox.widget.separator {[args]} Create a new separator.

Object properties

orientation string The separator’s orientation.
thickness number The separator’s thickness.
shape function The separator’s shape.
span_ratio number The relative percentage covered by the bar.
color color The separator’s color.
border_color color The separator’s border color.
border_width number The separator’s border width.
children table Get or set the children elements. Inherited from wibox.widget
all_children table Get all direct and indirect children widgets. Inherited from wibox.widget
forced_height number or nil Force a widget height. Inherited from wibox.widget
forced_width number or nil Force a widget width. Inherited from wibox.widget
opacity number The widget opacity (transparency). Inherited from wibox.widget
visible boolean The widget visibility. Inherited from wibox.widget
buttons table The widget buttons. Inherited from wibox.widget

Object methods

:setup {[args]} Set a declarative widget hierarchy description. Inherited from wibox.widget
:add_button (button) Add a new awful.button to this widget. Inherited from wibox.widget
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal. Inherited from wibox.widget
:emit_signal (name, ...) Emit a signal. Inherited from gears.object
: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

Signals

widget::layout_changed When the layout (size) change. Inherited from wibox.widget
widget::redraw_needed When the widget content changed. Inherited from wibox.widget
button::press When a mouse button is pressed over the widget. Inherited from wibox.widget
button::release When a mouse button is released over the widget. Inherited from wibox.widget
mouse::enter When the mouse enter a widget. Inherited from wibox.widget
mouse::leave When the mouse leave a widget. Inherited from wibox.widget

Theme variables

beautiful.separator_thickness number The separator thickness.
beautiful.separator_border_color color The separator border color.
beautiful.separator_border_width number The separator border width.
beautiful.separator_span_ratio number The relative percentage covered by the bar.
beautiful.separator_color string The separator’s color.
beautiful.separator_shape function The separator’s shape.


Constructors

wibox.widget.separator {[args]}
Create a new separator.

Parameters:

  • args table The arguments (all properties are available).

Object properties

orientation string · 1 signal
The separator’s orientation.

Valid values are:

  • vertical: From top to bottom
  • horizontal: From left to right
  • auto: Decide depending on the widget geometry (default)

The default value is selected automatically. If the widget is taller than large, it will use vertical and vice versa.

Usage example

Click to display more

Emit signals:

  • property::orientation When the orientation value changes.
    • self wibox.widget.separator The object which changed (useful when connecting many object to the same callback).
    • new_value orientation The new value affected to the property.
thickness number · 1 signal · 1 theme variable
The separator’s thickness.

This is used by the default line separator, but ignored when a shape is used.

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable Usage
beautiful.separator_thicknessFallback when thickness isn't set.
shape function · 1 signal · 1 theme variable
The separator’s shape.

Usage example

Type constraints:

  • shape function A valid shape function

See also:

Usage:

    for _, s in ipairs { 'losange' ,'circle', 'isosceles_triangle', 'cross' } do
        local w = wibox.widget {
            shape  = gears.shape[s],
            widget = wibox.widget.separator,
        }
    end

Click to display more

Emit signals:

  • property::shape When the shape value changes.
    • self wibox.widget.separator 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.separator_shapeFallback when shape isn't set.
span_ratio number · 1 signal · 1 theme variable
The relative percentage covered by the bar.

Type constraints:

  • A number number between 0 and 1. (default 1)

Click to display more

Emit signals:

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

Consumed theme variables:

Theme variable Usage
beautiful.separator_span_ratioFallback when span_ratio isn't set.
color color · 1 signal · 1 theme variable
The separator’s color.

See also:


Click to display more

Emit signals:

  • property::color When the color value changes.
    • self wibox.widget.separator 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.separator_colorFallback when color isn't set.
border_color color · 1 signal · 1 theme variable
The separator’s border color.

Usage example

See also:

Usage:

    wibox.widget {
        shape        = gears.shape.circle,
        color        = '#00000000',
        border_width = 1,
        border_color = beautiful.bg_normal,
        widget       = wibox.widget.separator,
    }

Click to display more

Emit signals:

  • property::border_color When the border_color value changes.
    • self wibox.widget.separator 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.separator_border_colorFallback when border_color isn't set.
border_width number · 1 signal · 1 theme variable
The separator’s border width.
Click to display more

Emit signals:

  • property::border_width When the border_width value changes.
    • self wibox.widget.separator 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.separator_border_widthFallback when border_width isn't set.
children table · Inherited from wibox.widget
Get or set the children elements.

Type constraints:

  • children table The children.
all_children table · Inherited from wibox.widget
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:

  • children table The children.
forced_height number or nil · Inherited from wibox.widget
Force a widget height.

Type constraints:

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

Type constraints:

  • width number or nil The width (nil for automatic)
opacity number · Inherited from wibox.widget
The widget opacity (transparency).

Type constraints:

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

The table contains a list of awful.button objects.

See also:

Object methods

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

Parameters:

  • args An array containing the widgets disposition
:add_button (button) · Inherited from wibox.widget
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
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, ...) · 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().
:connect_signal (name, func) · Inherited from gears.object
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) · 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.

Signals

widget::layout_changed · Inherited from wibox.widget
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
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
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
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
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
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:

Theme variables

beautiful.separator_thickness number
The separator thickness.

See also:

beautiful.separator_border_color color
The separator border color.

See also:

beautiful.separator_border_width number
The separator border width.

See also:

beautiful.separator_span_ratio number
The relative percentage covered by the bar.

Type constraints:

  • A number number between 0 and 1. (default 1)
beautiful.separator_color string
The separator’s color.

See also:

beautiful.separator_shape function
The separator’s shape.

Type constraints:

  • shape function A valid shape function

See also:

generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00