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

hiGetBindKey

hiGetBindKey(
[ t_applicationType ] 
[ t_key ] 
) 
=> t_skill_cmd / nil

Description

Returns the SKILL command string bound to a key or mouse button for an application.

If t_applicationType or t_key is not specified, a bindkey form is displayed.

Arguments

t_applicationType

Any user-type string that has been registered using deRegApp or hiRegisterBindKeyPrefix. If not specified, a bindkey form is displayed. The application type can be on eof the following strings:

  • Command Interpreter: Command Interpreter Window (CIW)
  • Schematics: Schematics Window
  • Show File: Show File Window
  • wa: Waveform Window

t_key

String specifying the key sequence, the operator, detail, and occurrences. If not specified, a bindkey form is displayed. Items in this list are:

  • modifier_list (optional)
  • operator
  • detail (optional)
  • occurrences (optional)

If t_key ends with “EF”, the SKILL function is used in enterfunction mode. If not, it is a non-enterfunction mode command.

Values Returned

t_skill_cmd

The associated SKILL function string if one is associated with the specified application type and key sequence.

nil

t_applicationType or s_key is invalid. A warning is also issued.

Examples

Display the Bindkey Editor form.

hiGetBindkey(“Layout”)

The following examples retrieve information about different bindkeys in layout. 

hiGetBindKey("Layout" "<Key>z")
=> "hiZoomIn()"
hiGetBindKey("Layout" "<Key>Up")
=> "geScroll(nil \"n\"    nil)"
hiGetBindKey("Layout" "Ctrl<Key>J")
=> "leHiFlip()"
hiGetBindKey("Layout" "Ctrl Shift <Key>J")
=> "drdCompactSelSet('right)"
hiGetBindKey("Layout" "Ctrl Shift <Btn1Down>")  ; Btn1Down – button of mouse
=> "hiZoomInMagnifier(hiGetCurrentWindow())"

Related Topics

Bindkey Functions

hiRegisterBindKeyPrefix


Return to top
 ⠀
X