Icon Plug-in Scripting Reference

Overview

The icon plugin is for simple bitmapped images like patterns, cursors, and icons.

You can import and export icons to windows, lists, menus, and buttons.

Messages: nodemove, nodechange

Nodemove is sent when the position of the icon changes.

Nodechange is sent when the icon's data changes.

Commands and Functions

alphamaskget, alphamaskset

alphamask # = alphamaskget(node name $)
alphamaskset(node name $, alphamask #)

Get or set the alphamask.

If alphamask is 1, only the alpha channel is displayed.

If alphamask is -1, only the RGB channel is displayed.

If alphamask is 0, all channels are displayed.
See: pixelset, pixelget

binaryget, binaryset

binary data $ = binaryget(node name $)
binaryset(node name $, binary data $)

Get or set binary data for any icon.

This routine is useful for serialization into xml or transferring icons to windows, buttons, lists, or menus.

boundsget, boundsset

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

Get or set the boundary rectangle of the object. Icons are losslessly scaled to the new bounds.

copy, paste

copy(node name $)
paste(node name $)

Move the icon on or off the system clipboard as graphics.

cursorset

cursorset(node name $)

This turns a 16 X 16 icon into the current mouse cursor.

Set the hotspot to determine the cursor's registration.

Use the icon's alpha channel to determine the mask of the cursor.

eraseall

eraseall(node name $)

Erase the icon data to white.

export, import

export(node name $, file name $)
import(node name $, file name $)

Import data into an icon.

fatbitsget, fatbitsset

fatbits TF = fatbitsget(node name $)
fatbitsset(node name $, fatbits TF)

Get or set the fatbits. This shows the icon with separated pixels for editing.

The bounds rectangle must be at least twice as big as the icon width and height for fatbits to appear.
See: boundsset, boundsget

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

heightget, heightset, widthget, widthheight, widthset

height # = heightget(node name $)
heightset(node name $, height #)
width # = widthget(node name $)
widthheight(node name $, width #, height #)
widthset(node name $, width #)

Get or set the width and height of the icon.

All of the icon data is scaled to the new width or height.

hiliteget, hiliteset

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

Get or set the hilite of the icon. If hilited, the icon is inverted.

This is useful to show mouse control of the icon.

hittest

hit TF = hittest(node name $, hor #, ver #)

Returns true if the point is in the icon.

hothorget, hothorset, hothorver, hotverget, hotverset

hotspot hor # = hothorget(node name $)
hothorset(node name $, hotspot hor #)
hothorver(node name $, hotspot hor #, hotspot ver #)
hotspot ver # = hotverget(node name $)
hotverset(node name $, hotspot ver #)

Get or set the hotspot of the icon.

This is useful for making cursors.

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

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 and set the top left corner of the icon to the given pattern.

This is used for editing patterns, and moving them in and out of an 8 X 8 icon.

pixelget, pixelset

pixel $ = pixelget(node name $, hor #, ver #)
pixelset(node name $, hor #, ver #, pixel $)

Get or set the pixel. This is useful for painting and editing the icon.

The pixel's point should be between 1 and the width or height of the icon.

If the icon's alphamask is set to 1, pixelset will paint just the alpha channel.

If the icon's alphamask is set to -1, pixelset will paint just the RGB channel.
See: alphamaskset, alphamaskget

reset

reset(node name $)

Reset restors an icon to the original aspect ratio.

showspotget, showspotset

showspot TF = showspotget(node name $)
showspotset(node name $, showspot TF)

Get or set the showspot. This shows the hotspot on the current icon.
See: hothorset, hothorget, hotverget, hotverset, hothorver