Class wibox.container.margin

Usage example

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Functions

wibox.container.margin ([widget[, left[, right[, top[, bottom[, color[, draw_empty]]]]]]]) Returns a new margin container.

Object properties

wibox.container.margin.widget The widget to be wrapped the the margins.
wibox.container.margin.margins Set all the margins to val.
wibox.container.margin.color Set the margins color to create a border.
wibox.container.margin.left Set the left margin that this layout adds to its widget.
wibox.container.margin.right Set the right margin that this layout adds to its widget.
wibox.container.margin.top Set the top margin that this layout adds to its widget.
wibox.container.margin.bottom Set the bottom margin that this layout adds to its widget.
wibox.container.margin.forced_height Force a widget height.
wibox.container.margin.forced_width Force a widget width.
wibox.container.margin.opacity The widget opacity (transparency).
wibox.container.margin.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.margin:draw_empty (draw_empty) Draw the margin even if the content size is 0x0 (default: true)
wibox.container.margin:reset () Reset this layout.
wibox.container.margin:index (widget[, recursive[, ...]]) Get a widex index.
wibox.container.margin:get_all_children () Get all direct and indirect children widgets.
wibox.container.margin:setup (args) Set a declarative widget hierarchy description.
wibox.container.margin:buttons (_buttons) Set/get a widget’s buttons.
wibox.container.margin:emit_signal_recursive (signal_name, ...) Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.
wibox.container.margin:disconnect_signal (name, func) Disconnect to a signal.
wibox.container.margin:emit_signal (name, ...) Emit a signal.
wibox.container.margin:connect_signal (name, func) Connect to a signal.
wibox.container.margin:weak_connect_signal (name, func) Connect to a signal weakly.


Functions

Methods
wibox.container.margin ([widget[, left[, right[, top[, bottom[, color[, draw_empty]]]]]]])
Returns a new margin container.
  • widget A widget to use. (optional)
  • left A margin to use on the left side of the widget. (optional)
  • right A margin to use on the right side of the widget. (optional)
  • top A margin to use on the top side of the widget. (optional)
  • bottom A margin to use on the bottom side of the widget. (optional)
  • color A color for the margins. (optional)
  • draw_empty whether or not to draw the margin when the content is empty (optional)

Returns:

    table A new margin container

Object properties

wibox.container.margin.widget
The widget to be wrapped the the margins.

Type:

wibox.container.margin.margins
Set all the margins to val.

Type:

  • val number The margin value
wibox.container.margin.color
Set the margins color to create a border.

Type:

  • color A color used to fill the margin.
wibox.container.margin.left
Set the left margin that this layout adds to its widget.

Type:

  • margin The new margin to use.
wibox.container.margin.right
Set the right margin that this layout adds to its widget.

Type:

  • margin The new margin to use.
wibox.container.margin.top
Set the top margin that this layout adds to its widget.

Type:

  • margin The new margin to use.
wibox.container.margin.bottom
Set the bottom margin that this layout adds to its widget.

Type:

  • margin The new margin to use.
wibox.container.margin.forced_height
Force a widget height.

Type:

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

Type:

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

Type:

  • opacity number The opacity (between 0 and 1) (default 1)
wibox.container.margin.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.margin:draw_empty (draw_empty)
Draw the margin even if the content size is 0x0 (default: true)
  • draw_empty boolean Draw nothing is content is 0x0 or draw the margin anyway
wibox.container.margin:reset ()
Reset this layout. The widget will be unreferenced, the margins set to 0 and the color erased
wibox.container.margin:index (widget[, recursive[, ...]])
Get a widex index.
  • widget The widget to look for
  • recursive Also check sub-widgets (optional)
  • ... Aditional 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.margin: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.margin:setup (args)
Set a declarative widget hierarchy description. See The declarative layout system
  • args An array containing the widgets disposition
wibox.container.margin:buttons (_buttons)
Set/get a widget’s buttons.
  • _buttons The table of buttons that should bind to the widget.
wibox.container.margin: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.margin: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.margin: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.margin: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.margin: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-06-24 00:22:18