Module: wibox.container.margin

Add a margin around a widget.

Usage example

Info:

  • Copyright: 2010 Uli Schlachter
  • Author: Uli Schlachter

Constructors

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

Object properties

widget widget The widget to be wrapped the the margins.
margins number or table Set all the margins to val.
color color Set the margins color to create a border.
draw_empty boolean Draw the margin even if the content size is 0x0.
left number Set the left margin that this layout adds to its widget.
right number Set the right margin that this layout adds to its widget.
top number Set the top margin that this layout adds to its widget.
bottom number Set the bottom margin that this layout adds to its widget.
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

:reset () Reset this 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.container.margin ([widget[, left[, right[, top[, bottom[, color[, draw_empty]]]]]]])
Returns a new margin container.

Parameters:

  • 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

widget (widget)
The widget to be wrapped the the margins.

Type constraints:

margins (number or table) · 1 signal
Set all the margins to val.

Type constraints:

  • val number or table The margin value. It can be a number or a table with the left/right/top/bottom keys.

Click to display more

Emit signals:

  • property::margins When the margins value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
color (color) · 1 signal
Set the margins color to create a border.

Type constraints:

  • color A color used to fill the margin.

Click to display more

Emit signals:

  • property::color When the color value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
    • new_value color The new value affected to the property.
draw_empty (boolean) · 1 signal
Draw the margin even if the content size is 0x0.

Type constraints:

  • draw_empty boolean Draw nothing is content is 0x0 or draw the margin anyway. (default true)

Click to display more

Emit signals:

  • property::draw_empty When the draw_empty value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
    • new_value draw_empty The new value affected to the property.
left (number) · 1 signal
Set the left margin that this layout adds to its widget.

Type constraints:

  • left number The new margin to use.

Click to display more

Emit signals:

  • property::left When the left value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
    • new_value left The new value affected to the property.
right (number) · 1 signal
Set the right margin that this layout adds to its widget.

Type constraints:

  • right number The new margin to use.

Click to display more

Emit signals:

  • property::right When the right value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
    • new_value right The new value affected to the property.
top (number) · 1 signal
Set the top margin that this layout adds to its widget.

Type constraints:

  • top number The new margin to use.

Click to display more

Emit signals:

  • property::top When the top value changes.
    • self wibox.container.margin The object which changed (useful when connecting many object to the same callback).
    • new_value top The new value affected to the property.
bottom (number) · 1 signal
Set the bottom margin that this layout adds to its widget.

Type constraints:

  • bottom number The new margin to use.

Click to display more

Emit signals:

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

:reset ()
Reset this layout. The widget will be unreferenced, the margins set to 0 and the color erased
: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