BBjSlider::getSnapToTicks

Description

In BBj 7.0 and higher, this method queries whether a BBjSlider should snap to the nearest tick when the user drags the thumb.

Syntax

Return Value

Method

boolean

getSnapToTicks()

Parameters

None.

Return Value

Returns whether the BBjSlider should snap to the nearest tick when the user drags the thumb.

Remarks

None.

Example

REM Query whether a BBjSlider should snap to the nearest tick

REM Obtain the instance of the BBjAPI object
LET myAPI!=BBjAPI()

REM Open the SysGui device
SYSGUI=UNT
OPEN (SYSGUI) "X0"

REM Obtain the instance of the BBjSysGui object
LET mySysGui!=myAPI!.getSysGui()

REM Set addWindow param values
X=10
Y=10
WIDTH=200
HEIGHT=200
TITLE$="BBj Window"

REM Set the current context
mySysGui!.setContext(0)

REM Create a window
myWindow! = mySysGui!.addWindow(X,Y,WIDTH,HEIGHT,TITLE$)

REM Add a vertical slider on the window
mySlider! = myWindow!.addVerticalSlider(101,80,0,40,200,$0000$)
mySlider!.setMajorTickSpacing(25)
mySlider!.setMinorTickSpacing(5)
mySlider!.setPaintTicks(1)
mySlider!.setSnapToTicks(1)
print "Major tick spacing is",mySlider!.getMajorTickSpacing()
print "Minor tick spacing is",mySlider!.getMinorTickSpacing()
print "Paint ticks?",mySlider!.getPaintTicks()
print "Snap to ticks?",mySlider!.getSnapToTicks()

REM Register the CALLBACK routines
CALLBACK(ON_CONTROL_SCROLL,SLIDER_SCROLLED,mySysGui!.getContext(),mySlider!.getID())
CALLBACK(ON_CLOSE,APP_CLOSE,mySysGui!.getContext())

REM Process Events
PROCESS_EVENTS

REM Callback routine called when the slider is used to scroll
SLIDER_SCROLLED:
REM Get the new value of the slider
VAL = mySlider!.getValue()
MIN = mySlider!.getMinimum()
MAX = mySlider!.getMaximum()
RETURN

REM Callback routine called when the user closes the application window
APP_CLOSE:
RELEASE
RETURN

See Also

BBjAPI

BBjSysGui

BBjControl

BBjWindow

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.