Window Plug-in Scripting Reference

Overview

The window plugin implements palette, regular, and dialog windows in a variety of styles.

These windows can be scrolling or nonscrolling, and automatically clip the children inside of them.

The default script for windows keeps them in proper order (dialogs on top, then palettes) and handles the scroll bars.

Generally windows are atteched to the desktop, but you can also attach windows to windows for a multiple document interface look.

Messages: nodemove, nodechange, nodeactive

Nodemove is sent when the position of the window changes.

Nodechange is sent when the interior page of the window is scrolled.

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

Commands and Functions

activeget, activeset

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

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

barsget, barsset

has bars TF = barsget(node name $)
barsset(node name $, has bars TF)

Get or set the scrollbar attribute for document and palette windows.

boundsget, boundsset

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

Get or set the interior content rectangle. This may effect the external boundary of the window.

Externalget and externalset can be used to get or set the external boundary rectangle of the window.
See: externalset, externalget

clipopenget, clipopenset

clip open TF = clipopenget(node name $)
clipopenset(node name $, clip open TF)

Get or set the clipopen property. If true, the window does not clip its children.

This is useful for children that need to extend outside the window.

closeget, closeset

close box TF = closeget(node name $)
closeset(node name $, close box TF)

Get or set the close box attribute. The close box usually appears in the title bar.

counticons, deleteicon, inserticon

total icons # = counticons(node name $)
deleteicon(node name $, icon index #)
inserticon(node name $, after index #)

Some window styles will display an icon in the title bar.

These routines create, delete, and count icons for the given window.

In general, you should insert and name an icon, import data for it, and set the show icon name of the window to display.
See: showiconset, showiconget

cursorset

cursorset(node name $, icon name $)

Any window title bar icon can be turned into a cursor as needed.

This allows a window to store and use custom cursors.

externalget, externalset

rectangle $ = externalget(node name $)
externalset(node name $, rectangle $)

Get or set the external boundary rectangle of the window frame, this may affect the content area.

Boundsget and boundsset can be used to get or set the content rectangle of the window.
See: boundsset, boundsget

fillcolorget, fillcolornative, fillcolorset

fillcolor $ = fillcolorget(node name $)
fillcolor $ = fillcolornative(node name $)
fillcolorset(node name $, fillcolor $)

Get or set the fillcolor for the content area. The fillcolor is initially white.

Fillcolornative gets the native fillcolor of the window, for example, macintosh, crystal, and windows dialogs have a special shade of gray.

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"

growget, growset

grow box TF = growget(node name $)
growset(node name $, grow box TF)

Hide or show the grow icon in the lower right corner of a dialog box.

If visible, the hittest function will return "grow" for this area, and the dialog can be resized.
See: hittest

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 window, which inverts some part of the scrollbar or window frame.

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

This is useful to show mouse control of the scrollbars or window frame.
See: hittest

hittest, hittestall

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

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

Hittestall will return a part name even if the window is inactive.

Return values: none, inactive, content, grow, close, zoom, minimize, drag, leftarrow, rightarrow, uparrow, downarrow, horthumb, verthumb, pageleft, pageright, pageup, and pagedown.
See: hiliteset, hiliteget

iconbinaryget, iconbinaryset

binary data $ = iconbinaryget(node name $, icon index #)
iconbinaryset(node name $, icon index #, binary data $)

Get or set binary data for any icon.

This routine is useful for serialization into xml and trading icons between nodes.

iconexport, iconimport

iconexport(node name $, icon index #, file name $)
iconimport(node name $, icon index #, file name $)

Import and export icon pictures. These are small 16 X 16 bitmapped images.

iconnameget, iconnameset

icon name $ = iconnameget(node name $, icon index #)
iconnameset(node name $, icon index #, icon name $)

Get and set the name of the icon. This should match the show icon name.

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

minimizeget, minimizeset

minimize box TF = minimizeget(node name $)
minimizeset(node name $, minimize box TF)

Get or set the minimize box attribute. The minimize box usually appears in the title bar.

The old window bounds of a minimized window are saved in the saverect.
See: saverectset, saverectget, stateset, stateget

pagelimitget, pagelimitset

page limit TF = pagelimitget(node name $)
pagelimitset(node name $, page limit TF)

If the current page is smaller than the window's content area, then the pagelimit property controls the appearance of the area outside the page.

If pagelimit is true, a gray background is displayed in the area outside the page, and child nodes are clipped to the page area.

If pagelimit is false, the area outside the page is painted in the window's fill color, and child nodes are not clipped.
See: fillcolorset, fillcolorget

pageoriginhorget, pageoriginhorset, pageoriginhorver, pageoriginverget, pageoriginverset

hor # = pageoriginhorget(node name $)
pageoriginhorset(node name $, hor #)
pageoriginhorver(node name $, hor #, ver #)
ver # = pageoriginverget(node name $)
pageoriginverset(node name $, ver #)

This sets the origin of the current page.
See: pagesizehorver, pagesizehorget, pagesizeverget, pagesizehorset, pagesizeverset

pagesizehorget, pagesizehorset, pagesizehorver, pagesizeverget, pagesizeverset

hor # = pagesizehorget(node name $)
pagesizehorset(node name $, hor #)
pagesizehorver(node name $, hor #, ver #)
ver # = pagesizeverget(node name $)
pagesizeverset(node name $, ver #)

These functions get and set the page size of the window. This can be used with or without scrollbars.

This is the underlying document size the window looks in to.
See: pageoriginhorver, pageoriginhorget, pageoriginverget, pageoriginhorset, pageoriginverset

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

saverectget, saverectset

rectangle $ = saverectget(node name $)
saverectset(node name $, rectangle $)

The old window bounds of a zoomed or minimized window are saved in the saverect.

savethumb

savethumb(node name $)

Saves the thumb position for "snap back" when the mouse moves out of the active area.
See: trackscroll

scrollspeedget, scrollspeedset

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

Get or set the scroll speed in pixels per frame when clicking on the scroll arrows.

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

showiconget, showiconset

icon name $ = showiconget(node name $)
showiconset(node name $, icon name $)

Get or set the currently showing icon name for a window. Title bar icons are small 16 X 16 bitmapped images.
See: inserticon, deleteicon, counticons

simpletype

simple type $ = simpletype(node name $)

This function returns the simple type of the window, ignoring any platform specific styles.

Available types include: dialog, palette, document, and custom.
See: styleset, styleget

stateget, stateset

window state $ = stateget(node name $)
stateset(node name $, window state $)

Get or set the visual state of the window. Available states include: minimize, normal, and zoom.

The minimize state will collapse the window into just a title bar. The zoom state is set when the window has taken over the full screen.
See: minimizeset, minimizeget, zoomset, zoomget

styleget, styleset

style name $ = styleget(node name $)
styleset(node name $, style name $)

Get or set style of the window.

Custom styles include: plain and shadow.

Native styles include: nativedialog, nativepalette, and nativedocument.

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

Macintosh styles include: macintoshdialog, macintoshpalette, and macintoshdocument.

Windows styles include: windowsdialog, windowspalette, and windowsdocument.

Modern styles include: moderndialog, modernpalette, and moderndocument.

Classic styles include: classicdialog, classicpalette, and classicdocument.

Crystal styles include: crystaldialog, crystalpalette, and crystaldocument.
See: simpletype

themecolorget, themecolornative, themecolorset

themecolor $ = themecolorget(node name $)
themecolor $ = themecolornative(node name $)
themecolorset(node name $, themecolor $)

Get or set the themecolor for macintosh style scroll bars and windows style title bars

Themecolornative gets the native themecolor of the window, for example, native windows title bars are dark blue.

titleget, titleset

title $ = titleget(node name $)
titleset(node name $, title $)

Get or set the window title for the window.

trackscroll

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

Trackscroll automatically adjusts the page origin of the window by tracking mouse input in the scrollbars.

Check the library script for tracking the mouse in a window for an example of how to use this command.
See: savethumb, scrollspeedget, scrollspeedset

zoomget, zoomset

zoom box TF = zoomget(node name $)
zoomset(node name $, zoom box TF)

Get or set the zoom box attribute. The zoom box usually appears in the title bar.

The old window bounds of a zoomed window are saved in the saverect.
See: saverectset, saverectget, stateset, stateget