avail/avail.anvil.shortcuts/KeyboardShortcut

KeyboardShortcut

abstract class KeyboardShortcut : BaseKeyboardShortcut

An abstract keyboard shortcut used to perform some action in Anvil.

NOTE Keyboard shortcuts must adhere to the following implementation rules:

All non-abstract subclass implementations must be a child type of a sealed class that corresponds to a KeyboardShortcutCategory.
All non-abstract subclass implementations must be an object.
All abstract subclass implementations must be a sealed class that corresponds to a single KeyboardShortcutCategory.

Author

Richard Arriaga

Inheritors

AvailDebuggerShortcut

AvailEditorShortcut

CodePaneShortcut

FileEditorShortcut

TextPaneShortcut

WorkbenchShortcut

Constructors

KeyboardShortcut

constructor()

Properties

abstract val actionMapKey: String

The key that identifies this BaseKeyboardShortcut.

abstract val category: KeyboardShortcutCategory

The KeyboardShortcutCategory this shortcut belongs to.

open val customizable: Boolean = true

This KeyboardShortcut is permitted to customized for an environment.

abstract val defaultKey: Key

The default Key when pressed triggers this shortcut.

abstract val description: String

The description of the action the shortcut performs.

descriptionDisplay

val descriptionDisplay: String

The description that is displayed that describes the shortcut or the actionMapKey if the description is empty.

abstract var key: Key

The key of this BaseKeyboardShortcut.

open val keyStroke: KeyStroke

The KeyStroke used to trigger this KeyboardShortcut.

shortcutOverride

val shortcutOverride: KeyboardShortcutOverride

A corresponding KeyboardShortcutOverride sourced from this KeyboardShortcut.

Functions

open fun addToInputMap(inputMap: InputMap)

Add this KeyboardShortcut to the provided InputMap.

open fun matchesOther(bks: BaseKeyboardShortcut): Boolean

Check to see if the provided BaseKeyboardShortcut matches the key bindings of this BaseKeyboardShortcut while having different actionMapKeys.

resetToDefaults

fun resetToDefaults()

Reset the key to the defaultKey.

fun updateFrom(keyStroke: KeyStroke): Boolean

Update this KeyboardShortcut to match the ModifierKeys and KeyCode used in the provided KeyStroke.