10.5.3 Abstract Gadget Classes

10.5.3.6 The Scroll-Bar Gadget

The scroll-bar gadget corresponds to a scroll bar.

scroll-bar [Class]

Summary:
The class that implements a scroll bar. This is a subclass of value-gadget, oriented-gadget-mixin, and range-gadget-mixin.

:drag-callback [Initarg]
:scroll-to-bottom-callback [Initarg]
:scroll-to-top-callback [Initarg]
:scroll-down-line-callback [Initarg]
:scroll-up-line-callback [Initarg]
:scroll-down-page-callback [Initarg]
:scroll-up-page-callback [Initarg]
Summary:
Specifies the various callbacks for the scroll bar.

scroll-bar-drag-callback [Generic Function]
Arguments:
scroll-bar
Summary:
Returns the function that will be called when the indicator of the scroll bar is dragged. This function will be invoked with a two arguments, the scroll bar and the new value.

scroll-bar-scroll-to-bottom-callback [Generic Function]
Arguments:
scroll-bar
scroll-bar-scroll-to-top-callback [Generic Function]
Arguments:
scroll-bar
scroll-bar-scroll-down-line-callback [Generic Function]
Arguments:
scroll-bar
scroll-bar-scroll-up-line-callback [Generic Function]
Arguments:
scroll-bar
scroll-bar-scroll-down-page-callback [Generic Function]
Arguments:
scroll-bar
scroll-bar-scroll-up-page-callback [Generic Function]
Arguments:
scroll-bar
Summary:
Returns the functions that will be used as callbacks when various parts of the scroll bar are clicked on. These are all functions of one argument, the scroll bar.

When any of these functions returns nil, there is no callback of that type for the gadget.

drag-callback [Callback]
Arguments:
scroll-bar client gadget-id value
Summary:
This callback is invoked when the value of the scroll bar is changed while the indicator is being dragged. The function stored in scroll-bar-drag-callback is called with two arguments, the scroll bar and the new value.

The value-changed-callback is invoked only after the indicator is released after dragging it.

scroll-to-top-callback [Callback]
Arguments:
scroll-bar client gadget-id
scroll-to-bottom-callback [Callback]
Arguments:
scroll-bar client gadget-id
scroll-up-line-callback [Callback]
Arguments:
scroll-bar client gadget-id
scroll-up-page-callback [Callback]
Arguments:
scroll-bar client gadget-id
scroll-down-line-callback [Callback]
Arguments:
scroll-bar client gadget-id
scroll-down-page-callback [Callback]
Arguments:
scroll-bar client gadget-id
Summary:
All the callbacks above are invoked when appropriate parts of the scroll bar are clicked on. Note that each implementation may not have "hot spots" corresponding to each of these callbacks.

gadget-value [Generic Function]
Arguments:
(button scroll-bar)
Summary:
Returns a real number within the specified range.

scroll-bar-pane [Class]
Summary:
The class that implements a portable scroll bar; it is a subclass of scroll-bar.


CLIM 2.0 User's Guide - OCT 1998

Generated with Harlequin WebMaker