Module: `wibox.container.margin`

Add a margin around a widget.

Class Hierarchy

gears.object
- wibox.widget.base
- - wibox.container.margin

Info:

Copyright: 2010 Uli Schlachter
Originally authored by: Uli Schlachter
(Full contributors list available on our github project)

Constructors

wibox.container.margin (widget, left, right, top, bottom, color, draw_empty)

Returns a new margin container.

Object properties

widget	widget or nil	The widget to be wrapped by the margins.
margins	number or table	Set all the margins to val.
color	color or nil	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.base
all_children	table	Get all direct and indirect children widgets.	Inherited from wibox.widget.base
forced_height	number or nil	Force a widget height.	Inherited from wibox.widget.base
forced_width	number or nil	Force a widget width.	Inherited from wibox.widget.base
opacity	number	The widget opacity (transparency).	Inherited from wibox.widget.base
visible	boolean	The widget visibility.	Inherited from wibox.widget.base
buttons	table	The widget buttons.	Inherited from wibox.widget.base

Object methods

:reset ()	Reset this layout.
:add_button (button)	Add a new awful.button to this widget.	Inherited from wibox.widget.base
:emit_signal_recursive (signal_name, ...)	Emit a signal and ensure all parent widgets in the hierarchies also forward the signal.	Inherited from wibox.widget.base
:index (widget, recursive, ...) -> (number, widget, table)	Get the index of a widget.	Inherited from wibox.widget.base
: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
:disconnect_signal (name, func)	Disconnect from a signal.	Inherited from gears.object
:emit_signal (name, ...)	Emit a signal.	Inherited from gears.object

Signals

widget::layout_changed	When the layout (size) change.	Inherited from wibox.widget.base
widget::redraw_needed	When the widget content changed.	Inherited from wibox.widget.base
button::press	When a mouse button is pressed over the widget.	Inherited from wibox.widget.base
button::release	When a mouse button is released over the widget.	Inherited from wibox.widget.base
mouse::enter	When the mouse enter a widget.	Inherited from wibox.widget.base
mouse::leave	When the mouse leave a widget.	Inherited from wibox.widget.base

Constructors

🔗 wibox.container.margin (widget, left, right, top, bottom, color, draw_empty)

Returns a new margin container.

Parameters:

Name		Type(s)	Description
widget	Optional	widget	A widget to use.
left	Optional	number	A margin to use on the left side of the widget.
right	Optional	number	A margin to use on the right side of the widget.
top	Optional	number	A margin to use on the top side of the widget.
bottom	Optional	number	A margin to use on the bottom side of the widget.
color	Optional	gears.color	A color for the margins.
draw_empty	Optional	boolean	Whether or not to draw the margin when the content is empty

Returns:

table

Object properties

🔗 widget widget or nil

The widget to be wrapped by the margins.

Constraints:

Default value : nil

🔗 margins number or table · 1 signal

Set all the margins to val.

Constraints:

Default value	: `0`
Type description:
number	: A single value for all margins.
table:	: A different value for each side.
left (number)
right (number)
top (number)
bottom (number)
Unit	: pixel
Negative allowed	: false

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 or nil · 1 signal

Set the margins color to create a border.

Constraints:

Default value	: `nil`
Type description:
nil	: Transparent margins.
string	: An hexadecimal color code, such as `"#ff0000"` for red.
string	: A color name, such as `"red"`.
table	: A gradient table.
cairo.pattern	: Any valid Cairo pattern.
cairo.pattern	: A texture build from an image by gears.color.create_png_pattern
Valid values	: 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.

Constraints:

Default value	: `true`
Valid values	: Draw nothing is content is `0x0` or draw the margin anyway.

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.

Constraints:

Default value	: `0`
Unit	: pixel
Negative allowed	: false

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.

Constraints:

Default value	: `0`
Unit	: pixel
Negative allowed	: false

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.

Constraints:

Default value	: `0`
Unit	: pixel
Negative allowed	: false

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.

Constraints:

Default value	: `0`
Unit	: pixel
Negative allowed	: false

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.base

Get or set the children elements.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `{}`
Table content	: A list of wibox.widget.

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the height. Usually using the widget native height.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `nil`
Type description:
nil	: Let the layout decide the width. Usually using the widget native width.
number	: Enforce a number of pixels.
Unit	: pixel
Negative allowed	: false

Constraints:

Default value	: `1.0`
Unit	: A gradient between transparent (`0.0`) and opaque (`1.0`).
Minimum value	: 0.0
Maximum value	: 1.0

Constraints:

Default value	: `true`
Valid values	: `true` or `false`.

Constraints:

Default value	: `{}`
Table content	: A list of awful.button.

Object methods

🔗 :reset ()

Reset this layout. The widget will be unreferenced, the margins set to 0 and the color erased

🔗 :add_button (button) · Inherited from wibox.widget.base

Add a new awful.button to this widget.

Parameters:

Name		Type(s)	Description
button		awful.button	The button to add.

🔗 :emit_signal_recursive (signal_name, ...) · Inherited from wibox.widget.base

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.

Note that this function has some flaws:

The signal is only forwarded once the widget tree has been built. This happens after all currently scheduled functions have been executed. Therefore, it will not start to work right away.
In case the widget is present multiple times in a single widget tree, this function will also forward the signal multiple times (once per upward tree path).
If the widget is removed from the widget tree, the signal is still forwarded for some time, similar to the first case.

Parameters:

Name		Type(s)	Description
signal_name		string
...			Other arguments

🔗 :index (widget, recursive, ...) -> (number, widget, table) · Inherited from wibox.widget.base

Get the index of a widget.

Parameters:

Name		Type(s)	Description
widget		widget	The widget to look for.
recursive	Optional	boolean	Recursively check accross the sub-widgets hierarchy.
...	Optional	widget	Additional widgets to add at the end of the sub-widgets hierarchy "path".

Returns:

number The widget index.
widget The parent widget.
table The hierarchy path between "self" and "widget".

🔗 :connect_signal (name, func) · Inherited from gears.object

Connect to a signal.

Usage example output:

In slot [obj]   nil nil nil
In slot [obj]   foo bar 42

Parameters:

Name		Type(s)	Description
name		string	The name of the signal.
func		function	The callback to call when the signal is emitted.

Usage:

local o = gears.object{}
-- Function can be attached to signals
local function slot(obj, a, b, c)
    print("In slot", obj, a, b, c)
end
o:connect_signal("my_signal", slot)
-- Emitting can be done without arguments. In that case, the object will be
-- implicitly added as an argument.
o:emit_signal "my_signal"
-- It is also possible to add as many random arguments are required.
o:emit_signal("my_signal", "foo", "bar", 42)
-- Finally, to allow the object to be garbage collected (the memory freed), it
-- is necessary to disconnect the signal or use weak_connect_signal
o:disconnect_signal("my_signal", slot)
-- This time, the slot wont be called as it is no longer connected.
o:emit_signal "my_signal"

🔗 :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		Type(s)	Description
name		string	The name of the signal.
func		function	The callback to call when the signal is emitted.

🔗 :disconnect_signal (name, func) · Inherited from gears.object

Disconnect from a signal.

Parameters:

Name		Type(s)	Description
name		string	The name of the signal.
func		function	The callback that should be disconnected.

🔗 :emit_signal (name, ...) · Inherited from gears.object

Emit a signal.

Parameters:

Name		Type(s)	Description
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()

Signals

🔗 widget::layout_changed · Inherited from wibox.widget.base

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.

Arguments:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
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	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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.

Arguments:

Name	Type(s)	Description
self	table	The current object instance itself.
find_widgets_result	table	The entry from the result of wibox: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.

awesome

Contents

Widget containers

Core components

Input handling

Declarative rules

Widgets

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.container.margin

Class Hierarchy

Info:

Constructors

Object properties

Object methods

Signals

Constructors

Parameters:

Returns:

Object properties

Constraints:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

Emit signals:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `wibox.container.margin`