Trigger Functions
This topic provides a list of Cadence® SKILL function categories associated with the Trigger arguments.
The data, application, and user triggers are passed a single argument, which is a disembodied property list. The list can be updated at various times during the process as necessary. All properties will be present in the list at the time the trigger is called; if any property can’t be determined, then the operation is a failure and will be aborted before calling any triggers. The list of properties is as follows:
|
l_args->libName
|
Cellview library name
|
(string)
|
|
l_args->libId
|
Cellview library ID
|
(dbId)
|
|
l_args->configName
|
Configuration name
|
(string)
|
|
l_args->cellName
|
Cellview cell name
|
(string)
|
|
l_args->viewName
|
Cellview view name
|
(string)
|
|
l_args->viewId
|
Cellview view ID
|
(dbId)
|
|
l_args->viewNameList
|
View name switchlist
|
(string)
|
|
l_args->accessMode
|
Desired access mode
|
(string)
|
|
l_args->viewType
|
viewType or viewSubType of the application
|
(string)
|
|
l_args->rootType
|
Root viewType of the view
|
(string)
|
|
l_args->appName
|
appName of the application being installed
|
(string)
|
|
l_args->help
|
Help string of the application being installed
|
(string)
|
|
l_args->action
|
Current action (see below)
|
(string)
|
|
l_args->window
|
Window in which to install the data
|
(window)
|
|
l_args->srcContext
|
Source context ("copy" only)
|
(any data type)
|
|
l_args->oldCellView
|
Previously installed cellview ("swap" only)
|
(dbId)
|
|
l_args->eip
|
t if this is an edit in place, nil otherwise
|
|
|
l_args->pushed
|
Context push state
|
(t/nil)
|
|
l_args->config
|
The Hierarchy Manager configId, if any, associated with the current window.
|
|
|
l_args->action
|
Describes the situation in which the data is being installed in the window. Not all actions apply to all triggers, and when an action doesn’t apply, the trigger is not called. The possible actions are:
|
|
|
’open
|
Open cellview (data triggers only)
|
|
|
’install
|
Create context for display or stacking
|
|
|
’close
|
Stack item going away - close cellview / delete context
|
|
|
’push
|
Cellview being pushed underneath another
|
|
|
’pop
|
Cellview being popped from underneath another
|
|
|
’change
|
Access mode for cellview changed
|
|
|
|
’reset
|
Discard edits executed for this cellview
|
|
|
’save
|
Cellview was saved to disk
|
|
|
’copy
|
Copy window - stack and contexts are all copied
|
|
|
’copyInstall
|
Install after copy
|
|
|
’swap
|
Replace the current cellview with a new one of same type
|
|
|
’activate
|
Install a plugin in a window
|
|
|
|
’deactivate
|
Remove the plugin from the window
|
|
|
l_args->viewType
|
The viewType or viewSubType corresponding to the application which is being installed. l_args->rootType is the viewType of the root of the class tree containing l_args->viewType.
|
The triggers return nil if the operation fails. For successful returns, in some cases data is returned; in others, t.
Only the functions listed under the categories given below are supported for public use. All other functions, regardless of their name or prefix, and undocumented aspects of the functions, are private and are subject to change at any time.
Return to top
