# plugins.core.preferences.general

General Preferences Panel.


# API Overview

Variables - Configurable values

  • dragAndDropFileActions
  • dragAndDropTextActions
  • openDebugConsoleOnDockClick

Functions - API calls offered directly by the extension

  • registerDragAndDropFileAction
  • registerDragAndDropTextAction

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

  • autoLaunch
  • dockIcon
  • dragAndDropFileAction
  • dragAndDropTextAction

# API Documentation

# Variables

# dragAndDropFileActions

Signature plugins.core.preferences.general.dragAndDropFileActions -> table
Type Variable
Description A table of registered Drag & Drop File Actions.
Notes None
Source src/plugins/core/preferences/general.lua line 79

# dragAndDropTextActions

Signature plugins.core.preferences.general.dragAndDropTextActions -> table
Type Variable
Description A table of registered Drag & Drop Text Actions.
Notes None
Source src/plugins/core/preferences/general.lua line 56

# openDebugConsoleOnDockClick

Signature plugins.core.preferences.general.openDebugConsoleOnDockClick <cp.prop: boolean>
Type Variable
Description Open Error Log on Dock Icon Click.
Notes None
Source src/plugins/core/preferences/general.lua line 51

# Functions

# registerDragAndDropFileAction

Signature plugins.core.preferences.general.registerDragAndDropFileAction(id, label, fn) -> none
Type Function
Description Registers 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
Notes None
Examples None
Source src/plugins/core/preferences/general.lua line 84

# registerDragAndDropTextAction

Signature plugins.core.preferences.general.registerDragAndDropTextAction(id, label, fn) -> none
Type Function
Description Registers 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
Notes None
Examples None
Source src/plugins/core/preferences/general.lua line 61

# Fields

# autoLaunch

Signature plugins.core.preferences.general.autoLaunch <cp.prop: boolean>
Type Field
Description Controls if CommandPost will automatically upload crash data to the developer.
Notes None
Source src/plugins/core/preferences/general.lua line 26

# dockIcon

Signature plugins.core.preferences.general.dockIcon <cp.prop: boolean>
Type Field
Description Controls whether or not CommandPost should show a dock icon.
Notes None
Source src/plugins/core/preferences/general.lua line 34

# dragAndDropFileAction

Signature plugins.core.preferences.general.dragAndDropFileAction <cp.prop: string>
Type Field
Description Which Drag & Drop File Action is enabled?
Notes None
Source src/plugins/core/preferences/general.lua line 41

# dragAndDropTextAction

Signature plugins.core.preferences.general.dragAndDropTextAction <cp.prop: string>
Type Field
Description Which Drag & Drop Text Action is enabled?
Notes None
Source src/plugins/core/preferences/general.lua line 46