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

hiDisableAsstBindKeyPrefix

hiDisableAsstBindKeyPrefix(
t_prefix 
)
=> t

Description

Adds the specified bindkey prefix also known as an appType, which is associated with a dock window (assistant), to the list of disabled bindkey prefixes. As a result, the bindkeys defined using that prefix are disabled.

If the prefix for a dock window exists in the list, the bindkeys associated with that prefix are not used for the dock window; instead it uses the bindkey definition of the main window.

Argument

t_prefix

The bindkey prefix.

Value Returned

t

The bindkey prefix was added to the list. Always returns t.

Examples

The Palette assistant defines its own bindkeys with the prefix Palette. For example, when the input focus is in the main window, the F11 key toggles on and off the assistants that are open, however, when the focus is in the Palette, the F11 key toggles on and off the Palette toolbars.

hiDisableBindKeyPrefix("Palette")

This function call adds the bindkey prefix Palette to the list of disabled prefixes. If you now press F11 with the focus in the Palette, it will toggle on and off the assistants that are open, that is, the bindkeys defined using the Palette bindkey prefix are no longer in effect.

Related Topics

Bindkey Functions


Return to top
 ⠀
X