dagOpenTool

dagOpenTool(

x_backGroundColor
l_bBox
w_startingObject
t_name
t_help

) 

=> w_dagTool
 / 
nil

Description

Creates a dagTool object and opens a window in which to display the graph starting from the specified starting node.

Arguments

x_backGroundColor	The background color of the tool. Specifying -1 for this argument is the same as passing hivEditorBackgroundColor, which means the window is allowed to use the editor background color.
l_bBox	List specifying the lower-left and upper-right coordinates of the tool (in screen coordinates). If this list is nil, you are prompted to position the window on the screen.
w_startingObject	The node that the tool uses to start processing from. This property can be changed after the tool is opened.
t_name	Name displayed in the dag browser tool window banner.
t_help	A string giving the name of a symbol for the help message for this tool. It determines what is shown when you press the Help button in the dag browser tool’s banner line.

Value Returned

w_dagTool	The dagTool that was opened.
nil	The dagTool could not be opened.

Examples

tool = dagOpenTool( hiMatchColorByName("white"
list(100:100 400:400)
myNode "myTool" "xxxHelpSymbol" )

Additional Information

To close a dagTool, call hiCloseWindow.

hiCloseWindow( tool->window )

If you have specified a closeProc property on the tool, that procedure is called just before the tool or the window for it is destroyed. The user may close a dag tool by using a window manager Quit or Close button, which will also cause the closeProc to be called.

In closeProc you should be sure to destroy all the nodes and arcs you created for this graph that you no longer need. For example, if the nodes in this browser tool are used only in this browser and you have no nodes pushed on the starting object stack, you could call

dagDestroyNode( tool->startingObject )

Related Topics

dag Functions

Return to top