Class wibox.container.constraint

Info:
- Copyright: 2012 Lukáš Hrázký
- Author: Lukáš Hrázký
Functions
-
constraint:get_children ()
-
Get the number of children element
Returns:
table
The children
-
constraint: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
-
constraint:reset ()
-
Reset this layout. The widget will be unreferenced, strategy set to "max"
and the constraints set to nil.
-
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.
- widget
A widget to use.
- strategy
How to constraint the size. 'max' (default), 'min' or
'exact'.
- width
The maximum width of the widget. nil for no limit.
- height
The maximum height of the widget. nil for no limit.
Returns:
table
A new constraint container
Object properties
-
wibox.container.constraint.widget
-
The widget to be constrained.
Type:
-
wibox.container.constraint.strategy
-
Set the strategy to use for the constraining. Valid values are 'max',
'min' or 'exact'. Throws an error on invalid values.
-
wibox.container.constraint.height
-
Set the maximum width to val. nil for no width limit.
Type:
-
wibox.container.constraint.width
-
Set the maximum height to val. nil for no height limit.
Type:
-
wibox.container.constraint.forced_height
-
Force a widget height.
Type:
- height
number or nil
The height (
nil
for automatic)
-
wibox.container.constraint.forced_width
-
Force a widget width.
Type:
- width
number or nil
The width (
nil
for automatic)
-
wibox.container.constraint.opacity
-
The widget opacity (transparency).
Type:
- opacity
number
The opacity (between 0 and 1)
(default 1)
-
wibox.container.constraint.visible
-
The widget visibility.
Type:
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.constraint:index (widget[, recursive[, ...]])
-
Get a widex index.
- widget
The widget to look for
- recursive
Also check sub-widgets
- ...
Aditional widgets to add at the end of the \"path\"
Returns:
-
The index
-
The parent layout
-
The path between \"self\" and \"widget\"
-
wibox.container.constraint: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.constraint:setup (args)
-
Set a declarative widget hierarchy description.
See [The declarative layout system](../documentation/03-declarative-layout.md.html)
- args
An array containing the widgets disposition
-
wibox.container.constraint:buttons (_buttons)
-
Set/get a widget's buttons.
- _buttons
The table of buttons that should bind to the widget.
-
wibox.container.constraint: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.constraint: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.constraint: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.constraint: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.constraint: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