Method and arguments |
Purpose |
sprite(spriteReference).setMagicXTV (registrationCodeString) |
Prevents the demo dialog from coming up after purchase. |
Node Methods |
Add/Delete Node |
sprite(spriteReference).getRootNodeXTV ( ) |
Returns the node ID of the top node on the tree |
sprite(spriteReference).addChildXTV (parentNID, addWhere, preceedingNID) |
Adds a new node to the tree as a child of the specified parent node. |
sprite(spriteReference).removeChildXTV (parentNID, childNID) |
Removes the specified node ID from the tree as well as any of its children. |
sprite(spriteReference).removeAllChildrenXTV (parentNID) |
Removes all of the children of the specified node as well as their children. |
sprite(spriteReference).getNumChildrenXTV (nodeID) |
Returns the number of top-level children of that node. |
sprite(spriteReference).getNthChildXTV (parentNID, childPosition) |
Returns the nodeID of the child node in the nth position. |
sprite(spriteReference).findChildXTV (parentNID, childNID) |
Returns the node position, not nodeID, of the child node specified. |
sprite(spriteReference).getParentXTV (childNID) |
Returns the node ID of the parent node of the specified child node |
Node Properties |
sprite(spriteReference).getNodeLocationXTV (nodeID) |
Returns the coordinates of the top, left corner of the specified node's bounding box. |
sprite(spriteReference).setNameXTV (nodeID, nodeName) |
Sets the text label displayed for the specified node. |
sprite(spriteReference).getNameXTV (nodeID) |
Returns the name of the node specified by nodeID. |
sprite(spriteReference).setIconIDXTV (nodeID, iconType, iconID) |
Sets the icon image used for a particular icon type for an individual node. |
sprite(spriteReference).getIconIDXTV (nodeID, iconType) |
Returns the icon ID for the specified icon type of the node specified. |
sprite(spriteReference).setFontIDXTV (nodeID, fontID) |
Sets the font that an individual node's text will display in. |
sprite(spriteReference).getFontIDXTV (nodeID) |
Returns the fontID from the internal font list currently set for the node. |
sprite(spriteReference).setFontColorXTV (nodeID, textRed, textGreen, textBlue) |
Sets the text color for the specified node. |
sprite(spriteReference).getFontColorXTV (nodeID) |
Returns a string containing the current RGB value set for the node's text color. |
sprite(spriteReference).setExpandedXTV (nodeID, expandedFlag) |
Expands a node to show the node's top-level children. |
sprite(spriteReference).getExpandedXTV (nodeID) |
Returns the current expand state of the node. |
sprite(spriteReference).setUserNumXTV (nodeID, customNumber) |
Stores a custom number supplied by the Lingo programmer with the node. |
sprite(spriteReference).getUserNumXTV (nodeID) |
Returns the custom number previously stored with the node using setUserNumXTV |
sprite(spriteReference).setUserStringXTV (nodeID, stringNum, customString) |
Links a string defined by the Lingo programmer to a node. |
sprite(spriteReference).getUserStringXTV (nodeID, stringNum) |
Returns the specified custom data string stored with a node using setUserStringXTV. |
sprite(spriteReference).setMouseStatusRequestXTV (nodeID, singleClickFlag, doubleClickFlag, mouseEnterFlag, mouseOverFlag, mouseDownFlag) |
Determines per node which user actions will be reported to the callback handlers. |
sprite(spriteReference).getMouseStatusRequestXTV (nodeID) |
Returns a string with 5 flags, either 1 or 0, separated by spaces. |
sprite(spriteReference).setAllNodesMouseStatusRequestXTV (singleClick, doubleClick, mouseEnter, mouseOver, mouseDown) |
Resets for all existing nodes which user actions will be reported to the callback handlers. |
Tree Methods |
Icon Properties |
sprite(spriteReference).getNumIconsXTV ( ) |
Returns the total number of icons in the tree's icon list. |
sprite(spriteReference).addIconXTV (castlibNum, memberNum, paletteNum, pixelWidth, pixelHeight) |
Adds a bitmap cast member to the tree's icon list. |
sprite(spriteReference).getIconXTV (iconID) |
Retuns information for the stored icon |
sprite(spriteReference).setIconXTV (iconID, castlibNum, memberNum, paletteNum, pixelWidth, pixelHeight) |
Resets the properties of an existing icon. |
sprite(spriteReference).getMaxIconSizeXTV (iconType) |
Returns the maximum height and width of the specified icon type. |
sprite(spriteReference).setMaxIconSizeXTV (iconType, pixelWidth, pixelHeight) |
Limits the height and width of the specified icon type. |
sprite(spriteReference).setGlobalIconIDXTV (iconType, iconID) |
Sets the icon graphic used throughout the tree for the expander icon type if the property has not yet been set individually for the node. |
sprite(spriteReference).getGlobalIconIDXTV (iconType) |
Returns the global icon ID set for the specified icon type. |
sprite(spriteReference).setAllNodesIconIDXTV (iconType, iconID) |
Resets the icon for the specified icon type for existing nodes. |
sprite(spriteReference).resetScrollbarsXTV(0) |
Scrolls the tree back up to the top/left. |
Connector Line and Spacing Properties |
sprite(spriteReference).setLineModeXTV (lineType) |
Controls the type of line used for the connecting lines between nodes. |
sprite(spriteReference).getLineModeXTV ( ) |
Returns the current line type used for the connecting lines between nodes. |
sprite(spriteReference).setMainColorsXTV (lineRed, lineGreen, lineBlue) |
Sets the color of the connecting lines between nodes. |
sprite(spriteReference).getContentSizeXTV ( ) |
Returns a string containing the width and height in pixels of a tree's content area. |
sprite(spriteReference).setContentOffsetXTV (horizontalPixels, verticalPixels) |
Moves content area within TreeView sprite. |
sprite(spriteReference).setSpacingXTV (indent, iconSideMargin, iconTopMargin, expanderSideMargin, expanderTopMargin) |
Adjusts the spacing between tree icons. |
sprite(spriteReference).getSpacingXTV ( ) |
Returns a string containing the tree's current spacing settings separated by spaces. |
Scroll Bar Properties |
sprite(spriteReference).setScrollbarUsageXTV (onOrOff) |
Shows or hides the scrollbars for a TreeView sprite. |
sprite(spriteReference).setScrollbarDataXTV (castlibNum, startingMemberNum, 0) |
Sets the images to use for the various parts of the vertical and horizontal scrollbar. |
sprite(spriteReference).setScrollbarColorsXTV (inactiveRed, inactiveGreen, inactiveBlue, frameRed, frameGreen, frameBlue,activeRed, activeGreen,activeBlue) |
Sets the color used to draw the frame outline of the scrollbars and the color that fills the interior of the scroll bar tracks. |
sprite(spriteReference).resetScrollbarsXTV(0) |
Scrolls the tree back up to top/left. |
Text Properties |
sprite(spriteReference).addFontXTV (fontName, fontSize, fontStyle) |
Adds a font to TreeView's internal font list. |
sprite(spriteReference).setFontXTV (fontID, fontName, fontSize, fontStyle) |
Modifies the properties of a font in the font list. |
sprite(spriteReference).getFontXTV (fontID) |
Returns a string containing font properties set for a font in the font list. |
sprite(spriteReference).getNumFontsXTV ( ) |
Returns the number of fonts currently in TreeView's font list. |
sprite(spriteReference).setTextHiliteColorXTV (textRed, textGreen, textBlue) |
Sets the highlight color that displays over node text when the user clicks on a node. |
Miscellaneous Properties |
sprite(spriteReference).getVersionXTV ( ) |
Returns the version string for TreeView. |
sprite(spriteReference).setRefconXTV (newID) |
Sets the id number that is passed to TreeView callback handlers to identify the tree that the user clicked. |
sprite(spriteReference).getRefconXTV ( ) |
Returns the current refcon number of the TreeView sprite. |
sprite(spriteReference).redrawXTV ( ) |
Updates the TreeView sprite display after visual tree properties have been changed. |