Class awful.widget.only_on_screen
A container that makes a widget display only on a specified screen.
Info:
- Copyright: 2017 Uli Schlachter
- Author: Uli Schlachter
Methods
-
wibox.container.only_on_screen ([widget[, s]])
-
Returns a new only_on_screen container.
This widget makes some other widget visible on just some screens. Use
:set_widget() to set the widget and :set_screen() to set the screen.
- widget
The widget to display.
(optional)
- s
The screen to display on.
(optional)
Returns:
table
A new only_on_screen container
-
widget
-
The widget to be displayed
Type:
-
screen
-
The screen to display on. Can be a screen object, a screen index, a screen
name (“VGA1”) or the string “primary” for the primary screen.
Type:
-
forced_height
-
Force a widget height.
Type:
- height
number or nil
The height (
nil for automatic)
-
forced_width
-
Force a widget width.
Type:
- width
number or nil
The width (
nil for automatic)
-
opacity
-
The widget opacity (transparency).
Type:
- opacity
number
The opacity (between 0 and 1)
(default 1)
-
visible
-
The widget visibility.
Type:
-
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:
-
awful.widget.only_on_screen:get_children ()
-
Get the number of children element
Returns:
table
The children
-
awful.widget.only_on_screen: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
-
awful.widget.only_on_screen: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
-
awful.widget.only_on_screen:setup (args)
-
Set a declarative widget hierarchy description.
See The declarative layout system
- args
An array containing the widgets disposition
-
awful.widget.only_on_screen:buttons (_buttons)
-
Set/get a widget’s buttons.
- _buttons
The table of buttons that should bind to the widget.
-
awful.widget.only_on_screen: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
-
awful.widget.only_on_screen: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().
-
awful.widget.only_on_screen: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.
-
awful.widget.only_on_screen: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.