hiConfigureBindKeys
hiConfigureBindKeys(
?showOnlyApps l_apps
?showAllChildren g_showAllChildren
?selectApp t_appname
?selectKeyBinding t_keyBinding
?showEmptyApps g_showEmptyApps
?showInheritedBindings g_showInheritedBindings
)
=> t / nil
Description
Resets and displays the Bindkey Configuration form according to the supplied arguments. If the form is currently open, and contains unsaved changes, it will prompt before resetting the data.
See also Configuring Application Bindkeys.
Arguments
|
?showOnlyApps l_apps
|
|
|
Accepts a string, or list of strings, where each string specifies the name of an application which will appear in the application tree in the Bindkey Configuration form. The default is "", which means that all applications with bindkeys defined will be shown. Wildcards can also be used, for example, ?showOnlyApps "Schematics*".
|
|
?showAllChildren g_showAllChildren
|
|
|
Boolean argument, where, by default, if a root application is matched, then all children of that application will be shown, rather than only those children which also match one of the supplied application names. Defaults to 't', but set to 'nil' to show only children of root applications that match the strings passed to ?showOnlyApps.
|
|
?selectApp t_appname
|
|
|
The name of the application to select in the application tree when the Bindkey Configuration form is displayed. Wildcards are accepted and the first match will be selected.
|
|
?selectKeyBinding t_keyBinding
|
|
|
The keybinding string to be selected in the key table. The string need not be an exact string match for the keybinding. That is, it enough for the representation of the keybinding to be the same. For example, passing "CtrlShift<Key>a" will select "ShiftCtrl<Key>A", if found in the tree.
|
|
?showEmptyApps g_showEmptyApps
|
|
|
Boolean argument that is the equivalent to the Show applications with no bindkeys defined checkbox option in the Bindkey Configuration form. The default value is 'Default, which indicates that the Bindkey Editor form will be opened with the same settings that were made the last time when the form was closed.
|
|
?showInheritedBindings g_showInheritedBindings
|
|
|
Boolean argument that is the equivalent to the Show inherited bindings checkbox option in the Bindkey Configuration form. This will determine whether bindings that are inherited from a root app are shown when a child app is selected. The default value is 'Default, which indicates that the Bindkey Editor form will be opened with the same settings that were made the last time when the form was closed.
|
Values Returned
|
t
|
Bindkey configuration form successfully reset and displayed.
|
|
nil
|
Command failed.
|
Examples
hiConfigureBindKeys()
=> t
Related Topics
Bindkey Functions
Return to top
