avail/avail.anvil.settings/ShortcutSettings

ShortcutSettings

data class ShortcutSettings(val keyboardShortcutOverrides: MutableMap<String, KeyboardShortcutOverride> = mutableMapOf()) : Settings

The Settings for KeyboardShortcuts.

Author

Richard Arriaga

Constructors

ShortcutSettings

constructor(keyboardShortcutOverrides: MutableMap<String, KeyboardShortcutOverride> = mutableMapOf())

Types

object Companion : SettingsType<ShortcutSettings>

The ShortcutSettings.Companion is also a SettingsType parameterized on ShortcutSettings.

Properties

jsonFormattedString

open val jsonFormattedString: String

jsonPrettyPrintedFormattedString

open val jsonPrettyPrintedFormattedString: String

keyboardShortcutOverrides

val keyboardShortcutOverrides: MutableMap<String, KeyboardShortcutOverride>

The map of KeyboardShortcutOverride.actionMapKey to KeyboardShortcutOverride that override the default key combinations for the listed KeyboardShortcuts.

val type: SettingsType<*>

The associated SettingsType. This is expected to be the companion object of the implemented subtype.

writeSettingsAction

open override val writeSettingsAction: JSONWriter.() -> Unit

The JSONWriter action that writes the data contained in these Settings to the JSONWriter.

Functions

fun applyOverrides()

Apply the KeyboardShortcutOverrides in this ShortcutSettings.

attemptShortcutImport

fun attemptShortcutImport(settings: ShortcutSettings): Map<KeyboardShortcutOverride, Set<KeyboardShortcut>>

Attempt to import the provided ShortcutSettings into keyboardShortcutOverrides only adding the ShortcutSettings.keyboardShortcutOverrides that do not conflict with any other shortcuts.

fun save()

Save to the environment settings directory in the keyBindingsOverrideFile.

fun saveToDisk(file: File)

Save this ShortcutSettings to the provided file.

override fun writeTo(writer: JSONWriter)