NAME

Prima::Widget::ScrollWidget - scrollable generic document widget.

DESCRIPTION

"Prima::Widget::ScrollWidget" is a simple class that declares two pairs of properties, delta and limit for vertical and horizontal axes, which define a a virtual document. limit is the document dimension, and delta is the current offset.

"Prima::Widget::ScrollWidget" is a descendant of "Prima::Widget::GroupScroller", and, as well as its ascendant, provides same user navigation by two scrollbars. The scrollbars' "partial" and "whole" properties are maintained if the document or widget extensions change.

"Prima::Widget::ScrollGroup" in addition provides capability to host other widgets inside, and scroll them. Useful for widget group panels that cannot. fit in window

Properties

deltas X, Y: Selects horizontal and vertical document offsets.
deltaX INTEGER: Selects horizontal document offset.
deltaY INTEGER: Selects vertical document offset.
limits X, Y: Selects horizontal and vertical document extensions.
limitX INTEGER: Selects horizontal document extension.
limitY INTEGER: Selects vertical document extension.

Events

Scroll DX, DY: Called whenever the client area is to be scrolled. The default action calls "Widget::scroll" .

Properties

client: Return a parent widget to insert other widgets to. The client size is fixed, and is panned through the slave widget when scrolling. The client is unaffected by eventual automated pack/place/growMode size alteration the parent or slave might have.
clientClass: "clientClass" widget is inserted in the "slave" widget.
slave: Returns the slave widget. The slave widget designated the area desired to be scrollable, and is just a normal widget that is allowed to be resized, moved, etc.
slaveClass: "slaveClass" widget is inserted directly in the scroll group widget.

AUTHOR

Dmitry Karasik, <dmitry@karasik.eu.org>.