Keyboard Preferences - Audacity Development Manual

# Keyboard Preferences

From Audacity Development Manual

Keyboard Preferences lists, searches for and sets the keyboard shortcuts which can be used for numerous commands in Audacity as an alternative to using Menus, Toolbars or mouse gestures. A full list of the commands with their default shortcut key bindings is available at Keyboard Shortcut Reference.

The default set of shortcut key bindings can be added to, changed or removed here if desired.

| For menu commands that are enabled (not grayed-out) if you Shift and click on the sub-menu item, instead of executing the command the Keyboard Preferences opens at the chosen command.

  Accessed by: Edit > Preferences > Keyboard (on a Mac Audacity > Preferences > Keyboard )

Click in the left column for other preferences

  Keyboard Preferences.

## View by

There are three ways of viewing the shortcut keys or "bindings" which you can select by clicking on the appropriate radio button. The view chosen when you click OK to close Preferences is remembered when you access Keyboard Preferences next time.

### Tree

This is the default view. On the left-hand side, it lists all the commands to which keyboard shortcuts can be assigned. On the right-hand side, the currently assigned shortcut for each command is shown (if any). The commands are grouped then listed within each group in the same order in which they appear in the Audacity Menu Bar. If a group of items are in a sub-menu within their Menu Bar, that group appears in the tree indented to right as a sub-group within their group. There is a final "Command" category listed in alphabetical order for commands which do not have a Menu Bar entry.

The menu groups and sub-groups ("branches" in this "tree" view) always open fully expanded. You can click on any branch's collapse button to collapse the branch. Any branch which is collapsed can be expanded by clicking on its expand button.

Keyboard use:

- Use Left arrow when on a group or sub-group's title row to collapse the group or sub-group, or when on an item in an expanded group or sub-group to jump to the title row of that group or sub-group.
- Use Right arrow to expand a collapsed group or sub-group.
- Up arrow and Down arrow navigate up and down the items in "Tree" view and also do so in the "Name" and "Key" views.

To navigate through all commands and title rows starting with a particular letter, type that letter.

Search box: Typing in the "Tree" view search box looks for that text string in a command name, title row or shortcut. You can enter text in upper or lower case (search is not case-sensitive).

Tree View Search Examples

- Entering zoom finds the four Zoom items in View Menu and the Zoom Tool command.
- Entering just z finds all menu items or commands that include the letter z, plus shortcuts that include Z.
- Entering +j finds only shortcuts that include a modified "J", so by default Ctrl + J, Ctrl + Alt + J, Alt + J, Alt + Shift + J and Shift + J. "Tree" View is the only way to find all shortcuts that use a given modifier letter.

If you have non-default shortcuts and press the Defaults button as below to restore the default shortcut set, the search results for your entered text will be updated. Empty the text in the Search box to restore the complete Tree list.

### Name

"Name" view lists on the left-hand side all the commands in alphabetical order, with no grouping. On the right-hand side, the currently assigned shortcut for each command is shown (if any).

To navigate through all commands starting with a particular letter, type that letter.

Search box: Typing in the "Name" view search box works similarly to search in "Tree" view, except that the text string you type is searched for only in command names and title rows and not in shortcuts. This can give more focused search results when you really only want to search in the command name.

Name View Search Examples

- Entering Shift finds the Effect menu item "Sliding Time Scale / Pitch Shift" and the "Time Shift Tool" command, but excludes all the shortcuts that include the Shift modifier.
- Entering just b finds all menu items or commands that include the letter "b", but does not find the "Play to Selection" command with its default shortcut of "B". "Tree" view would find it but the quickest way to find what the "B" command does would be to type it into the "Hotkey" box when in "Key" view (see next section).

### Key

"Key" view is the easiest to use to ascertain which keys or key combinations are currently assigned and which are not. By default it lists on the left-hand side all the currently assigned shortcuts in alphabetical order of the shortcut, followed by all the commands that currently have no shortcut assigned to them (in alphabetical order of the command).

To navigate through all shortcuts starting with a particular letter, type that letter.

The "Key" view search box is called Hotkey. To use this, click in or Tab into the box then press the shortcut combination you are searching for, just as you would press the shortcut combination you want to set in the shortcut input box. You can also search for one letter only in the shortcut itself (this excludes searching for that letter in the modifier).

Key View Search Examples

- Pressing Ctrl + Shift + E when you have default shortcut assignments shows that the command "Export Audio..." is using this shortcut.
- Pressing F6 when you have default shortcut assignments shows that the command "Multi Tool" is using the F6 shortcut and also that "Ctrl + F6" and "Ctrl + Shift + F6" are in use.
- Pressing D when you have default shortcut assignments shows that the command "Next Tool" is using the "D" shortcut, and that one other command ("Ctrl + D" for Duplicate) uses the "D" key combined with a modifier.
- Pressing Alt + Y when you have default shortcut assignments shows no result in the list, indicating this shortcut is available to assign to a command.

| You cannot use shortcuts in the Hotkey box to empty the box, for example Delete. After switching back to "Tree" or "Name" view, you can then use the Delete or any other method to empty the box and display the complete list.

## Input box, Set and Clear buttons

- To change or add a shortcut binding:
  1. Click in the list window to select the item you want to change. The entry will be highlighted and the current key combination for that command (if any) will now appear in the input box to left of the Set button.
  2. Either click in the input box, or press Tab once to switch focus to it.
  3. Choose your binding by either holding any modifier key (or combination of modifiers) then pressing any non-modifier key, or press any non-modifier key on its own. Valid modifiers are:
     - Shift
     - Ctrl ( ⌘ on a Mac)
     - Alt ( Option on a Mac)
     - Altgr or Right Alt (on Windows keyboards, this key sends a combined Ctrl + Alt modifier and can thus be used as an alternative to call any binding that includes Ctrl + Alt). </ul>

    As an example, Shift + 6 or Ctrl + Shift + P are both valid bindings. Your chosen key or key combination will now replace the previous content of the input box.

- Click Set to apply your desired change.

If your chosen shortcut is already assigned to a command, Audacity will show a dialog asking you to confirm the change. Click OK to assign your chosen shortcut to the chosen command. This will remove the shortcut for the command that originally used it, leaving that command with no shortcut. Click Cancel to make no change of shortcut.

- Click the OK button to confirm your changes - or click Cancel to make no change of shortcut. If you omit this step then the changes will be aborted.
- Clear: To remove a shortcut binding, select the item as in step 1 above, then press Clear.

| You cannot set the main system shortcut for Escape, E on Windows or Alt + C on some Linux systems, as a binding.

## Export..., Import... and Defaults buttons

- Export... and Import...: You can export and import shortcut bindings (for example to keep a safe copy of your custom settings, or to transfer them to Audacity on another machine). The Export... button exports your bindings as an XML file, and Import... imports the XML file back again. You can also edit the XML file in any text editor and re-import it, as an alternative to editing the shortcuts in Preferences.

Audacity does not check for shortcuts which are allocated to more than one command when importing the file, so edit carefully.

The only entries you can usefully edit are the actual key bindings themselves which are in the "key" string at the end of each command. For example, to set the key binding for "New" to Shift + N, the command in the XML file should read:

<command name="New" label="New" key="Shift+N"/>

Be sure not to delete the closing "/>" characters at the end of the command.

- Defaults: There are two sets of default shortcuts available in Audacity. The default set is "Standard". This set is a reduced set to simplify the set of shortcuts somewhat and to provide greater flexibilty for users who wish to create their own shortcuts.

  The other available set of shortcuts is "Full". This set is, as the name suggests the full and extensive set of shortcuts that were available in Audacity 2.1.3 and earlier. You can choose to revert to the full set of shortcuts by selecting "Full" from the dropdown menu accessed from the Defaults button in the Keyboard Preferences dialog.

  You can use the Defaults button to switch between the two provided default sets of shortcuts at any time.

  This button is also handy if you are making custom shortcuts and decide you have not got your changes right and want to start over again.

## OK and Cancel buttons

- OK: When you have completed your edits press the OK button to save the new shortcut bindings and exit the Preferences dialog.
- Cancel: If you press the Cancel button this aborts the editing. All shortcuts will remain as they were before you started to edit them and the Preferences dialog will be exited.