Home  /  Autodocs

scroller.gadget

create scroller BOOPSI objects

FUNCTIONS

SCROLLER_GetClass

SUPERCLASS

gadgetclass

REQUIRES

bevel.image, glyph.image

DESCRIPTION

The scroller gadget is a propgclass wrapper class and is used to create proportional scroller or linear slider gadgets. To create a linear slider, SCROLLER_Visible must be set to 1, and SCROLLER_Top will range in value from 0 to SCROLLER_Total - 1.

The IntuiMessage.Code field will contain the SCROLLER_Top attribute, cast to a WORD.

Advantages that this class provides are:

ATTRIBUTES

SCROLLER_Top (LONG)
Set the current top value of the scroller within the proportional range. (V40)

Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)

SCROLLER_Visible (LONG)
Set the visible portion of the proportional range. (V40)

(OM_NEW, OM_SET, OM_UPDATE, OM_GET)

SCROLLER_Total (LONG)
Set the total range of the scroller. (V40)

Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)

SCROLLER_Orientation
Define orientation of the scroller.

Accepted values as defined in <gadgets/scroller.h> are:

  • SORIENT_VERT

  • SORIENT_HORIZ

Defines are found in <gadgets/scroller.h> and are synomyms for the propgclass FREEVERT and FREEHORIZ. (V40)

Applicability is (OM_NEW, OM_GET)

SCROLLER_Arrows (BOOL)
Enable rendering of optional scroller arrows. (V40)

Applicability is (OM_NEW, OM_GET)

SCROLLER_ArrowDelta (WORD)
(V41) Allows you to change the amount that clicking an arrow causes the scroller to move by.

Defaults to 1.

Applicability is (OM_NEW, OM_SET, OM_UPDATE, OM_GET)

SCROLLER_SignalTask (struct Task *)
(V42) Signal the specified Task while scroller is active. This is very useful to reduce the load on input.device because you can render from some other task (application, or anything else) that waits for this signal and then GetAttr() SCROLLER_Top, etc.

Defaults to NULL (no signaling).

Applicability is (OM_NEW, OM_SET)

SCROLLER_SignalTaskBit (ULONG)
(V42) Signal with this Bit. See also; SCROLLER_SignalTask.

Applicability is (OM_NEW, OM_SET)