Module: `wibox.container.constraint`

Restrict a widget size using one of multiple available strategies.

Usage example

Class Hierarchy

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

Info:

Copyright: 2012 Lukáš Hrázký
Originally authored by: Lukáš Hrázký
(Full contributors list available on our github project)

Constructors

wibox.container.constraint ([widget[, strategy[, width[, height]]]])

Returns a new constraint container.

Object properties

widget	widget	The widget to be constrained.
strategy	string	Set the strategy to use for the constraining.
height	number	Set the maximum width to val.
width	number	Set the maximum height to val.
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)	Disonnect 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.constraint ([widget[, strategy[, width[, height]]]])

Returns a new constraint container.

This container will constraint the size of a widget according to the strategy. Note that this will only work for layouts that respect the widget's size, eg. fixed layout. In layouts that don't (fully) respect widget's requested size, the inner widget still might get drawn with a size that does not fit the constraint, eg. in flex layout.

Parameters:

widget A widget to use. (optional)
strategy How to constraint the size. 'max' (default), 'min' or 'exact'. (optional)
width The maximum width of the widget. nil for no limit. (optional)
height The maximum height of the widget. nil for no limit. (optional)

Returns:

table

Object properties

widget widget

The widget to be constrained.

Type constraints:

widget widget The widget

strategy string · 1 signal

Set the strategy to use for the constraining. Valid values are:

max: Never allow the size to be larger than the limit.
min: Never allow the size to tbe below the limit.
exact: Force the widget size.

Type constraints:

strategy string Either 'max', 'min' or 'exact'.

Click to display more

Emit signals:

property::strategy When the strategy value changes.

self wibox.container.constraint The object which changed (useful when connecting many object to the same callback).
new_value strategy The new value affected to the property.

height number · 1 signal

Set the maximum width to val. nil for no width limit.
Click to display more

Emit signals:

property::height When the height value changes.

self wibox.container.constraint The object which changed (useful when connecting many object to the same callback).
new_value height The new value affected to the property.

width number · 1 signal

Set the maximum height to val. nil for no height limit.
Click to display more

Emit signals:

property::width When the width value changes.

self wibox.container.constraint The object which changed (useful when connecting many object to the same callback).
new_value width The new value affected to the property.

children table · Inherited from wibox.widget.base

Get or set the children elements.

Type constraints:

children table The children.

all_children table · Inherited from wibox.widget.base

Get all direct and indirect children widgets. This will scan all containers recursively to find widgets Warning: This method it prone to stack overflow if there is a loop in the widgets hierarchy. A hierarchy loop is when a 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.base

Force a widget height.

Type constraints:

height number or nil The height (nil for automatic)

forced_width number or nil · Inherited from wibox.widget.base

Force a widget width.

Type constraints:

width number or nil The width (nil for automatic)

opacity number · Inherited from wibox.widget.base

The widget opacity (transparency).

Type constraints:

opacity number The opacity (between 0 and 1) (default 1)

visible boolean · Inherited from wibox.widget.base

The widget visibility.

buttons table · Inherited from wibox.widget.base

The widget buttons.

The table contains a list of awful.button objects.

Object methods

:reset ()

Reset this layout.

The widget will be unreferenced, strategy set to "max" and the constraints set to nil.

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

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

signal_name string
... Other arguments

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

Get the index of a widget.

Parameters:

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

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

Disonnect from a signal.

Parameters:

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 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:

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.

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.

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.

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.

awesome

Contents

Widget containers

Core components

Input handling

Declarative rules

Widgets

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Client tiling

Libraries

Sample files

Classes

Documentation

Module: wibox.container.constraint

Class Hierarchy

Info:

Constructors

Object properties

Object methods

Signals

Constructors

Parameters:

Returns:

Object properties

Type constraints:

Type constraints:

Emit signals:

Emit signals:

Emit signals:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type 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.constraint`