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 the extensions of 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 the same user navigation by two scrollbars. The scrollbars' partial and whole properties are automatically updated when the document or widget extensions change.

Prima::Widget::ScrollGroup provides the capability of hosting other widgets inside, and also scrolling them. Useful for widget group panels that cannot fit in a window

Prima::Widget::ScrollWidget

Properties

deltas X, Y

Selects the horizontal and vertical document offsets.

deltaX INTEGER

Selects the horizontal document offset.

deltaY INTEGER

Selects the vertical document offset.

limits X, Y

Selects the horizontal and vertical document extensions.

limitX INTEGER

Selects the horizontal document extension.

limitY INTEGER

Selects the vertical document extension.

Events

Scroll DX, DY

Called whenever the client area is to be scrolled. The default action calls Widget::scroll .

Prima::Widget::ScrollGroup

Properties

client

Returns the parent widget to insert other widgets. The client size is fixed and is panned through the slave widget when scrolling. The client is unaffected by the eventual automated pack/place/growMode size alteration the parent or slave might be subjected to.

clientClass

A clientClass widget is inserted in the slave widget.

slave

Returns the slave widget. The slave widget covers the scrollable area and is otherwise just a normal Prima::Widget object that can be resized, moved, etc.

slaveClass

A slaveClass widget is inserted directly in the scroll group widget.

AUTHOR

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

SEE ALSO

Prima, Prima::ImageViewer, Prima::ScrollBar, examples/e.pl.