Module: awful.widget.layoutbox

Display the current client layout (awful.layout) icon or name.

Usage example

local s = screen[1]

local mylayoutbox = awful.widget.layoutbox {
    screen = s,
    -- Add buttons, allowing you to change the layout
    buttons = {
        awful.button({ }, 1, function () awful.layout.inc( 1) end),
        awful.button({ }, 3, function () awful.layout.inc(-1) end),
        awful.button({ }, 4, function () awful.layout.inc( 1) end),
        awful.button({ }, 5, function () awful.layout.inc(-1) end),
    }
}

wb:setup {
    layout = wibox.layout.align.horizontal,
    { -- Left widgets
        mytaglist,
        layout = wibox.layout.fixed.horizontal,
    },
    mytasklist, -- Middle widget
    { -- Right widgets
        layout = wibox.layout.fixed.horizontal,
        mykeyboardlayout,
        mytextclock,
        mylayoutbox,
    },
}

Class Hierarchy

Info:

Functions

layoutbox.new (args) Create a layoutbox widget.

Object properties

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
spacing_widget widget The widget used to fill the spacing between the layout elements. Inherited from wibox.layout.fixed
fill_space boolean Set the layout’s fill_space property. Inherited from wibox.layout.fixed
spacing number Add spacing between each layout widgets. Inherited from wibox.layout.fixed
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

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
:add (...) Add some widgets to the given layout. Inherited from wibox.layout.fixed
:remove (index) -> boolean Remove a widget from the layout. Inherited from wibox.layout.fixed
:remove_widgets (...) -> boolean Remove one or more widgets from the layout. Inherited from wibox.layout.fixed
:replace_widget (widget, widget2[, recursive=false]) -> boolean Replace the first instance of widget in the layout with widget2. Inherited from wibox.layout.fixed
:insert (index, widget) -> boolean Insert a new widget in the layout at position index. Inherited from wibox.layout.fixed
:set (index, widget2) -> boolean Set a widget at a specific index, replace the current one. Inherited from wibox.layout.fixed
:swap (index1, index2) -> boolean Swap 2 widgets in a layout. Inherited from wibox.layout.fixed
:swap_widgets (widget1, widget2[, recursive=false]) -> boolean Swap 2 widgets in a layout. Inherited from wibox.layout.fixed
:reset () Reset the layout. Inherited from wibox.layout.fixed
: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
:disconnect_signal (name, func) Disonnect from a signal. 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


Functions

layoutbox.new (args)
Create a layoutbox widget. It draws a picture with the current layout symbol of the current tag.

Parameters:

  • args The arguments.
    • screen screen The screen number that the layout will be represented for.
    • buttons table The awful.buttons for this layoutbox.

Returns:

    The layoutbox.

Object properties

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:

spacing_widget widget · Inherited from wibox.layout.fixed · 1 signal
The widget used to fill the spacing between the layout elements.

By default, no widget is used.

Usage example

Usage:

    -- Use the separator widget directly
    local w1 = wibox.widget {
        spacing        = 10,
        spacing_widget = wibox.widget.separator,
        layout         = wibox.layout.fixed.horizontal
    }
    -- Use a standard declarative widget construct
    local w2 = wibox.widget {
        spacing = 10,
        spacing_widget = {
            color  = '#00ff00',
            shape  = gears.shape.circle,
            widget = wibox.widget.separator,
        },
        layout = wibox.layout.fixed.horizontal
    }
    -- Use composed widgets
    local w3 = wibox.widget {
        spacing = 10,
        spacing_widget = {
            {
                text   = 'F',
                widget = wibox.widget.textbox,
            },
            bg     = '#ff0000',
            widget = wibox.container.background,
        },
        layout = wibox.layout.fixed.horizontal
    }
    -- Use negative spacing to create a powerline effect
    local w4 = wibox.widget {
        spacing = -12,
        spacing_widget = {
            color  = '#ff0000',
            shape  = gears.shape.powerline,
            widget = wibox.widget.separator,
        },
        layout = wibox.layout.fixed.horizontal
    }

Click to display more

Emit signals:

  • property::spacing_widget When the spacing_widget value changes.
    • self wibox.layout.fixed The object which changed (useful when connecting many object to the same callback).
    • new_value spacing_widget The new value affected to the property.
fill_space boolean · Inherited from wibox.layout.fixed · 1 signal
Set the layout’s fill_space property. If this property is true, the last widget will get all the space that is left. If this is false, the last widget won’t be handled specially and there can be space left unused.
Click to display more

Emit signals:

  • property::fill_space When the fill_space value changes.
    • self wibox.layout.fixed The object which changed (useful when connecting many object to the same callback).
    • new_value fill_space The new value affected to the property.
spacing number · Inherited from wibox.layout.fixed · 1 signal
Add spacing between each layout widgets.

Usage example

Type constraints:

  • spacing number Spacing between widgets.

Usage:

    for i=1, 5 do
        local w = wibox.widget {
            first,
            second,
            third,
            spacing = i*3,
            layout  = wibox.layout.fixed.horizontal
        }
    end

Click to display more

Emit signals:

  • property::spacing When the spacing value changes.
    • self wibox.layout.fixed The object which changed (useful when connecting many object to the same callback).
    • new_value spacing The new value affected to the property.
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:

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.
:add (...) · Inherited from wibox.layout.fixed
Add some widgets to the given layout.

Parameters:

  • ... widget Widgets that should be added (must at least be one).
:remove (index) -> boolean · Inherited from wibox.layout.fixed
Remove a widget from the layout.

Parameters:

  • index number The widget index to remove

Returns:

    boolean index If the operation is successful
:remove_widgets (...) -> boolean · Inherited from wibox.layout.fixed
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
:replace_widget (widget, widget2[, recursive=false]) -> boolean · Inherited from wibox.layout.fixed
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 Digg in all compatible layouts to find the widget. (default false)

Returns:

    boolean If the operation is successful
:insert (index, widget) -> boolean · Inherited from wibox.layout.fixed · 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.
:set (index, widget2) -> boolean · Inherited from wibox.layout.fixed · 1 signal
Set a widget at a specific index, replace the current one.

Parameters:

  • index number A widget or a widget index
  • widget2 widget The widget to take the place of the first one

Returns:

    boolean If the operation is successful

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 · Inherited from wibox.layout.fixed · 1 signal
Swap 2 widgets in a layout.

Parameters:

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

Returns:

    boolean If the operation is successful

Click to display more

Emit signals:

  • widget::swapped
    • self widget The layout.
    • widget1 widget index The first widget.
    • widget2 widget index The second widget.
    • index1 number The first index.
    • index1 number The second index.
:swap_widgets (widget1, widget2[, recursive=false]) -> boolean · Inherited from wibox.layout.fixed · 1 signal
Swap 2 widgets in a layout. If widget1 is present multiple time, only the first instance is swapped Signal: widget::swapped The arguments are both widgets and both (new) indexes. if the layouts not the same, then only widget::replaced will be emitted.

Parameters:

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

Returns:

    boolean If the operation is successful

Click to display more

Emit signals:

  • widget::swapped
    • self widget The layout.
    • widget1 widget index The first widget.
    • widget2 widget index The second widget.
    • index1 number The first index.
    • index1 number The second index.
:reset () · Inherited from wibox.layout.fixed · 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”.
: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.

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:

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