hiShowBindKeys

hiShowBindKeys(
[ g_appTypeOrWindow ]
[ g_showInheritBindings ]
)
=> t / nil

Description

Displays the bindkeys for an application type or window in a Viewfile window.

You can save the window contents to a file by selecting Save or Save As from the File pulldown menu or using the hiSaveViewfile() or hiSaveAsViewfile() functions. After saving the file, you can load it into another Opus session using the load() or loadi() SKILL functions.

If there is any bindkey inheritance for this bindkey table, the application aliases are displayed at the top of the window. If g_appTypeOrWindow is missing, a bindkey form is displayed.

This is a wrapper function. Depending on the type of the argument, it calls hiShowBindKeysByAppType or hiShowBindKeysByWindow.

Arguments

g_appTypeOrWindow	String or window ID. If it is a string, the argument is interpreted as an application type and the bindkeys are displayed using the hiShowBindKeysByAppType function. If it is a window ID, the bindkeys are displayed using the hiShowBindKeysByWindow function. If g_appTypeOrWindow is not specified, or is an empty string, then the Bindkey Editor is displayed. If the application type is specified, it must have been previously registered either through deRegApp or hiRegisterBindKeyPrefix.
g_showInheritBindings
	If the g_appTypeOrWindow argument is an application type, then this argument is passed to hiShowBindKeysAppType. Otherwise, it is ignored.

Values Returned

t	The bindkey is displayed.
nil	g_appTypeOrWindow is invalid. A warning is also issued.

Related Topics

Bindkey Functions

hiRegisterBindKeyPrefix

hiShowBindKeysByAppType

hiShowBindKeysByWindow

Bindkey Editor

Return to top