Module: `wibox.layout.align`

Usage example

Usage:

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

Info:

Copyright: 2010 Uli Schlachter
Author: Uli Schlachter

Constructors

wibox.layout.align.horizontal ([left[, middle[, right]]])	Returns a new horizontal align layout.
wibox.layout.align.vertical ([top[, middle[, bottom]]])	Returns a new vertical align layout.

Functions

wibox.layout.align.add_button (button)

Add a new awful.button to this widget.

Object properties

first	widget	Set the layout’s first widget.
second	widget	Set the layout’s second widget.
third	widget	Set the layout’s third widget.
children	table	All direct children of this layout.
expand	string	Set the expand mode which determines how sub widgets expand to take up unused space.
children	layout	Get all direct children of this layout.
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.
: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.align.horizontal ([left[, middle[, right]]])

Returns a new horizontal align layout. An align layout can display up to three widgets. The widget set via :set_left() is left-aligned. :set_right() sets a widget which will be right-aligned. The remaining space between those two will be given to the widget set via :set_middle().

Parameters:

left widget Widget to be put to the left. (optional)
middle widget Widget to be put to the middle. (optional)
right widget Widget to be put to the right. (optional)

wibox.layout.align.vertical ([top[, middle[, bottom]]])

Returns a new vertical align layout. An align layout can display up to three widgets. The widget set via :set_top() is top-aligned. :set_bottom() sets a widget which will be bottom-aligned. The remaining space between those two will be given to the widget set via :set_middle().

Parameters:

top widget Widget to be put to the top. (optional)
middle widget Widget to be put to the middle. (optional)
bottom widget Widget to be put to the right. (optional)

Functions

wibox.layout.align.add_button (button)

Add a new awful.button to this widget.

Parameters:

button awful.button The button to add.

Object properties

first (widget)

Set the layout’s first widget. This is the widget that is at the left/top

second (widget)

Set the layout’s second widget. This is the centered one.

third (widget)

Set the layout’s third widget. This is the widget that is at the right/bottom

children (table)

All direct children of this layout. This can be used to replace all 3 widgets at once.

expand (string)

Set the expand mode which determines how sub widgets expand to take up unused space.

Type constraints:

mode string
How to use unused space.
- “inside” - Default option. Size of outside widgets is determined using their fit function. Second, middle, or center widget expands to fill remaining space.
- “outside” - Center widget is sized using its fit function and placed in the center of the allowed space. Outside widgets expand (or contract) to fill remaining space on their side.
- “none” - All widgets are sized using their fit function, drawn to only the returned space, or remaining space, whichever is smaller. Center widget gets priority.
(default inside)

children (layout)

Get all direct children of this layout.

Type constraints:

layout The layout you are modifying.

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.

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

Usage:

Info:

Constructors

Functions

Object properties

Object methods

Signals

Constructors

Parameters:

Parameters:

Functions

Parameters:

Object properties

Type constraints:

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:

Parameters:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `wibox.layout.align`