Module: lib-widget.separator
Create a new separate widget
Useful when you want to separate widgets from eachother
-- separate that is 20 pixels high local separate = lib-widget.separate(dpi(20))
Class Hierarchy
- gears.object
-
- wibox.widget.base
-
- wibox.widget.separator
-
- lib-widget.separator
Info:
- Copyright: 2020 Tom Meyers
- Author: Tom Meyers
Static module functions
lib-widget.separator.separate ([size[, orientation[, opacity]]]) -> widget | Create a new separate widget |
Object properties
orientation | string | The separator's orientation. | Inherited from wibox.widget.separator |
thickness | number | The separator's thickness. | Inherited from wibox.widget.separator |
shape | function | The separator's shape. | Inherited from wibox.widget.separator |
span_ratio | number | The relative percentage covered by the bar. | Inherited from wibox.widget.separator |
color | color | The separator's color. | Inherited from wibox.widget.separator |
border_color | color | The separator's border color. | Inherited from wibox.widget.separator |
border_width | number | The separator's border width. | Inherited from wibox.widget.separator |
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. | Inherited from wibox.widget.separator |
beautiful.separator_border_color | color | The separator border color. | Inherited from wibox.widget.separator |
beautiful.separator_border_width | number | The separator border width. | Inherited from wibox.widget.separator |
beautiful.separator_span_ratio | number | The relative percentage covered by the bar. | Inherited from wibox.widget.separator |
beautiful.separator_color | string | The separator's color. | Inherited from wibox.widget.separator |
beautiful.separator_shape | function | The separator's shape. | Inherited from wibox.widget.separator |
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 |
Static module functions
- lib-widget.separator.separate ([size[, orientation[, opacity]]]) -> widget
-
Create a new separate widget
Parameters:
- size number The height of the separate (optional)
- orientation string In which way it the separate oriented (horizontal or vertical) (optional)
- opacity number How visible is the separate (Between 0 and 1) (optional)
Returns:
-
widget
The separate widget
Usage:
-- This will create a separate that is 20 pixels high -- separate that is 20 pixels high local separate = lib-widget.separate(dpi(20))
Object properties
- orientation string · Inherited from wibox.widget.separator · 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.
Click to display more Emit signals:
property::orientation
When theorientation
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 · Inherited from wibox.widget.separator · 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 thethickness
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 function · Inherited from wibox.widget.separator · 1 signal · 1 theme variable
-
The separator's shape.
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 theshape
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 · Inherited from wibox.widget.separator · 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 thespan_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_ratio
Fallback when span_ratio
isn't set. - color color · Inherited from wibox.widget.separator · 1 signal · 1 theme variable
-
The separator's color.
See also:
Click to display more Emit signals:
property::color
When thecolor
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 · Inherited from wibox.widget.separator · 1 signal · 1 theme variable
-
The separator's border color.
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 theborder_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 · Inherited from wibox.widget.separator · 1 signal · 1 theme variable
-
The separator's border width.
Click to display more Emit signals:
property::border_width
When theborder_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.
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)
- height
number or nil
The height (
- 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)
- width
number or nil
The width (
- 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.separator_thickness number · Inherited from wibox.widget.separator
-
The separator thickness.
See also:
- beautiful.separator_border_color color · Inherited from wibox.widget.separator
-
The separator border color.
See also:
- beautiful.separator_border_width number · Inherited from wibox.widget.separator
-
The separator border width.
See also:
- beautiful.separator_span_ratio number · Inherited from wibox.widget.separator
-
The relative percentage covered by the bar.
Type constraints:
- A number number between 0 and 1. (default 1)
- beautiful.separator_color string · Inherited from wibox.widget.separator
-
The separator's color.
See also:
- beautiful.separator_shape function · Inherited from wibox.widget.separator
-
The separator's shape.
Type constraints:
- shape function A valid shape function
See also:
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:
- 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:
- 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:
- 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 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, theslot
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: