Module: `wibox.container.scroll`

This container scrolls its inner widget inside of the available space.

An example usage would be a text widget that displays information about the currently playing song without using too much space for long song titles.

Please note that mouse events do not propagate to widgets inside of the scroll container. Also, if this widget is causing too high CPU usage, you can use set_fps to make it update less often.

Usage:

wibox.widget {
   layout = wibox.container.scroll.horizontal,
   max_size = 100,
   step_function = wibox.container.scroll.step_functions
                   .waiting_nonlinear_back_and_forth,
   speed = 100,
   {
       widget = wibox.widget.textbox,
       text = "This is a " .. string.rep("very, ", 10) ..  " very long text",
   },
}

Class Hierarchy

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

Info:

Copyright: 2015 Uli Schlachter
Originally authored by: Uli Schlachter (based on ideas from Saleur Geoffrey)
(Full contributors list available on our github project)

Constructors

wibox.container.scroll.horizontal ([widget[, fps=20[, speed=10[, extra_space=0[, expand=false[, max_size[, step_function=step_functions.linear_increase[, space_for_scrolling=2^1024]]]]]]]])	Get a new horizontal scrolling container.
wibox.container.scroll.vertical ([widget[, fps=20[, speed=10[, extra_space=0[, expand=false[, max_size[, step_function=step_functions.linear_increase[, space_for_scrolling=2^1024]]]]]]]])	Get a new vertical scrolling container.

Object properties

widget	widget	The widget to be scrolled.
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

:pause ()	Pause the scrolling animation.
:continue ()	Continue the scrolling animation.
:reset_scrolling ()	Reset the scrolling state to its initial condition.
:set_direction (dir)	Set the direction in which this widget scroll.
:set_expand (expand)	Specify the expand mode that is used for extra space.
:set_fps (fps)	Set the number of frames per second that this widget should draw.
:set_extra_space (extra_space)	Set the amount of extra space that should be included in the scrolling.
:set_speed (speed)	Set the speed of the scrolling animation.
:set_max_size (max_size)	Set the maximum size of this widget in the direction set by set_direction.
:set_step_function (step_function)	Set the step function that determines the exact behaviour of the scrolling animation.
:set_space_for_scrolling (space_for_scrolling)	Set an upper limit for the space for scrolling.
: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

Callback functions prototype

scroll.step_functions.linear_increase	A step function that scrolls the widget in an increasing direction with constant speed.
scroll.step_functions.linear_decrease	A step function that scrolls the widget in an decreasing direction with constant speed.
scroll.step_functions.linear_back_and_forth	A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc.
scroll.step_functions.nonlinear_back_and_forth	A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc.
scroll.step_functions.waiting_nonlinear_back_and_forth	A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc.

Tables

scroll.step_functions

A selection of step functions

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.scroll.horizontal ([widget[, fps=20[, speed=10[, extra_space=0[, expand=false[, max_size[, step_function=step_functions.linear_increase[, space_for_scrolling=2^1024]]]]]]]])

Get a new horizontal scrolling container.

Parameters:

widget The widget that should be scrolled (optional)
fps The number of frames per second (default 20)
speed The speed of the animation (default 10)
extra_space The amount of extra space to include (default 0)
expand boolean Should the widget be expanded to include the extra space? (default false)
max_size The maximum size of the child widget (optional)
step_function The step function to be used (default step_functions.linear_increase)
space_for_scrolling The space for scrolling (default 2^1024)

wibox.container.scroll.vertical ([widget[, fps=20[, speed=10[, extra_space=0[, expand=false[, max_size[, step_function=step_functions.linear_increase[, space_for_scrolling=2^1024]]]]]]]])

Get a new vertical scrolling container.

Parameters:

widget The widget that should be scrolled (optional)
fps The number of frames per second (default 20)
speed The speed of the animation (default 10)
extra_space The amount of extra space to include (default 0)
expand boolean Should the widget be expanded to include the extra space? (default false)
max_size The maximum size of the child widget (optional)
step_function The step function to be used (default step_functions.linear_increase)
space_for_scrolling The space for scrolling (default 2^1024)

Object properties

widget widget

The widget to be scrolled.

Type constraints:

widget widget The widget

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

:pause ()

Pause the scrolling animation.

Parameters:

dir Either "h" for horizontal scrolling or "v" for vertical scrolling

:set_expand (expand)

Specify the expand mode that is used for extra space.

Parameters:

expand boolean If true, the widget is expanded to include the extra space. If false, the extra space is simply left empty.

Parameters:

fps number The number of frames per second

:set_extra_space (extra_space)

Set the amount of extra space that should be included in the scrolling. This extra space will likely be left empty between repetitions of the widgets.

Parameters:

extra_space number The amount of extra space

Parameters:

speed number The speed for the animation

:set_max_size (max_size)

Set the maximum size of this widget in the direction set by set_direction. If the child widget is smaller than this size, no scrolling is done. If the child widget is larger, then only this size will be visible and the rest is made visible via scrolling.

Parameters:

max_size number The maximum size of this widget or nil for unlimited.

:set_step_function (step_function)

Set the step function that determines the exact behaviour of the scrolling animation. The step function is called with five arguments:

The time in seconds since the state of the animation
The size of the child widget
The size of the visible part of the widget
The speed of the animation. This should have a linear effect on this function's behaviour.
The extra space configured by set_extra_space. This was not yet added to the size of the child widget, but should likely be added to it in most cases.

The step function should return a single number. This number is the offset at which the widget is drawn and should be between 0 and size+extra_space.

Parameters:

step_function function A step function.

Parameters:

space_for_scrolling number The space for scrolling

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

Callback functions prototype

scroll.step_functions.linear_increase: A step function that scrolls the widget in an increasing direction with constant speed.
scroll.step_functions.linear_decrease: A step function that scrolls the widget in an decreasing direction with constant speed.
scroll.step_functions.linear_back_and_forth: A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc. The speed is constant.
scroll.step_functions.nonlinear_back_and_forth: A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc. The speed is null at the ends and maximal in the middle.
scroll.step_functions.waiting_nonlinear_back_and_forth: A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc. The speed is null at the ends and maximal in the middle. At both ends the widget stands still for a moment.

Tables

scroll.step_functions

A selection of step functions

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

Usage:

Class Hierarchy

Info:

Constructors

Object properties

Object methods

Callback functions prototype

Tables

Signals

Constructors

Parameters:

Parameters:

Object properties

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

Type constraints:

See also:

Object methods

See also:

See also:

Parameters:

Parameters:

See also:

Parameters:

Parameters:

See also:

Parameters:

Parameters:

Parameters:

See also:

Parameters:

Parameters:

Parameters:

Parameters:

Returns:

Parameters:

Usage:

Parameters:

Parameters:

Parameters:

Callback functions prototype

Tables

See also:

Signals

See also:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Arguments:

See also:

Module: `wibox.container.scroll`