Module: `wibox.widget.systray`

Info:

Copyright: 2010 Uli Schlachter
Author: Uli Schlachter

Constructors

Create the systray widget.

Object properties

base_size	integer or nil	Set the size of a single icon.
horizontal	boolean	Decide between horizontal or vertical display.
reverse	boolean	Should the systray icons be displayed in reverse order?
screen	screen or "primary"	Set the screen that the systray should be displayed on.
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

: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

Theme variables

beautiful.bg_systray	string	The systray background color.
beautiful.systray_icon_spacing	integer	The systray icon spacing.

Constructors

wibox.widget.systray (revers)

Create the systray widget.

Note that this widget can only exist once.

Parameters:

revers boolean Show in the opposite direction

Returns:

table

systray

Object properties

base_size (integer or nil) · 1 signal

Set the size of a single icon.

If this is set to nil, then the size is picked dynamically based on the available space. Otherwise, any single icon has a size of sizexsize.

Type constraints:

size integer or nil The base size

Click to display more

Emit signals:

property::base_size When the base_size value changes.

self wibox.widget.systray The object which changed (useful when connecting many object to the same callback).
new_value size The new value affected to the property.

horizontal (boolean) · 1 signal

Decide between horizontal or vertical display.

Type constraints:

horiz boolean Use horizontal mode?

Click to display more

Emit signals:

property::horizontal When the horizontal value changes.

self wibox.widget.systray The object which changed (useful when connecting many object to the same callback).
new_value horiz The new value affected to the property.

reverse (boolean) · 1 signal

Should the systray icons be displayed in reverse order?

Type constraints:

rev boolean Display in reverse order.

Click to display more

Emit signals:

property::reverse When the reverse value changes.

self wibox.widget.systray The object which changed (useful when connecting many object to the same callback).
new_value rev The new value affected to the property.

screen (screen or "primary") · 1 signal

Set the screen that the systray should be displayed on.

This can either be a screen, in which case the systray will be displayed on exactly that screen, or the string "primary", in which case it will be visible on the primary screen. The default value is “primary”.

Type constraints:

s screen or "primary" The screen to display on.

Click to display more

Emit signals:

property::screen When the screen value changes.

self wibox.widget.systray The object which changed (useful when connecting many object to the same callback).
new_value s 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.

Object methods

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

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.

Theme variables

beautiful.bg_systray (string)

The systray background color.

Type constraints:

string The color (string like “#ff0000” only)

beautiful.systray_icon_spacing (integer)

The systray icon spacing.

Type constraints:

The integer icon spacing (default 0)

awesome

Contents

Widgets

Core components

Input handling

Declarative rules

Widget containers

Widget layouts

Popups and bars

Utility libraries

Theme related libraries

Libraries

Sample files

Classes

Documentation

Module: wibox.widget.systray

Info:

Constructors

Object properties

Object methods

Signals

Theme variables

Constructors

Parameters:

Returns:

Object properties

Type constraints:

Emit signals:

Type constraints:

Emit signals:

Type constraints:

Emit signals:

Type constraints:

Emit signals:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Theme variables

Type constraints:

Type constraints:

Module: `wibox.widget.systray`