Module: `wibox.widget.separator`

A flexible separator widget.

By default, this widget displays 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:

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

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.widget.separator

Info:

Copyright: 2014, 2017 Emmanuel Lepage Vallee
Originally authored by: Emmanuel Lepage Vallee <[email protected]>
(Full contributors list available on our github project)

Constructors

wibox.widget.separator {[args]}

Create a new separator.

Object properties

orientation	string	The separator's orientation.
thickness	number or nil	The separator's thickness.
shape	shape or nil	The separator's shape.
span_ratio	number or nil	The relative percentage covered by the bar.
color	color or nil	The separator's color.
border_color	color or nil	The separator's border color.
border_width	number or nil	The separator's border width.
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.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	color	The separator's color.
beautiful.separator_shape	shape	The separator's shape.

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.separator {[args]}

Create a new separator.

Parameters:

Note: This constructors uses named parameters calling convention. It means you call it with {} and omit the parantheses. For example, calling this will all default argument would be wibox.widget.separator{}. This is a Lua shortcut syntax equivalent to wibox.widget.separator({}). args is only a placeholder name for the "lone table argument" used in named parameters calls.

Name		Type(s)	Description
args		table	The arguments (all properties are available).
orientation	Optional	string	The separator's orientation.
thickness	Optional	number	The separator's thickness.
shape	Optional	function	The separator's shape.
span_ratio	Optional	number	The relative percentage covered by the bar.
color	Optional	color	The separator's color.
border_color	Optional	color	The separator's border color.
border_width	Optional	number	The separator's border width.

Object properties

🔗 orientation string · 1 signal

The separator's orientation.

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

Constraints:

Default value	: `"auto"`
Valid values:
`"vertical"`	: From top to bottom.
`"horizontal"`	: From left to right.
`"auto"`	: Decide depending on the widget geometry.

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 or nil · 1 signal · 1 theme variable

The separator's thickness.

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

Constraints:

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

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_thickness	Fallback when thickness isn't set.

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

The separator's shape.

Constraints:

Default value	: `beautiful.wibox_widget_separator_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.separator_shape`.
Valid values	: A valid shape function

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

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

The relative percentage covered by the bar.

Constraints:

Default value	: `1`
Type description:
nil	: Fallback to the current value of `beautiful.separator_span_ratio`.
Unit	: A gradient between "small" (0.0) and "full width/height" (1.0).
Minimum value	: 0.0
Maximum value	: 1.0

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

Consumed theme variables:

Theme variable	Usage
beautiful.separator_span_ratio	Fallback when span_ratio isn't set.

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

The separator's color.

Constraints:

Default value	: `beautiful.wibox_widget_separator_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.separator_color`.

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

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

The separator's border color.

Constraints:

Default value	: `beautiful.wibox_widget_separator_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.separator_border_color`.

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

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

The separator's border width.

Constraints:

Default value	: `beautiful.wibox_widget_separator_border_width`
Type description:
nil	: Fallback to the current value of `beautiful.separator_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.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_width	Fallback when border_width isn't set.

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

The separator thickness.

Used by:

thickness The separator's thickness.

🔗 beautiful.separator_border_color color

The separator border color.

Used by:

border_color The separator's border color.

🔗 beautiful.separator_border_width number

The separator border width.

Used by:

border_width The separator's border width.

🔗 beautiful.separator_span_ratio number

The relative percentage covered by the bar.

Type constraints:

Name		Type(s)	Description	Default value
separator_span_ratio	Optional	number	A number between 0 and 1.	`1`

Click to display more

Used by:

span_ratio The relative percentage covered by the bar.

🔗 beautiful.separator_color color

The separator's color.

Used by:

color The separator's color.

🔗 beautiful.separator_shape shape

The separator's shape.

Type constraints:

Name		Type(s)	Description	Default value
shape	Optional	shape	A valid shape function	`gears.shape.rectangle`

Used by:

shape The separator's shape.

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

Usage:

Class Hierarchy

Info:

Constructors

Object properties

Theme variables

Object methods

Signals

Constructors

Parameters:

Object properties

Constraints:

Emit signals:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Usage:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Usage:

Emit signals:

Consumed theme variables:

Constraints:

Emit signals:

Consumed theme variables:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Theme variables

See also:

Used by:

See also:

Used by:

See also:

Used by:

Type constraints:

Used by:

See also:

Used by:

Type constraints:

See also:

Used by:

Module: `wibox.widget.separator`