Class wibox.container.place

A container used to place smaller widgets into larger space.

Usage example

Info:

  • Copyright: 2016 Emmanuel Lepage Vallee
  • Release: master-g790a669
  • Author: Emmanuel Lepage Vallee <[email protected]>

Functions

wibox.container.place ([widget[, halign="center"[, valign="center"]]]) Returns a new place container.

Object properties

wibox.container.place.widget The widget to be placed.
wibox.container.place.valign The vertical alignment.
wibox.container.place.halign The horizontal alignment.
wibox.container.place.fill_vertical Fill the vertical space.
wibox.container.place.fill_horizontal Fill the horizontal space.
wibox.container.place.content_fill_vertical Stretch the contained widget so it takes all the vertical space.
wibox.container.place.content_fill_horizontal Stretch the contained widget so it takes all the horizontal space.
wibox.container.place.forced_height Force a widget height.
wibox.container.place.forced_width Force a widget width.
wibox.container.place.opacity The widget opacity (transparency).
wibox.container.place.visible The widget visibility.

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.

Methods

wibox.container.place:get_children () Get the number of children element
wibox.container.place:set_children (children) Replace the layout children This layout only accept one children, all others will be ignored
wibox.container.place:reset () Reset this layout.
wibox.container.place:index (widget[, recursive[, ...]]) Get a widget index.
wibox.container.place:get_all_children () Get all direct and indirect children widgets.
wibox.container.place:setup (args) Set a declarative widget hierarchy description.
wibox.container.place:buttons (_buttons) Set/get a widget’s buttons.
wibox.container.place:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
wibox.container.place:disconnect_signal (name, func) Disconnect to a signal.
wibox.container.place:emit_signal (name, ...) Emit a signal.
wibox.container.place:connect_signal (name, func) Connect to a signal.
wibox.container.place:weak_connect_signal (name, func) Connect to a signal weakly.


Functions

Methods
wibox.container.place ([widget[, halign="center"[, valign="center"]]])
Returns a new place container.
  • widget The widget to display. (optional)
  • halign string The horizontal alignment (default "center")
  • valign string The vertical alignment (default "center")

Returns:

    table A new place container.

Object properties

wibox.container.place.widget
The widget to be placed.

Type:

wibox.container.place.valign

The vertical alignment.

Possible values are:

  • top
  • center (default)
  • bottom

Type:

  • string (default "center")
wibox.container.place.halign

The horizontal alignment.

Possible values are:

  • left
  • center (default)
  • right

Type:

  • string (default "center")
wibox.container.place.fill_vertical
Fill the vertical space.

Type:

  • boolean (default false)
wibox.container.place.fill_horizontal
Fill the horizontal space.

Type:

  • boolean (default false)
wibox.container.place.content_fill_vertical
Stretch the contained widget so it takes all the vertical space.

Type:

  • boolean (default false)
wibox.container.place.content_fill_horizontal
Stretch the contained widget so it takes all the horizontal space.

Type:

  • boolean (default false)
wibox.container.place.forced_height
Force a widget height.

Type:

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

Type:

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

Type:

  • opacity number The opacity (between 0 and 1) (default 1)
wibox.container.place.visible
The widget visibility.

Type:

  • boolean

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:

Methods

wibox.container.place:get_children ()
Get the number of children element

Returns:

    table The children
wibox.container.place:set_children (children)
Replace the layout children This layout only accept one children, all others will be ignored
  • children table A table composed of valid widgets
wibox.container.place:reset ()
Reset this layout. The widget will be removed and the rotation reset.
wibox.container.place:index (widget[, recursive[, ...]])
Get a widget index.
  • widget The widget to look for
  • recursive Also check sub-widgets (optional)
  • ... Additional widgets to add at the end of the path (optional)

Returns:

  1. The index
  2. The parent layout
  3. The path between self and widget
wibox.container.place:get_all_children ()
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.

Returns:

    table The children
wibox.container.place:setup (args)
Set a declarative widget hierarchy description. See The declarative layout system
  • args An array containing the widgets disposition
wibox.container.place:buttons (_buttons)
Set/get a widget’s buttons.
  • _buttons The table of buttons that should bind to the widget.
wibox.container.place: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.
  • signal_name string
  • ... Other arguments
wibox.container.place:disconnect_signal (name, func)
Disconnect to a signal.
  • name string The name of the signal
  • func function The callback that should be disconnected
wibox.container.place:emit_signal (name, ...)
Emit a signal.
  • 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()
wibox.container.place:connect_signal (name, func)
Connect to a signal.
  • name string The name of the signal
  • func function The callback to call when the signal is emitted
wibox.container.place: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.

  • name string The name of the signal
  • func function The callback to call when the signal is emitted
generated by LDoc 1.4.6 Last updated 2017-09-11 12:23:44