Module: wibox.layout.flex

Usage example

Usage:

    wibox.widget {
        generic_widget( 'first'  ),
        generic_widget( 'second' ),
        generic_widget( 'third'  ),
        layout  = wibox.layout.flex.horizontal
    }
    

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Constructors

wibox.layout.flex.horizontal (...) Returns a new horizontal flex layout.
wibox.layout.flex.vertical (...) Returns a new vertical flex layout.

Functions

wibox.layout.flex.add_button (button) Add a new awful.button to this widget.

Object properties

children layout Get all direct children of this layout.
spacing_widget widget The widget used to fill the spacing between the layout elements.
spacing number Add spacing between each layout widgets.
max_widget_size number Set the maximum size the widgets in this layout will take.
children table Get or set the children elements.
all_children table Get all direct and indirect children widgets.
forced_height number or nil Force a widget height.
forced_width number or nil Force a widget width.
opacity number The widget opacity (transparency).
visible boolean The widget visibility.
buttons table The widget buttons.

Object methods

:set (index, widget2) Set a widget at a specific index, replace the current one.
:replace_widget (widget, widget2[, recursive=false]) Replace the first instance of widget in the layout with widget2.
:swap (index1, index2) Swap 2 widgets in a layout.
:swap_widgets (widget1, widget2[, recursive=false]) Swap 2 widgets in a layout.
:reset (layout) Reset a ratio layout.
:add (layout, ...) Add some widgets to the given fixed layout
:remove (The) Remove a widget from the layout
:remove_widgets (widget) 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.
:insert (index, widget) Insert a new widget in the layout at position index
:setup {[args]} Set a declarative widget hierarchy description.
:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
:emit_signal (name, ...) Emit a signal.
:connect_signal (name, func) Connect to a signal.
:weak_connect_signal (name, func) Connect to a signal weakly.

Signals

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


Constructors

wibox.layout.flex.horizontal (...)
Returns a new horizontal flex layout. A flex layout shares the available space equally among all widgets. Widgets can be added via :add(widget).

Parameters:

  • ... widget Widgets that should be added to the layout.
wibox.layout.flex.vertical (...)
Returns a new vertical flex layout. A flex layout shares the available space equally among all widgets. Widgets can be added via :add(widget).

Parameters:

  • ... widget Widgets that should be added to the layout.

Functions

wibox.layout.flex.add_button (button)
Add a new awful.button to this widget.

Parameters:

  • button awful.button The button to add.

Object properties

children (layout)
Get all direct children of this layout.

Type constraints:

  • layout The layout you are modifying.
spacing_widget (widget)
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.flex.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.flex.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.flex.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.flex.horizontal
    }
spacing (number)
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*5,
            layout  = wibox.layout.flex.horizontal
        }
    end
max_widget_size (number)
Set the maximum size the widgets in this layout will take. That is, maximum width for horizontal and maximum height for vertical.
children (table)
Get or set the children elements.

Type constraints:

all_children (table)
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:

forced_height (number or nil)
Force a widget height.

Type constraints:

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

Type constraints:

  • width number or nil The width (nil for automatic)
opacity (number)
The widget opacity (transparency).

Type constraints:

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

The table contains a list of awful.button objects.

See also:

Object methods

:set (index, widget2)
Set a widget at a specific index, replace the current one. Signal: widget::replaced The argument is the new widget and the old one and the index.

Parameters:

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

Returns:

    boolean If the operation is successful
:replace_widget (widget, widget2[, recursive=false])
Replace the first instance of widget in the layout with widget2. Signal: widget::replaced The argument is the new widget and the old one and the index.

Parameters:

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

Returns:

    boolean If the operation is successful
:swap (index1, index2)
Swap 2 widgets in a layout. Signal: widget::swapped The arguments are both widgets and both (new) indexes.

Parameters:

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

Returns:

    boolean If the operation is successful
:swap_widgets (widget1, widget2[, recursive=false])
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 The first widget
  • widget2 The second widget
  • recursive boolean Dig in all compatible layouts to find the widget. (default false)

Returns:

    boolean If the operation is successful
:reset (layout)
Reset a ratio layout. This removes all widgets from the layout. Signal: widget::reset

Parameters:

  • layout The layout you are modifying.
:add (layout, ...)
Add some widgets to the given fixed layout

Parameters:

  • layout The layout you are modifying.
  • ... widget Widgets that should be added (must at least be one)
:remove (The)
Remove a widget from the layout

Parameters:

  • The index widget index to remove

Returns:

    boolean index If the operation is successful
:remove_widgets (widget)
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
:insert (index, widget)
Insert a new widget in the layout at position index

Parameters:

  • index number The position
  • widget The widget

Returns:

    boolean If the operation is successful
:setup {[args]}
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
:emit_signal_recursive (signal_name, ...)
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, ...)
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)
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)
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
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
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
When a mouse button is pressed over the widget.

Arguments:

  • 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
When a mouse button is released over the widget.

Arguments:

  • 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
When the mouse enter a widget.

Arguments:

  • 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
When the mouse leave a widget.

Arguments:

  • 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