IDLitTool::RegisterManipulator

Syntax | Arguments | Keywords | Version History

The IDLitTool::RegisterManipulator procedure method registers a manipulator component with the iTool. Once registered, the iTool has the ability to instantiate this type of component when needed.

When a manipulator class is registered with the system, an object of the given class is created and added to the tools manipulator manager (an instance of IDLitManipulatorManager). To reference the new manipulator, the identifier that is provided should be prepended with the MANIPULATORS identifier level.

Syntax

Obj->[IDLitTool::]RegisterManipulator, Name, ClassName [, /DEFAULT] [, DESCRIPTION=string] [, ICON=string] [, IDENTIFIER=string]

Arguments

Name

A string containing the human readable name of the component type being registered with the iTool.

Note
If the IDENTIFIER keyword is not supplied, the Name argument will be used as the basis for the component's identifier.

ClassName

A string containing the class name of the component being registered. This class name is used by the iTool object to instantiate a component of this type when requested by the system.

Keywords

Note
Any keywords provided to this routine but not listed here are treated as property defaults for the registered item and applied to the registered object when it is created.

DEFAULT

If set, this registered item will be treated as the default manipulator for this iTool. Only one default manipulator can exist at anytime.

DESCRIPTION

Set this keyword to a string that provides a brief description of the component being registered.

ICON

Set this keyword to the icon that should be used when displaying the manipulator in an iTool menubar. See System Resources (iTool Developer's Guide) for additional details.

IDENTIFIER

Set this keyword to the identifier that should be used by the system for this visualization type. If not provided, an identifier is constructed from the provided name value.

Note
If an item with the specified identifier has already been registered with the iTool system, the existing item will be replaced by the new item.

Version History