Module: wibox.layout.manual

A layout with widgets added at specific positions.

Use cases include desktop icons, complex custom composed widgets, a floating client layout and fine grained control over the output.

Usage example

Usage:

    local w1, w2 = generic_widget(), generic_widget()
w1.point  = {x=75,y=5}
w1.text   = "first"
w1.forced_width = 50
w2.text = "second"
w2.point  = function(geo, args)
    -- Bottom right
    return {
        x = args.parent.width-geo.width,
        y = args.parent.height-geo.height
    }
end
wibox.layout {
    w1,
    w2,
    generic_widget("third"),
    layout  = wibox.layout.manual
}

Class Hierarchy

Info:

  • Copyright: 2016 Emmanuel Lepage Vallee
  • Originally authored by: Emmanuel Lepage Vallee
    (Full contributors list available on our github project)

Constructors

wibox.layout.manual (...) Create a manual layout.

Object methods

:add (...) Add some widgets to the given stack layout.
:remove (index) -> boolean Remove a widget from the layout.
:insert (index, widget) -> boolean Insert a new widget in the layout at position index.
:remove_widgets (...) -> boolean Remove one or more widgets from the layout.
:add_at (widget, point) Add a widget at a specific point.
:move (index, point) Move a widget (by index).
:move_widget (widget, point) Move a widget.
:set (index, widget2) -> boolean Set a widget at a specific index, replacing the current one.
:replace_widget (widget, widget2[, recursive=false]) -> boolean Replace the first instance of widget in the layout with widget2.
:swap (index1, index2) -> boolean Swap 2 widgets in a layout.
:swap_widgets (widget1, widget2[, recursive=false]) -> boolean Swap 2 widgets in a layout.
:reset () Reset the layout.
: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

Object properties

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

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.layout.manual (...)
Create a manual layout.

Parameters:

  • ... table Widgets to add to the layout.

Object methods

:add (...)
Add some widgets to the given stack layout.

Parameters:

  • ... widget Widgets that should be added
:remove (index) -> boolean
Remove a widget from the layout.

Parameters:

  • index number The widget index to remove

Returns:

    boolean index If the operation is successful
:insert (index, widget) -> boolean · 1 signal
Insert a new widget in the layout at position index.

Parameters:

  • index number The position
  • widget widget The widget

Returns:

    boolean If the operation is successful.

Click to display more

Emit signals:

  • widget::inserted
    • self widget The fixed layout.
    • widget widget index The inserted widget.
    • count number The widget count.
:remove_widgets (...) -> boolean
Remove one or more widgets from the layout.

The last parameter can be a boolean, forcing a recursive seach of the widget(s) to remove.

Parameters:

  • ... widget Widgets that should be removed (must at least be one)

Returns:

    boolean If the operation is successful
:add_at (widget, point)
Add a widget at a specific point.

The point can either be a function or a table. The table follow the generic geometry format used elsewhere in Awesome.

  • x: The horizontal position.
  • y: The vertical position.
  • width: The width.
  • height: The height.

If a function is used, it follows the same prototype as awful.placement functions.

  • geo:
    • x: The horizontal position (always 0).
    • y: The vertical position (always 0).
    • width: The width.
    • height: The height.
    • geometry: A function to get or set the geometry (for compatibility). The function is compatible with the awful.placement prototype.
  • args:
    • parent The layout own geometry
      • x: The horizontal position (always 0).
      • y: The vertical position (always 0).
      • width: The width.
      • height: The height.
      • geometry: A function to get or set the geometry (for compatibility) The function is compatible with the awful.placement prototype.

Usage example

Parameters:

  • widget widget The widget.
  • point table or function Either an {x=x,y=y} table or a function returning the new geometry.

Usage:

    local l = wibox.layout {
    layout  = wibox.layout.manual
}
--
-- Option 1: Set the point directly in the widget
local w1        = generic_widget()
w1.point        = {x=75, y=5}
w1.text         = "first"
w1.forced_width = 50
l:add(w1)
--
-- Option 2: Set the point directly in the widget as a function
local w2  = generic_widget()
w2.text   = "second"
w2.point  = function(geo, args)
    return {
        x = args.parent.width  - geo.width,
        y = 0
    }
end
l:add(w2)
--
-- Option 3: Set the point directly in the widget as an awful.placement
-- function.
local w3 = generic_widget()
w3.text  = "third"
w3.point = awful.placement.bottom_right
l:add(w3)
--
-- Option 4: Use :add_at instead of using the .point property. This works
-- with all 3 ways to define the point.
-- function.
local w4 = generic_widget()
w4.text  = "fourth"
l:add_at(w4, awful.placement.centered + awful.placement.maximize_horizontally)
:move (index, point)
Move a widget (by index).

Parameters:

  • index number The widget index.
  • point table or function A new point value.

See also:

:move_widget (widget, point)
Move a widget.

Usage example

Parameters:

  • widget widget The widget.
  • point table or function A new point value.

See also:

Usage:

    local l = wibox.layout {
    layout  = wibox.layout.manual
}
--
local w1        = generic_widget()
w1.point        = {x=75, y=5}
w1.text         = "first"
w1.forced_width = 50
l:add(w1)
l:move_widget(w1, awful.placement.bottom_right)
:set (index, widget2) -> boolean · 1 signal
Set a widget at a specific index, replacing the current one.

Parameters:

  • index number A widget or a widget index
  • widget2 widget The widget to replace the previous one with

Returns:

    boolean Returns true if the widget was replaced successfully, false otherwise.

Click to display more

Emit signals:

  • widget::replaced
    • self widget The layout.
    • widget widget The inserted widget.
    • previous widget The previous widget.
    • index number The replaced index.
:replace_widget (widget, widget2[, recursive=false]) -> boolean · 1 signal
Replace the first instance of widget in the layout with widget2.

Parameters:

  • widget widget The widget to replace
  • widget2 widget The widget to replace widget with
  • recursive boolean Recurse into all compatible layouts to find the widget. (default false)

Returns:

    boolean Returns true if the widget was replaced successfully, false otherwise.

Click to display more

Emit signals:

  • widget::replaced
    • self widget The layout.
    • widget widget index The inserted widget.
    • previous widget The previous widget.
    • index number The replaced index.
:swap (index1, index2) -> boolean · 1 signal
Swap 2 widgets in a layout.

Parameters:

  • index1 number The first widget index
  • index2 number The second widget index

Returns:

    boolean Returns true if the widget was replaced successfully, false otherwise.

Click to display more

Emit signals:

  • widget::swapped
    • self widget The layout.
    • widget1 widget The first widget.
    • widget2 widget The second widget.
    • index1 number The first index.
    • index1 number The second index.
:swap_widgets (widget1, widget2[, recursive=false]) -> boolean · 1 signal
Swap 2 widgets in a layout.

If widget1 is present multiple time, only the first instance is swapped.

Calls set internally, so the signal widget::replaced is emitted for both widgets as well.

Parameters:

  • widget1 widget The first widget
  • widget2 widget The second widget
  • recursive boolean Recurse into all compatible layouts to find the widget. (default false)

Returns:

    boolean Returns true if the widget was replaced successfully, false otherwise.

See also:


Click to display more

Emit signals:

  • widget::swapped
    • self widget The layout.
    • widget1 widget The first widget.
    • widget2 widget The second widget.
    • index1 number The first index.
    • index1 number The second index.
:reset () · 1 signal
Reset the layout. This removes all widgets from the layout.
Click to display more

Emit signals:

  • widget::reset
    • self widget The layout.
: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:

  1. 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.
  2. 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).
  3. 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:

  1. number The widget index.
  2. widget The parent widget.
  3. 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, 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 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()

Object properties

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)
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)
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:

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:

generated by LDoc 1.4.6 Last updated 2021-11-13 00:35:50