Desktop Plug-in Scripting Reference

Overview

The desktop plugin provides the generic background for a DreamFactory project.

Messages: nodemove, nodechange

Commands and Functions

boundsget

rectangle $ = boundsget(node name $)

Returns the boundary rectangle of the desktop.

edgebottomget, edgebottomset, edgeleftget, edgeleftset, edgerightget, edgerightset, edgetopget, edgetopset

edge # = edgebottomget(node name $)
edgebottomset(node name $, edge #)
edge # = edgeleftget(node name $)
edgeleftset(node name $, edge #)
edge # = edgerightget(node name $)
edgerightset(node name $, edge #)
edge # = edgetopget(node name $)
edgetopset(node name $, edge #)

Get or set the top, left, bottom, or right line color edge of the desktop.

This allows a rectangle to be drawn on the desktop background, and is an easy way to designate a work area of a different size.
See: linecolorset, linecolorget

fillbackcolorget, fillbackcolorset, fillforecolorget, fillforecolorset

fill back color $ = fillbackcolorget(node name $)
fillbackcolorset(node name $, fill back color $)
fill fore color $ = fillforecolorget(node name $)
fillforecolorset(node name $, fill fore color $)

Set the fill fore and back colors. The fore color is for "on" bits in the pattern, the back color is for "off" bits.

All alpha channels work fine, 255 for opaque, 0 for clear. Example:

desktop.fillforecolorset("myobject", "100, 100, 100, 255")

fillpatternget, fillpatternset

fillpattern $ = fillpatternget(node name $)
fillpatternset(node name $, fillpattern $)

Set the fill and/or line patterns. Example:

desktop.fillpatternset("myobject", "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"

handlesget

handles TF = handlesget(node name $)

The desktop does not have handles, so this routine always returns false.

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

hittest

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

Returns true if the point is in the desktop.

linecolorget, linecolorset

line color $ = linecolorget(node name $)
linecolorset(node name $, line color $)

Get or set the line color for the desktop edge.
See: edgetopset, edgeleftset, edgebottomset, edgerightset, edgetopget, edgeleftget, edgebottomget, edgerightget

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: handlesget

originleftget, originleftset, origintopget, origintopset

origin left # = originleftget(node name $)
originleftset(node name $, origin left #)
origin top # = origintopget(node name $)
origintopset(node name $, origin top #)

Get or set the horizontal or vertical origin of the entire desktop.

This allows all desktop children to be scrolled.