#plugins.core.preferences.general

General Preferences Panel.


#API Overview

Variables - Configurable values

Functions - API calls offered directly by the extension

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


#API Documentation

#Variables

Signatureplugins.core.preferences.general.dragAndDropFileActions -> table
TypeVariable
DescriptionA table of registered Drag & Drop File Actions.
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 79

Signatureplugins.core.preferences.general.dragAndDropTextActions -> table
TypeVariable
DescriptionA table of registered Drag & Drop Text Actions.
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 56

Signatureplugins.core.preferences.general.openDebugConsoleOnDockClick <cp.prop: boolean>
TypeVariable
DescriptionOpen Error Log on Dock Icon Click.
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 51

#Functions

Signatureplugins.core.preferences.general.registerDragAndDropFileAction(id, label, fn) -> none
TypeFunction
DescriptionRegisters a new Drag & Drop File Action.
Parameters
  • id - A unique identifier as a string
  • label - The label that should be display in the user interface
  • fn - A callback function
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/preferences/general.lua line 84

Signatureplugins.core.preferences.general.registerDragAndDropTextAction(id, label, fn) -> none
TypeFunction
DescriptionRegisters a new Drag & Drop Text Action.
Parameters
  • id - A unique identifier as a string
  • label - The label that should be display in the user interface
  • fn - A callback function
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/preferences/general.lua line 61

#Fields

Signatureplugins.core.preferences.general.autoLaunch <cp.prop: boolean>
TypeField
DescriptionControls if CommandPost will automatically upload crash data to the developer.
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 26

Signatureplugins.core.preferences.general.dockIcon <cp.prop: boolean>
TypeField
DescriptionControls whether or not CommandPost should show a dock icon.
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 34

Signatureplugins.core.preferences.general.dragAndDropFileAction <cp.prop: string>
TypeField
DescriptionWhich Drag & Drop File Action is enabled?
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 41

Signatureplugins.core.preferences.general.dragAndDropTextAction <cp.prop: string>
TypeField
DescriptionWhich Drag & Drop Text Action is enabled?
NotesNone
Sourcesrc/plugins/core/preferences/general.lua line 46