deRegPlugin
deRegPlugin(
t_appName
s_className
s_superClass
[ ?appTitle t_appTitle ]
[ ?bindkeys l_bindkeys ]
[ ?group t_group ]
[ ?help t_help ]
[ ?pluggableMainApps g_pluggableMainApps ]
[ ?pluggableViewTypes l_pluggableViewTypes ]
[ ?shortDescription t_shortDescription ]
[ ?excludeViewTypes l_excludeViewTypes ]
)
=> l_appClassInfo
Description
Registers the characteristics of plugins.
This function issues a warning in the following situations:
-
a class symbol is already used by an application
-
a plugin application name is already registered, or used as an application tool name.
Arguments
|
t_appName
|
Specifies a name for the plugin. This name is used for a number of purposes, including attaching a set of bindkeys to the window when the plugin is installed.
|
|
s_className
|
Specifies the name of the SKILL++ class. If not already loaded, the class and superclass (from which this plugin class is implemented) are auto-loaded when deInstallPlugin is applied to t_appName or s_className. For information about autoloading your classes, see "Autoloading Your Classes".
|
|
s_superClass
|
Specifies the name of the superclass from which the s_className is derived
|
|
?appTitle t_appTitle
|
|
|
Specifies the name that is to appear on the slider menu for this plugin. If no t_appTitle is specified, t_appName is used on the slider menu. You can also use the mnemonic ampersand (&) symbol in the title.
|
|
?bindkeys l_bindkeys
|
|
|
Specifies a list of bindkeys for the plugin that will be passed to hiSetBindKeys. This list does not need to include any bindkeys that are defined by the superclass(es) of the plugin. This is because when the plugin is installed, the design editor calls hiSetBindKeys with collective bindkeys (defined by this plugin and by the superclass(es) of this plugin.)
|
|
?group t_group
|
Specifies a name to group plugins together on the slider menu. If specified, the grouped plugins are displayed in a submenu with the group name (t_group).
|
|
?help t_help
|
Specifies a help string for the plugin. However, this value is not currently used.
|
|
?pluggableMainApps g_pluggableMainApps
|
|
|
Specifies a list of main application names, such as list("Schematics" "Schematics XL"), or a single string “ALL”, on which the plugin can be installed using deInstallPlugin
|
|
?pluggableViewTypes l_pluggableViewTypes
|
|
|
Specifies a list of view (sub) types (string) on which the plugin can be installed using deInstallPlugin.If main application names are not specified, but a list of view (sub) types is given, the plugin can be installed to all applications associated with the view (sub) types.
|
|
?shortDescription t_shortDescription
|
|
|
Specifies a brief description of the plugin. If specified, the description is displayed in the prompt line at the bottom of the window when the plugin name is highlighted in the Window –Plugins menu.
|
|
?excludeViewTypes l_excludeViewTypes
|
|
|
Specifies a list of view types on which the plugin cannot be installed
|
Value Returned
|
l_appClassInfo
|
Returns a copy of the registration information associated with the plugin, if the registration is successful
|
|
nil
|
Returns nil if the registration is not successful
|
Examples
deRegPlugin("My Plugin" 'MyPlugin 'DEPlugin ?pluggableMainApps '("Schematics" "Schematics XL"))
This example registers a plugin with the application name MyPlugin, which can be installed on VSE, and VSE-XL application windows.
deRegPlugin("My Plugin" 'MyPlugin 'DEPlugin ?pluggableViewTypes '("schematic"))
This example registers MyPlugin so that it can be installed on all applications associated with view type schematic, such as VSE and VSE XL applications.
deRegPlugin("My Plugin" 'MyPlugin 'DEPlugin ?appTitle "My &Plugin" ?pluggableViewTypes '("schematic"))
This example registers MyPlugin with an appTitle.
deRegPlugin( "MyPlugin" ...
?pluggableMainApps '("Text Editor XL")
?pluggableViewTypes '("schematic")?excludeViewTypes '("text.veriloga"))
Return to top
