Elvis 6 action plug-ins setting - keyBindings – Home

The keyBindings setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Elvis 6 Action plug-ins - configuration settings.

Required No

Description

Platform specific keyboard bindings, for Windows and Mac OS X.

Note: If you assign key bindings to your plug-in, you need to specify an applicationMenu menuAssignment.

Key bindings are not required. When you do assign key bindings, make sure that two keyBinding elements are added, one with os="MacOSX" and the other with os="Windows".

Tip: Check if your key binding is not already used by one of the standard menu items, otherwise it will be ignored.

Basic setting

<action>
    <keyBindings>
        <keyBinding os="xxxx" key="x" modifiers="xxx"/>
        ...
    <keyBindings>
</action>

Parameters

Operating System the key binding applies to, possible values:

MacOSX
Windows

Required.

key

The key part of the key binding.

Required.

modifiers

Comma separated list of modifier keys. When this parameter is not specified, no modifiers will be used. The available valid modifiers are:

CMD = Command, only valid in combination with Mac OS X
ALT = MacOSX: Option, Windows: Alt
CTRL = Control
SHIFT = Shift

Optional.

Examples

<keyBindings>
    <keyBinding os="MacOSX" key="f" modifiers="CMD"/>
    <keyBinding os="Windows" key="f" modifiers="CTRL"/>
</keyBindings>

<keyBindings>
    <keyBinding os="MacOSX" key="f" modifiers="CMD,SHIFT"/>
    <keyBinding os="Windows" key="f" modifiers="CTRL,SHIFT"/>
</keyBindings>

<keyBindings>
    <keyBinding os="MacOSX" key="=" modifiers="CMD,CTRL,ALT,SHIFT"/>
    <keyBinding os="Windows" key="-" modifiers="SHIFT,CTRL"/>
</keyBindings>

Document history

18 February 2021: Updated the code in Basic Setting by adding the <keybinding> parameter.
18 February 2021: Corrected the examples by adding a forward slash to the ending of the <keybinding> parameter.

Parameters

Examples

Document history

Related articles