|
?viewType t_viewType
|
|
|
View type (or view subtype, if t_parentType is not nil) to which the application wants to attach itself.
An application can attach itself to any number of view types, but must call deRegApp once for each one. The list of predefined view types currently available are listed in “Predefined Views and ViewTypes.”
All view type and view subtype names must be unique. That is, if an application subclasses two different view types, it must use two unique subTypes even if the triggers are otherwise identical.
|
|
?parentType t_parentType
|
|
|
View type or view subtype that t_viewType subclasses.
|
|
|
An application can subclass any number of parentTypes, but must call deRegApp with a unique subType name for each one.
t_parentType does not have to be previously registered. However, an application can never be accessed until t_parentType is successfully registered.
If t_parentType is "", the data and application triggers must be specified, or an error results.
|
|
|
If t_parentType is not empty, these triggers must be nil, or an error results.
|
|
?appName t_appName
|
Name of the application.
This name is used for a number of purposes, including attaching a set of bindkeys to the window when the application is installed, and for clients of deOpen to use when they want to explicitly override the default application associated with a given view type.
When the application is registered, t_appName is registered as a bindkey prefix with the Human Interface code. Subsequently, hiSetBindKey can be called with t_appName to associate a key binding with the application.
The Human Interface code provides a mechanism for sharing bindkeys between multiple applications.
|
|
?help t_help
|
Help string for the application. Whenever the application is installed in a window, the window’s help string is set to this value.
|
|
?dataTrigger s_dataTrigger
|
|
|
SKILL function that will be called when the user has finished specifying to DE the particular design data to be edited. The data trigger has the responsibility of opening the data. The data trigger is discussed in detail in the next section.
A data trigger is always associated with a view type, such as maskLayout. If a data trigger for an application is not executed successfully, the following warning might display:
WARNING (DEBASE-102084): Data trigger for viewType %s failed.
|
|
?appTrigger s_appTrigger
|
|
|
SKILL function that is called after the data is installed in the window. The primary function of this routine is for the application to manage any runtime context required by the application. The application trigger is discussed in detail in the next section.
|
|
?enableTrigger s_enableTrigger
|
|
|
SKILL function that is called to determine if the application is enabled for use by the current user.
The enable trigger will normally do any appropriate security checks necessary to make this determination. This function should be defined in an autoload file, and not in the application context. Otherwise, the application context will be loaded even when the security checks fail.
This trigger is optional, and if omitted, no license check is made by the Design Editor. However, if licensing or other restriction is desired, then the application code is responsible for implementing it.
|
|
?menuTrigger s_menuTrigger
|
|
|
SKILL function that is called when the Design Editor determines that menus for the application must be installed in the banner.
This routine is normally defined in the application context and returns a list of menus to be installed when this application is required. If this trigger is omitted, the application itself must take responsibility for any banner menu initialization.
|
|
?postInstallTrigger s_postInstallTrigger
|
|
|
SKILL function that is called when the DE has finished all installation, including the banner menus, and displaying the window.
This is provided for those applications that need to finish up any initialization that must occur after menus are installed.
|
|
?viewNameSwitchTrigger s_viewNameSwitchTrigger
|
|
|
DE calls this SKILL function when switching from a subview type (from_viewtype) to a different root type (to_roottype).
If a valid subview name is returned, DE uses it, and installs the application of the view type. If nil is returned, DE installs the new root type application.
|
|
|
For example, DE calls this SKILL function when descending in a window or switching from schematicXL to a text.v.
However, switching from schematicXL to schematic does not call this trigger because there is no change in the root type of the application.
|
|
?widgetType t_widgetType
|
|
|
Window widget type the application needs.
Whenever the application is installed in a window, the window’s widget type is set to this value. This value can only be set for root class view types.
The value must be either text, corresponding to plain text data, or graphics, corresponding to general graphically displayed data. This value defaults to graphics if not supplied.
|
|
?noCadenceMenu g_noCadenceMenu
|
|
|
Flag indicating whether the standard Cadence menu is desired as the first item in the menu banner.
If nil, the Cadence menu will be supplied automatically. If if is t, the Cadence menu will not appear.
The default is nil, so only applications which explicitly do not desire this menu need to supply it.
Design Editor clients not using this menu are advised that this menu contains all the basic Design Editor commands, and that those which apply to the application (particularly deReturn) should be made available to the user in some manner.
|
|
?windowBBoxProc s_function
|
|
|
Function to register. The function is passed the t_appName so it must accept a string and return a hi window bbox specification where the first coordinate is the lower left corner and the second coordinate is the upper right corner.
hi bbox’s are based on a screen where (0,0) is the lower left hand corner of the screen.
|
|
?appTitle t_appTitle
|
|
|
Name that will appear on the customize menu for this application.
|
|
?exclusive g_exclusive
|
|
|
An optional argument, which causes the view to be opened in a new window if its view type is flagged exclusive and there already exists a view type (ancestor or sub view type that is also exclusive) in the current session window.
|
