Slider Plug-in Scripting Reference

Overview

The slider plugin implements sliding controls, stand-alone scrollbars, and numeric spinner controls of various styles.

There are four major parts to a slider: the bar, the thumb, the stops, and the ticks. Each of these parts can be individually styled.

This documentation generally refers to horizontal sliders. Use barhorizontalset to create sliders with a vertical orientation.

Messages: nodemove, nodechange, nodeactive

Nodemove is sent when the position of the slider changes.

Nodechange is sent when the min, max, or value of the slider changes.

Nodeactive is sent when the active state of the slider changes.

Commands and Functions

activeget, activeset

active TF = activeget(node name $)
activeset(node name $, active TF)

Get or set the active attribute. Inactive sliders are dull and do not respond to mouse input.

backcolorget, backcolorset

backcolor $ = backcolorget(node name $)
backcolorset(node name $, backcolor $)

Get or set various background colors for the bar.

barheightget, barheightset

barheight # = barheightget(node name $)
barheightset(node name $, barheight #)

Get or set the height of the bar itself. You may have to match the bar height to the height of the thumb, stop or tick.

barhorizontalget, barhorizontalset

bar horizontal TF = barhorizontalget(node name $)
barhorizontalset(node name $, bar horizontal TF)

Get or set the bar's orientation from horizontal to vertical.

barstyleget, barstyleset

bar style name $ = barstyleget(node name $)
barstyleset(node name $, bar style name $)

Get or set the bar style.

Custom styles include: solid, double, pattern, thermometer, openend, round, beveled, opentherm, none, striped, and indent.

Platform styles for progress indicators include: classic, macintosh, windows, modern, crystal, and native.

The native style matches the appearance of the current operating system.

boundsget, boundsset

rectangle $ = boundsget(node name $)
boundsset(node name $, rectangle $)

Get or set the boundary rectangle of the object.

forecolorget, forecolorset

forecolor $ = forecolorget(node name $)
forecolorset(node name $, forecolor $)

Get or set various foreground colors for the bar.

fullget, fullset, infoget, infoset

full $ = fullget(node name $)
fullset(node name $, full $)
info $ = infoget(node name $)
infoset(node name $, info $)

Get or set XML data that describes all the settings for this node.

The fullget and fullset routines have a header element with appropriate namespaces, infoget and infoset are an XML snippet for access as a property. Example:

mynode.info.title = "new title"

handlesget, handlesset

handles TF = handlesget(node name $)
handlesset(node name $, handles TF)

Turn on or off dragable handles for reshaping the node.

This routine is used by the system tool palettes for manual positioning.
See: markersget, markersset, partget, partset

hiliteget, hiliteset

hilite $ = hiliteget(node name $)
hiliteset(node name $, hilite $)

Get or set the hilite of the slider, which inverts some part of the slider's image.

Hilites include: leftarrow, rightarrow, uparrow, downarrow, horthumb, verthumb, pageleft, pageright, pageup, and pagedown.

This is useful to show mouse control of the slider.
See: hittest

hittest, hittestall

part name $ = hittest(node name $, hor #, ver #)
part name $ = hittestall(node name $, hor #, ver #)

This function hit tests the slider to see what part has been clicked on.

Hittestall will return the part name even if the slider is inactive.

Available parts are: none, inactive, leftarrow, rightarrow, uparrow, downarrow, horthumb, verthumb, pageleft, pageright, pageup, and pagedown.
See: hiliteset, hiliteget

linecolorget, linecolorset

linecolor $ = linecolorget(node name $)
linecolorset(node name $, linecolor $)

Get or set various line colors for the bar.

markersget, markersset

markers TF = markersget(node name $)
markersset(node name $, markers TF)

Turn on or off the node outline to show selection.

This routine is used by the system tool palettes to show that a node is selected.
See: handlesset, handlesget, partget, partset

maxget, maxset

max # = maxget(node name $)
maxset(node name $, max #)

Get or set the maximum value of the control.

minget, minset

min # = minget(node name $)
minset(node name $, min #)

Get or set the minimum value of the control.

pagespeedget, pagespeedset

page speed # = pagespeedget(node name $)
pagespeedset(node name $, page speed #)

Get or set the page speed of the slider.

This is the amount the thumb moves moves when you click on the page up or page down area of the control.

Set the value to zero for the default speed.
See: trackscroll, scrollspeedget, scrollspeedset

partget, partset

part # = partget(node name $, hor #, ver #)
partset(node name $, hor #, ver #, part #)

Get or set the points for an individual handle.
See: markersget, markersset, handlesset, handlesget

patternget, patternset

pattern $ = patternget(node name $)
patternset(node name $, pattern $)

Get or set the pattern for the bar style: pattern.

savethumb

savethumb(node name $)

This routine should be called before track scroll to remember the current value of the thumb.

If the mouse tracks off to the side, the thumb returns to the original value.

scrollspeedget, scrollspeedset

scroll speed # = scrollspeedget(node name $)
scrollspeedset(node name $, scroll speed #)

Get or set the scroll speed of the slider.

This is the amount the thumb moves when you click on the up or down arrows of the control.

Set the value to zero for the default speed.
See: trackscroll, pagespeedset, pagespeedget

shadowcolorget, shadowcolorset

shadowcolor $ = shadowcolorget(node name $)
shadowcolorset(node name $, shadowcolor $)

Get or set the shadow color.

shadowget, shadowset

shadow # = shadowget(node name $)
shadowset(node name $, shadow #)

Get or set the amount of drop shadow the slider has.

stopaccelerateget, stopaccelerateset

accelerate TF = stopaccelerateget(node name $)
stopaccelerateset(node name $, accelerate TF)

Get or set the stopaccelerate property.

If true, clicking in an arrow will gradually acclerate the thumb.

Acceleration will stop at the page bump value.
See: trackscroll, scrollspeedget, scrollspeedset

stopbumpget, stopbumpset

stop bump # = stopbumpget(node name $)
stopbumpset(node name $, stopbump #)

The stop bump is an offset from either end of the slider that limits the thumb. A stop bump of zero goes completely to either end.

stopcolorget, stopcolorset

stopcolor $ = stopcolorget(node name $)
stopcolorset(node name $, stopcolor $)

Get or set the color of the stops, some stop styles have fixed colors.

stopflipactionget, stopflipactionset

flip action TF = stopflipactionget(node name $)
stopflipactionset(node name $, flip action TF)

This is used for numeric spinners to flip the action of the arrows.

Clicking in a scroll down arrow should increase the value of a scrollbar, but decrease the value of a spinner.

stopheightget, stopheightset

stop height # = stopheightget(node name $)
stopheightset(node name $, stop height #)

Get or set the height of the stops. Some stops have a fixed height.

stopstyleget, stopstyleset

stop style name $ = stopstyleget(node name $)
stopstyleset(node name $, stop style name $)

Get or set the stop style. Stops are the graphics at either end of the bar, often some kind of arrow.

Available styles include: arrow, scroll, dot, line, cap, rectangle, miniscroll, microscroll, and none.

thumbcolorget, thumbcolorset

thumbcolor $ = thumbcolorget(node name $)
thumbcolorset(node name $, thumbcolor $)

Get or set the color of the thumb, some thumb styles have fixed colors.

thumbheightget, thumbheightset

thumb height # = thumbheightget(node name $)
thumbheightset(node name $, thumb height #)

Get or set the height of the thumb. Some thumbs have a fixed height.

thumbstyleget, thumbstyleset

thumb style name $ = thumbstyleget(node name $)
thumbstyleset(node name $, thumb style name $)

Get or set the thumb style.

Custom styles include: dot, barrel, gadget, rectangle, hourglass, capstone, balance, marker, thumb, none, target, minithumb, microthumb, block, and bubble.

Platform styles for draggable thumbs include: classic, macintosh, windows, modern, crystal, and native.

The native style matches the appearance of the current operating system.

tickcolorget, tickcolorset

tickcolor $ = tickcolorget(node name $)
tickcolorset(node name $, tickcolor $)

Get or set the color of the ticks.

tickcountget, tickcountset

ticks # = tickcountget(node name $)
tickcountset(node name $, ticks #)

Get or set the number of ticks. This is normally the number of tick marks along the slider, depending on the tick style.

tickheightget, tickheightset

tick height # = tickheightget(node name $)
tickheightset(node name $, tick height #)

Get or set the tick height. This controls how tall the ticks are, depending on tick style.

tickoffsetget, tickoffsetset

tickoffset # = tickoffsetget(node name $)
tickoffsetset(node name $, tickoffset #)

This property control how far the ticks are above or below the slider.

tickstyleget, tickstyleset

tick style name $ = tickstyleget(node name $)
tickstyleset(node name $, tick style name $)

Get or set the tick style. Ticks are the tick marks and / or numeric box above or below the slider.

Available styles include: even, uneven, dotted, display, displaybox, and none.

trackscroll

trackscroll(node name $, part name $, hor #, ver #)

Trackscroll automatically adjusts the value of the slider by tracking mouse input in the thumb, pages, and arrows.

See the library script for tracking the mouse in a slider for an example of how to use this command.
See: savethumb, scrollspeedget, scrollspeedset, pagespeedset, pagespeedget, stopaccelerateset, stopaccelerateget

valueget, valueset

value # = valueget(node name $)
valueset(node name $, value #)

Get or set the current value of the control.