The ITREGISTER procedure is used to register tool object classes or other iTool functionality with the IDL Intelligent Tools system.
This routine is written in the IDL language. Its source code can be found in the file itregister.pro in the lib/itools subdirectory of the IDL distribution.
ItRegister, Name, ItemName [, TYPES=string] [, /UI_PANEL] [, /UI_SERVICE] [, /VISUALIZATION]
A string containing the name used to refer to the associated class once registration is completed. Subsequent calls to create items of this type will use this name to identify the associated class.
A string containing the class name of the object class or user interface routine that is to be associated with Name. When an item of name Name is requested from the system, an object of this class is created or the specified routine is called.
| Note |
This keyword is only used in conjunction with the UI_PANEL keyword.
Set this keyword equal to a string or string array containing iTool types with which the UI panel should be associated. When the registered type of a UI panel matches the registered type of an iTool, the panel will be displayed as part of the iTool's interface.
Set this keyword to indicate that a UI panel is being registered with the system. When this keyword is set, the value of Name is the string used to refer to the panel and ItemName is the routine that should be called when the panel is created.
To specify that the UI panel is associated with a particular iTool or iTools, set the TYPES keyword to the iTool types that should expose this panel.
Set this keyword to indicate that a UI service is being registered with the system. When this keyword is set, the value of Name is the string used to refer to the UI service and ItemName is the routine that should be called to execute the service.
Set this keyword to indicate that a visualization is being registered with the system. When this keyword is set, the value of Name is the string used to refer to the visualization type, and ItemName is the name of the visualization type's class definition routine.
Suppose you have an iTool class definition file named myTool__define.pro, located in a directory included in IDL's
ITREGISTER, 'My First Tool', 'myTool'
Tools defined by the myTool class definition file can now be created by the iTool system by specifying the tool name My First Tool.
Similarly, suppose you have a user interface service defined in a file named myUIFileOpen.pro. Register this UI service with the iTool system with the following command:
ITREGISTER, 'My File Open', 'myUIFileOpen', /UI_SERVICE
Finally, suppose you have a user interface panel defined in a file named myPanel.pro, and that you want this panel to be added to the user interface of iTools registered with the TYPES property set to MYTOOL. Register this UI panel with the iTool system with the following command:
ITREGISTER, 'My Panel', 'myPanel', /UI_PANEL, TYPES = 'MYTOOL'
Introduced: 6.0