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

hiSetBindKeys

hiSetBindKeys(
t_applicationType 
l_bindKeyList 
) 
=> t / nil 

Description

Sets multiple bindkeys for an application at one time. For memory and performance efficiency, use this function instead of hiSetBindKey if you are setting multiple bindkeys. For information about restrictions, see hiSetBindKey.

Arguments

t_applicationType

Any user-definable string that has been registered through hiRegisterBindKeyPrefix or a Cadence application type. You can get a list of registered bindkey prefixes for applications that you are running with the hiGetBindKeyPrefixList function or the Key or Mouse Binding form.

If this argument is not specified, a bindkey form is displayed.

l_bindKeyList

The list of bindkey lists. Each list is a bindkey setting with the following format:

list( 
t_key
t_skill_cmd
[ t_EFskill_cmd ]
)

t_EFskill_cmd is the same as t_skill_cmd when the t_key argument ends with enterfunction mode. Do not add EF to the end of the t_key argument.

The only way to invalidate a command is to replace it with another command or with an empty string. If you set the t_skill_cmd argument to nil when a non-enterfunction command is already defined for the key, it will not be changed. This rule also applies to t_EFskill_cmd and enterfunction commands if they are nil or if they are not passed.

Values Returned

t

The bindkeys are set.

nil

There was an error.

Additional Information

To set multiple bindkeys, use the hiSetBindKeys() function, which is much more efficient than multiple calls to hiSetBindKey().

The following restrictions apply to setting bindkeys:

Bindkey customizations cannot be used in Layout Viewer. Any updates to the existing bindkeys or user-defined bindkeys are available only in Layout XL and Layout EXL . If you try to customize a bindkey for Layout Viewer, a one-time warning is displayed to inform you that these bindkeys are not available in Layout Viewer when Layout Viewer is opened. You can set noWarnOnLVBindKeyCustomization to t to disable this warning message.

Related Topics

Bindkey Functions

hiBindKeyModifiers

hiGetBindKeyPrefixList

hiRegisterBindKeyPrefix

hiSetBindKey

noWarnOnLVBindKeyCustomization


Return to top
 ⠀
X