Module: `wibox.layout.ratio`

A layout filling all the available space.

Each widget is assigned a ratio (percentage) of the total space. Multiple methods are available to ajust this ratio.

Usage example

Usage:

local w = wibox.widget {
    generic_widget( 'first'  ),
    generic_widget( 'second' ),
    generic_widget( 'third'  ),
    layout  = wibox.layout.ratio.horizontal
}
w:ajust_ratio(2, 0.44, 0.33, 0.22)

Info:

Copyright: 2016 Emmanuel Lepage Vallee
Author: Emmanuel Lepage Vallee

Constructors

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

Functions

wibox.layout.ratio.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.
inner_fill_strategy	string	Set how the space of invisible or `0x0` sized widget is redistributed.
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.
:inc_ratio (index, increment)	Increase the ratio of “widget”.
:inc_widget_ratio (widget, increment)	Increment the ratio of the first instance of `widget`.
:set_ratio (index, percent)	Set the ratio of the widget at position `index`.
:get_ratio (index)	Get the ratio at `index`.
:set_widget_ratio (widget, percent)	Set the ratio of `widget` to `percent`.
:ajust_ratio (index, before, itself, after)	Update all widgets to match a set of a ratio.
:ajust_widget_ratio (widget, before, itself, after)	Update all widgets to match a set of a ratio.
:add (...)	Add some widgets to the given fixed layout.
:remove (index)	Remove a widget from the layout.
: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.ratio.horizontal (...)

Returns a new horizontal ratio layout. A ratio 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.ratio.vertical (...)

Returns a new vertical ratio layout. A ratio 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.ratio.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.ratio.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.ratio.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.ratio.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.ratio.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*3,
        layout  = wibox.layout.ratio.horizontal
    }
end

inner_fill_strategy (string)

Set how the space of invisible or 0x0 sized widget is redistributed.

Possible values:

“default”: Honor the ratio and do not redistribute the space.
“justify”: Distribute the space among remaining widgets.
“center”: Squash remaining widgets and leave equal space on both side.
“inner_spacing”: Add equal spacing between all widgets.
“spacing”: Add equal spacing between all widgets and on the outside.
“left”: Squash remaining widgets and leave empty space on the left.
“right”: Squash remaining widgets and leave empty space on the right.

Usage example

Type constraints:

inner_fill_strategy string One of the value listed above.

children (table)

Get or set the children elements.

Type constraints:

The table children

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:

The table children

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.

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

: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

: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

: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

:reset (layout)

Reset a ratio layout. This removes all widgets from the layout. Signal: widget::reset

Parameters:

layout The layout you are modifying.

:inc_ratio (index, increment)

Increase the ratio of “widget”. If the increment produce an invalid ratio (not between 0 and 1), the method do nothing.

Usage example

Parameters:

index number The widget index to change
increment number An floating point value between -1 and 1 where the end result is within 0 and 1

Usage:

local ret = wibox.layout.fixed.vertical()
local w = wibox.widget {
    first,
    second,
    third,
    layout  = wibox.layout.ratio.horizontal
}
for i=1, 5 do
    w:inc_ratio(2, 0.1)
end

:inc_widget_ratio (widget, increment)

Increment the ratio of the first instance of widget. If the increment produce an invalid ratio (not between 0 and 1), the method do nothing.

Parameters:

widget The widget to ajust
increment number An floating point value between -1 and 1 where the end result is within 0 and 1

:set_ratio (index, percent)

Set the ratio of the widget at position index.

Parameters:

index number The index of the widget to change
percent number An floating point value between 0 and 1

:get_ratio (index)

Get the ratio at index.

Parameters:

index number The widget index to query

Returns:

number

:set_widget_ratio (widget, percent)

Set the ratio of widget to percent.

Parameters:

widget widget The widget to ajust.
percent number A floating point value between 0 and 1.

:ajust_ratio (index, before, itself, after)

Update all widgets to match a set of a ratio. The sum of before, itself and after must be 1 or nothing will be done.

Usage example

Parameters:

index number The index of the widget to change
before number The sum of the ratio before the widget
itself number The ratio for “widget”
after number The sum of the ratio after the widget

Usage:

local ret = wibox.layout.fixed.vertical()
local w = wibox.widget {
    first,
    second,
    third,
    layout  = wibox.layout.ratio.horizontal
}
local values = {
    {0.25, 0.50, 0.25},
    {0.33, 0.55, 0.12},
    {0.123, 0.456, 0.789},
    {0.123, 0, 0.789},
    {0, 1, 0},
}
for i=1, 5 do
    w:ajust_ratio(2, unpack(values[i]))
end

:ajust_widget_ratio (widget, before, itself, after)

Update all widgets to match a set of a ratio.

Parameters:

widget The widget to ajust
before number The sum of the ratio before the widget
itself number The ratio for “widget”
after number The sum of the ratio after the widget

:add (...)

Add some widgets to the given fixed layout.

Signal: widget::added The argument are the widgets

Parameters:

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

:remove (index)

Remove a widget from the layout.

Signal: widget::removed The arguments are the widget and the index

Parameters:

index number The widget index to remove

Returns:

boolean

:insert (index, widget)

Insert a new widget in the layout at position index. Signal: widget::inserted The arguments are the widget and the index

Parameters:

index number The position
widget The widget

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

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.

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.

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.

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.

awesome

Contents

Widget layouts

Core components

Input handling

Widgets

Widget containers

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.layout.ratio

Usage:

Info:

Constructors

Functions

Object properties

Object methods

Signals

Constructors

Parameters:

Parameters:

Functions

Parameters:

Object properties

Type constraints:

Usage:

Type constraints:

Usage:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `wibox.layout.ratio`