Updated Developers Guide

CommandPost · Aug 31, 2020 · b3aa060 · b3aa060
1 parent ea42ec5
commit b3aa060
Show file tree

Hide file tree

Showing 19 changed files with 464 additions and 33 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -349,11 +349,13 @@
  * [global](api/plugins/plugins.core.commands.global.md)
  * [console](api/plugins/plugins.core.console.md)
  * [applications](api/plugins/plugins.core.console.applications.md)
+ * [keyboardmaestromacros](api/plugins/plugins.core.console.keyboardmaestromacros.md)
  * [scripts](api/plugins/plugins.core.console.scripts.md)
  * [manager](api/plugins/plugins.core.controlsurfaces.manager.md)
  * [automount](api/plugins/plugins.core.disk.automount.md)
  * [favourites](api/plugins/plugins.core.disk.favourites.md)
  * [display](api/plugins/plugins.core.display.md)
+ * [prefs](api/plugins/plugins.core.gamepad.prefs.md)
  * [credits](api/plugins/plugins.core.helpandsupport.credits.md)
  * [debugconsole](api/plugins/plugins.core.helpandsupport.debugconsole.md)
  * [developerguide](api/plugins/plugins.core.helpandsupport.developerguide.md)
@@ -373,6 +375,7 @@
  * [manager](api/plugins/plugins.core.midi.manager.md)
  * [controls](api/plugins/plugins.core.midi.manager.controls.md)
  * [prefs](api/plugins/plugins.core.midi.prefs.md)
+ * [prefs](api/plugins/plugins.core.monogram.prefs.md)
  * [history](api/plugins/plugins.core.pasteboard.history.md)
  * [general](api/plugins/plugins.core.preferences.general.md)
  * [manager](api/plugins/plugins.core.preferences.manager.md)
@@ -418,6 +421,9 @@
  * [virtual](api/plugins/plugins.core.touchbar.virtual.md)
  * [volume](api/plugins/plugins.core.touchbar.widgets.volume.md)
  * [windowSlide](api/plugins/plugins.core.touchbar.widgets.windowSlide.md)
+ * [changeapplications](api/plugins/plugins.core.tourbox.changeapplications.md)
+ * [manager](api/plugins/plugins.core.tourbox.manager.md)
+ * [prefs](api/plugins/plugins.core.tourbox.prefs.md)
  * [panel](api/plugins/plugins.core.utilities.manager.panel.md)
  * [manager](api/plugins/plugins.core.watchfolders.manager.md)
  * [panel](api/plugins/plugins.core.watchfolders.manager.panel.md)
@@ -679,6 +685,7 @@
  * [redshift](api/hs/hs.redshift.md)
  * [screen](api/hs/hs.screen.md)
  * [watcher](api/hs/hs.screen.watcher.md)
+ * [serial](api/hs/hs.serial.md)
  * [settings](api/hs/hs.settings.md)
  * [sharing](api/hs/hs.sharing.md)
  * [socket](api/hs/hs.socket.md)

diff --git a/api/cp/cp.apple.finalcutpro.inspector.color.ColorWheels.md b/api/cp/cp.apple.finalcutpro.inspector.color.ColorWheels.md
@@ -15,6 +15,7 @@ Extends [Element](cp.ui.Element.md)
  * [highlights](#highlights)
  * [hue](#hue)
  * [hueRow](#huerow)
+ * [hueSlider](#hueslider)
  * [hueTextField](#huetextfield)
  * [master](#master)
  * [maxValue](#maxvalue)
@@ -23,13 +24,16 @@ Extends [Element](cp.ui.Element.md)
  * [mix](#mix)
  * [mixRow](#mixrow)
  * [mixSlider](#mixslider)
+ * [mixTextField](#mixtextfield)
  * [shadows](#shadows)
  * [temperature](#temperature)
  * [temperatureRow](#temperaturerow)
  * [temperatureSlider](#temperatureslider)
+ * [temperatureTextField](#temperaturetextfield)
  * [tint](#tint)
  * [tintRow](#tintrow)
  * [tintSlider](#tintslider)
+ * [tintTextField](#tinttextfield)
  * [value](#value)
  * [viewingAllWheels](#viewingallwheels)
  * [viewMode](#viewmode)
@@ -86,6 +90,12 @@ Extends [Element](cp.ui.Element.md)
 | **Type** | Field |
 | **Description** | A `PropertyRow` that provides access to the 'Hue' parameter, and `axuielement` |
 
+#### [hueSlider](#hueslider)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.hueSlider <cp.ui.Slider>` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Field |
+| **Description** | Returns a `Slider` that provides access to the 'Hue' slider. |
+
 #### [hueTextField](#huetextfield)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.hueTextField <cp.ui.TextField>` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
@@ -134,6 +144,12 @@ Extends [Element](cp.ui.Element.md)
 | **Type** | Field |
 | **Description** | A `Slider` that provides access to the 'Mix' slider. |
 
+#### [mixTextField](#mixtextfield)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.mixTextField <cp.ui.TextField>` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Field |
+| **Description** | A `TextField` that provides access to the 'Mix' slider. |
+
 #### [shadows](#shadows)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.shadows <ColorWheel>` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
@@ -158,6 +174,12 @@ Extends [Element](cp.ui.Element.md)
 | **Type** | Field |
 | **Description** | A `Slider` that provides access to the 'Temperatures' slider. |
 
+#### [temperatureTextField](#temperaturetextfield)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureTextField <cp.ui.TextField>` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Field |
+| **Description** | A `TextField` that provides access to the 'Temperature' slider. |
+
 #### [tint](#tint)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.tint <cp.prop: number>` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
@@ -176,6 +198,12 @@ Extends [Element](cp.ui.Element.md)
 | **Type** | Field |
 | **Description** | Returns a `Slider` that provides access to the 'Tint' slider. |
 
+#### [tintTextField](#tinttextfield)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.tintTextField <cp.ui.TextField>` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Field |
+| **Description** | A `TextField` that provides access to the 'Tint' slider. |
+
 #### [value](#value)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.apple.finalcutpro.inspector.color.ColorWheels.value <cp.prop: number>` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|

diff --git a/api/cp/cp.commands.command.md b/api/cp/cp.commands.command.md
@@ -18,12 +18,14 @@ Commands Module.
  * [getAction](#getaction)
  * [getFirstShortcut](#getfirstshortcut)
  * [getGroup](#getgroup)
+ * [getImage](#getimage)
  * [getShortcuts](#getshortcuts)
  * [getSubtitle](#getsubtitle)
  * [getTitle](#gettitle)
  * [groupedBy](#groupedby)
  * [hasAction](#hasaction)
  * [id](#id)
+ * [image](#image)
  * [new](#new)
  * [parent](#parent)
  * [pressed](#pressed)
@@ -136,6 +138,14 @@ Commands Module.
 | **Parameters** | <ul><li>None</li></ul> |
 | **Returns** | <ul><li>The group ID.</li></ul> |
 
+#### [getImage](#getimage)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command:getImage() -> hs.image object` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Method |
+| **Description** | Returns the current image. |
+| **Parameters** | <ul><li>None</li></ul> |
+| **Returns** | <ul><li>A hs.image object or <code>nil</code> if not is specified.</li></ul> |
+
 #### [getShortcuts](#getshortcuts)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command:getShortcuts() -> command` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
@@ -164,7 +174,7 @@ Commands Module.
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
 | **Type** | Method |
 | **Description** | Specifies that the command is grouped by a specific value. |
-| **Parameters** | <ul><li><code>group</code>  - The group ID.</li></ul> |
+| **Parameters** | <ul><li><code>group</code> - The group ID.</li></ul> |
 | **Returns** | <ul><li>The <code>cp.commands.command</code> instance.</li></ul> |
 
 #### [hasAction](#hasaction)
@@ -183,6 +193,14 @@ Commands Module.
 | **Parameters** | <ul><li>None</li></ul> |
 | **Returns** | <ul><li>The ID.</li></ul> |
 
+#### [image](#image)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command:image(img) -> cp.commands.command` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Method |
+| **Description** | Sets the specified image and returns the `cp.commands.command` instance. |
+| **Parameters** | <ul><li><code>img</code> - The <code>hs.image</code> to use.</li></ul> |
+| **Returns** | <ul><li>The <code>cp.commands.command</code> instance.</li></ul> |
+
 #### [new](#new)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command.new() -> command` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
@@ -227,15 +245,16 @@ Commands Module.
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
 | **Type** | Method |
 | **Description** | Deletes any existing shortcuts and applies the new set of shortcuts in the table. |
-| **Parameters** | <ul><li>shortcuts - The set of <code>cp.commands.shortcuts</code> to apply to this command.</li></ul> |
+| **Parameters** | <ul><li>shortcuts  - The set of <code>cp.commands.shortcuts</code> to apply to this command.</li></ul> |
 | **Returns** | <ul><li>The <code>cp.commands.command</code> instance.</li></ul> |
 
 #### [subtitled](#subtitled)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command:subtitled(subtitle) -> cp.commands.command` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
 | **Type** | Method |
 | **Description** | Sets the specified subtitle and returns the `cp.commands.command` instance. |
-| **Parameters** | <ul><li><code>subtitle</code> - The new subtitle.</li></ul> |
+| **Parameters** | <ul><li><code>subtitle</code> - The new subtitle.</li></ul> |
+| **Returns** | <ul><li>The <code>cp.commands.command</code> instance.</li></ul> |
 
 #### [titled](#titled)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.commands.command:titled(title) -> command` </span> |

diff --git a/api/cp/cp.tools.md b/api/cp/cp.tools.md
@@ -49,6 +49,7 @@ A collection of handy miscellaneous tools for Lua development.
  * [ninjaMouseClick](#ninjamouseclick)
  * [ninjaRightMouseClick](#ninjarightmouseclick)
  * [numberToWord](#numbertoword)
+ * [optionPressed](#optionpressed)
  * [playErrorSound](#playerrorsound)
  * [readFromFile](#readfromfile)
  * [removeFilenameFromPath](#removefilenamefrompath)
@@ -439,6 +440,14 @@ A collection of handy miscellaneous tools for Lua development.
 | **Parameters** | <ul><li>number - A whole number between 0 and 10</li></ul> |
 | **Returns** | <ul><li>A string</li></ul> |
 
+#### [optionPressed](#optionpressed)
+| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.tools.optionPressed() -> boolean` </span> |
+| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Type** | Function |
+| **Description** | Is the Option Key being pressed? |
+| **Parameters** | <ul><li>None</li></ul> |
+| **Returns** | <ul><li><code>true</code> if the option key is being pressed, otherwise <code>false</code>.</li></ul> |
+
 #### [playErrorSound](#playerrorsound)
 | <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.tools.playErrorSound() -> none` </span> |
 | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------|

diff --git a/api/hs/hs.md b/api/hs/hs.md
@@ -64,6 +64,7 @@ Core Hammerspoon functionality
  * [hs.plist](hs.plist.md)
  * [hs.redshift](hs.redshift.md)
  * [hs.screen](hs.screen.md)
+ * [hs.serial](hs.serial.md)
  * [hs.settings](hs.settings.md)
  * [hs.sharing](hs.sharing.md)
  * [hs.socket](hs.socket.md)