Class wibox.container.scroll

Info:

  • Copyright: 2015 Uli Schlachter
  • Author: Uli Schlachter (based on ideas from Saleur Geoffrey)

Functions

scroll:pause () Pause the scrolling animation.
scroll:continue () Continue the scrolling animation.
scroll:reset_scrolling () Reset the scrolling state to its initial condition.
scroll:set_direction (dir) Set the direction in which this widget scroll.
scroll:get_children () Get the number of children element
scroll:set_children (children) Replace the layout children This layout only accept one children, all others will be ignored
scroll:set_expand (expand) Specify the expand mode that is used for extra space.
scroll:set_fps (fps) Set the number of frames per second that this widget should draw.
scroll:set_extra_space (extra_space) Set the amount of extra space that should be included in the scrolling.
scroll:set_speed (speed) Set the speed of the scrolling animation.
scroll:set_max_size (max_size) Set the maximum size of this widget in the direction set by set_direction.
scroll:set_step_function (step_function) Set the step function that determines the exact behaviour of the scrolling animation.
scroll:set_space_for_scrolling (space_for_scrolling) Set an upper limit for the space for scrolling.
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.
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.
scroll.step_functions.linear_increase (elapsed, size, _, speed, extra_space) A step function that scrolls the widget in an increasing direction with constant speed.
scroll.step_functions.linear_decrease (elapsed, size, _, speed, extra_space) A step function that scrolls the widget in an decreasing direction with constant speed.
scroll.step_functions.linear_back_and_forth (elapsed, size, visible_size, speed) 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 (elapsed, size, visible_size, speed) 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 (elapsed, size, visible_size, speed) A step function that scrolls the widget to its end and back to its beginning, then back to its end, etc.

Object properties

wibox.container.scroll.widget The widget to be scrolled.

Tables

scroll.step_functions A selection of step functions


Functions

scroll:pause ()
Pause the scrolling animation.

See also:

scroll:continue ()
Continue the scrolling animation.

See also:

scroll:reset_scrolling ()
Reset the scrolling state to its initial condition. For must scroll step functions, the effect of this function should be to display the widget without any scrolling applied. This function does not undo the effect of pause.
scroll:set_direction (dir)
Set the direction in which this widget scroll.
  • dir Either "h" for horizontal scrolling or "v" for vertical scrolling
scroll:get_children ()
Get the number of children element

Returns:

    table The children
scroll: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
scroll:set_expand (expand)
Specify the expand mode that is used for extra space.
  • expand boolean If true, the widget is expanded to include the extra space. If false, the extra space is simply left empty.

See also:

scroll:set_fps (fps)
Set the number of frames per second that this widget should draw.
  • fps number The number of frames per second
scroll: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.
  • extra_space number The amount of extra space

See also:

scroll:set_speed (speed)
Set the speed of the scrolling animation. The exact meaning depends on the step function that is used, but for the simplest step functions, this will be in pixels per second.
  • speed number The speed for the animation
scroll: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.
  • max_size number The maximum size of this widget or nil for unlimited.
scroll: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.

  • step_function function A step function.

See also:

scroll:set_space_for_scrolling (space_for_scrolling)
Set an upper limit for the space for scrolling. This restricts the child widget's maximal size.
  • space_for_scrolling number The space for scrolling
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.
  • widget The widget that should be scrolled
  • 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
  • step_function The step function to be used (default step_functions.linear_increase)
  • space_for_scrolling The space for scrolling (default 2^1024)
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.
  • widget The widget that should be scrolled
  • 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
  • step_function The step function to be used (default step_functions.linear_increase)
  • space_for_scrolling The space for scrolling (default 2^1024)
scroll.step_functions.linear_increase (elapsed, size, _, speed, extra_space)
A step function that scrolls the widget in an increasing direction with constant speed.
  • elapsed
  • size
  • _
  • speed
  • extra_space
scroll.step_functions.linear_decrease (elapsed, size, _, speed, extra_space)
A step function that scrolls the widget in an decreasing direction with constant speed.
  • elapsed
  • size
  • _
  • speed
  • extra_space
scroll.step_functions.linear_back_and_forth (elapsed, size, visible_size, speed)
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.
  • elapsed
  • size
  • visible_size
  • speed
scroll.step_functions.nonlinear_back_and_forth (elapsed, size, visible_size, speed)
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.
  • elapsed
  • size
  • visible_size
  • speed
scroll.step_functions.waiting_nonlinear_back_and_forth (elapsed, size, visible_size, speed)
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.
  • elapsed
  • size
  • visible_size
  • speed

Object properties

wibox.container.scroll.widget
The widget to be scrolled.

Type:

Tables

scroll.step_functions
A selection of step functions

See also:

generated by LDoc 1.4.2