hiBindKeyModifiers

hiBindKeyModifiers(
[ s_type ]
)
=> l_modifiers

Description

Returns the list of modifiers that can be used with bindkeys in the current session. You can specify the type of keys for which you want the list of legal modifiers: printable, mouse, or function.

By default Alt cannot be used as a modifier with any printable characters (alphanumeric and special characters) because it is used as a modifier for menu access keys. Alt can be used with function keys and for mouse bindings. However, if menu access keys are disabled, Alt is a legal modifier for all keys, including printable characters.

To enable Alt for printable characters in bindkeys, you need to disable menu access keys.

If a window manager or desktop, such as CDE, predefines an Alt+key or Alt+mouseButton binding, then that combination will not work as a menu access key or bindkey on that system.

Argument

s_type

The type of keys for which to return legal modifiers. One of the following symbols:

’printable: For printable ASCII characters: alphanumeric and special characters
’mouse: For mouse buttons (click, drag, double-click)
’function: For function keys. The following keys are considered function keys:
Any key whose name begins with F# or KP_ (for keypad keys) or osf (for OSF virtual key binding names)
Support of Xt/Motif will be removed from a future Virtuoso release. Resultantly, the use of OSF virtual key names will no longer be possible, as that facility is specific to Xt/Motif. They should therefore be avoided.
Any of the following keys: Activate, AddMode, Again, Back, BackSpace, BackTab, Begin, BeginLine, Break, Cancel, Clear, Copy, Cut, Del, Delete, Down, End, EndLine, Enter, Esc, Escape, Find, Forward, Front, Help, Home, Ins, Insert, Left, Menu, MenuBar, Next, Open, PageDown, PageLeft, PageRight, PageUp, Paste, Pause, PgDn, PgUp, PrimaryPaste, Print, PrintScreen, Prior, Props, QuickPaste, Redo, Refresh, Return, Right, ScrollDown, ScrollUp, Select, Space, Stop, SysReq, Tab, Undo, Up

Values Returned

l_modifiers

List of modifiers that can be used with the type of keys specified.

Examples

Returns the list of modifiers for the ’printable keys.

hiBindKeyModifiers(’printable)

=> ("Shift" "Ctrl" "Meta")

Returns the list of modifiers for the ’function keys.

hiBindKeyModifiers(’function)

=> ("Shift" "Ctrl" "Alt" "Meta")

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