Module: wibox.layout.stack

A stacked layout.

This layout display widgets on top of each other. It can be used to overlay a wibox.widget.textbox on top of a awful.widget.progressbar or manage “pages” where only one is visible at any given moment.

The indices are going from 1 (the bottom of the stack) up to the top of the stack. The order can be changed either using :swap or :raise.

Usage example

Usage:

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

Info:

  • Copyright: 2016 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee

Constructors

wibox.layout.stack () Create a new stack layout.

Object properties

spacing number Add spacing around the widget, similar to the margin container.
top_only boolean If only the first stack widget is drawn.
horizontal_offset number Add an horizontal offset to each layers.
vertial_offset number Add an vertical offset to each layers.
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

:add (...) Add some widgets to the given stack layout.
:remove (The) -> boolean Remove a widget from the layout.
:insert (index, widget) -> boolean Insert a new widget in the layout at position index.
:remove_widgets (widget) -> boolean Remove one or more widgets from the layout.
:raise (index) Raise a widget at index to the top of the stack.
:raise_widget (widget[, recursive=false]) Raise the first instance of widget.
: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.stack ()
Create a new stack layout.

Returns:

    widget A new stack layout

Object properties

spacing number · 1 signal
Add spacing around the widget, similar to the margin container.

Usage example

Type constraints:

  • spacing number Spacing between widgets.

Usage:

    wibox.widget {
        generic_widget( 'first'  ),
        generic_widget( 'second' ),
        generic_widget( 'third'  ),
        spacing = 6,
        layout  = wibox.layout.stack
    }

Click to display more

Emit signals:

  • property::spacing When the spacing value changes.
    • self wibox.layout.stack The object which changed (useful when connecting many object to the same callback).
    • new_value spacing The new value affected to the property.
top_only boolean · 1 signal
If only the first stack widget is drawn.
Click to display more

Emit signals:

  • property::top_only When the top_only value changes.
    • self wibox.layout.stack The object which changed (useful when connecting many object to the same callback).
    • new_value top_only The new value affected to the property.
horizontal_offset number · 1 signal
Add an horizontal offset to each layers.

Note that this reduces the overall size of each widgets by the sum of all layers offsets.

Usage example

See also:

Usage:

    wibox.widget {
        generic_widget( 'first'  ),
        generic_widget( 'second' ),
        generic_widget( 'third'  ),
        horizontal_offset = 5,
        vertical_offset   = 5,
        layout            = wibox.layout.stack
    }

Click to display more

Emit signals:

vertial_offset number · 1 signal
Add an vertical offset to each layers.

Note that this reduces the overall size of each widgets by the sum of all layers offsets.

See also:


Click to display more

Emit signals:

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

Object methods

:add (...)
Add some widgets to the given stack layout.

Parameters:

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

Parameters:

  • The index widget index to remove

Returns:

    boolean index If the operation is successful
:insert (index, widget) -> boolean · 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.
:remove_widgets (widget) -> boolean
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 widget … Widgets that should be removed (must at least be one)

Returns:

    boolean If the operation is successful
:raise (index)
Raise a widget at index to the top of the stack.

Parameters:

  • index number the widget index to raise
:raise_widget (widget[, recursive=false])
Raise the first instance of widget.

Parameters:

  • widget widget The widget to raise
  • recursive boolean Also look deeper in the hierarchy to find the widget (default false)
: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 with widget2.

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:

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