Module: wibox.layout.align
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. |
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. | |
expand | string | Set the expand mode which determines how sub widgets expand to take up unused space. | |
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 |
Object methods
:set (index, widget2) -> boolean | Set a widget at a specific index, replace 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 a ratio layout. | |
: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 |
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 |
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)
Object properties
- first widget · 1 signal
-
Set the layout’s first widget.
This is the widget that is at the left/top
Click to display more Emit signals:
property::first
When the first value changes.self
wibox.layout.align The object which changed (useful when connecting many object to the same callback).new_value
first The new value affected to the property.
- second widget · 1 signal
-
Set the layout’s second widget. This is the centered one.
Click to display more Emit signals:
property::second
When the second value changes.self
wibox.layout.align The object which changed (useful when connecting many object to the same callback).new_value
second The new value affected to the property.
- third widget · 1 signal
-
Set the layout’s third widget.
This is the widget that is at the right/bottom
Click to display more Emit signals:
property::third
When the third value changes.self
wibox.layout.align The object which changed (useful when connecting many object to the same callback).new_value
third The new value affected to the property.
- expand string
-
Set the expand mode which determines how sub widgets expand to take up unused space.
The following values are valid:
- “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.
Type constraints:
- mode string How to use unused space. (default inside)
- 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)
- height
number or nil
The height (
- forced_width number or nil · Inherited from wibox.widget
-
Force a widget width.
Type constraints:
- width
number or nil
The width (
nil
for automatic)
- width
number or nil
The width (
- 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:
Object methods
- :set (index, widget2) -> boolean · 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.
- :replace_widget (widget, widget2[, recursive=false]) -> boolean · 1 signal
-
Replace the first instance of
widget
in the layout withwidget2
.Signal: widget::replaced The argument is the new widget and the old one and the index.
Parameters:
- widget widget The widget to replace
- widget2
widget
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
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
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 · 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 () · 1 signal
-
Reset a ratio layout. This removes all widgets from the layout.
Click to display more Emit signals:
widget::reset
self
widget
The layout.
- :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.
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: