hiRegSetBindKeyProc

hiRegSetBindKeyProc(
t_application
S_function
[ g_notInherited ]
)
=> t / nil

Description

Registers a SKILL function that will be called after a bindkey is set for the specified application with the hiSetBindKey function or the CIW Key or Mouse Binding form, or after a set of bindkeys is defined with the hiSetBindKeys function.

If there are any errors while setting a bindkey with hiSetBindKey, the function will not be called. If an error prevents hiSetBindKeys from setting any bindkeys, the function will not be called; however, errors during the setting of individual keys will not prevent the function from being called. The function will be called even if no change occurred as a result of calling hiSetBindKey or hiSetBindKeys.

If you are registering an application that inherits bindkeys from another application, you should also register the function with the root application that it inherits them from. This will allow you to view all changes made to the bindkeys that apply to the alias application.

You can use the hiGetBindKeyInheritRoot function to get the base application.

Arguments

t_application

Application prefix registered with hiRegisterBindkeyPrefix.

S_function

Name or symbol of the SKILL function to be called whenever a bindkey is set for the application.

The function will be passed two arguments. The first argument is a string specifying the bindkey prefix. The second argument is a list of the bindkeys that were updated (each item in the list is a list containing the bindkey and the command it was set to, in the same format as the l_bindkeyList argument of hiSetBindKeys). The return value of the function will be ignored.

g_notInherited

If this argument is specified, and it not set as nil and the applicationType specified is an alias, then inherited commands will not be returned.

If the argument is not specified, or it is nil, then the command returned may be inherited from the root application.

Values Returned

`t`	The function was registered.
`nil`	t_application is not registered, t_application inherits from another application prefix, or S_function is not a valid name or symbol. A warning is also displayed.

Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023