plugins.core.shortcuts.prefs

Shortcuts Preferences Panel


API Overview

Constants - Useful values which cannot be changed

  • DEFAULT_SHORTCUTS

Functions - API calls offered directly by the extension

  • getGroupEditor
  • init
  • setGroupEditor

Fields - Variables which can only be accessed from an object returned by a constructor

  • lastGroup

API Documentation

Constants

DEFAULT_SHORTCUTS

   
Signature plugins.core.shortcuts.prefs.DEFAULT_SHORTCUTS -> string
Type Constant
Description Default Shortcuts File Name
Notes None
Source src/plugins/core/shortcuts/prefs/init.lua line 33

Functions

getGroupEditor

   
Signature plugins.core.shortcuts.prefs.getGroupEditor(groupId) -> none
Type Function
Description Gets the Group Editor
Parameters
  • groupId - Group ID
Returns
  • Group Editor
Notes None
Examples None
Source src/plugins/core/shortcuts/prefs/init.lua line 640

init

   
Signature plugins.core.shortcuts.prefs.init(deps, env) -> module
Type Function
Description Initialise the Module.
Parameters
  • deps - Dependancies Table
  • env - Environment Table
Returns
  • The Module
Notes None
Examples None
Source src/plugins/core/shortcuts/prefs/init.lua line 571

setGroupEditor

   
Signature plugins.core.shortcuts.prefs.setGroupEditor(groupId, editorFn) -> none
Type Function
Description Sets the Group Editor
Parameters
  • groupId - Group ID
  • editorFn - Editor Function
Returns
  • None
Notes None
Examples None
Source src/plugins/core/shortcuts/prefs/init.lua line 623

Fields

lastGroup

   
Signature plugins.core.shortcuts.prefs.lastGroup <cp.prop: string>
Type Field
Description Last group used in the Preferences Drop Down.
Notes None
Source src/plugins/core/shortcuts/prefs/init.lua line 38