#cp.dev
A set of handy developer tools for CommandPost.
#API Overview
Functions - API calls offered directly by the extension
- elementAtMouse
- findUnusedLanguageStrings
- highlight
- highlightFrame
- highlightPoint
- hotkey
- inspect
- inspectAtMouse
- inspectElement
- inspectElementAtMousePath
- test
- which
#API Documentation
#Functions
Signature | cp.dev.elementAtMouse() -> axuielementObject |
Type | Function |
Description | Gets the AX element under the current mouse position. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 146 |
Signature | cp.dev.findUnusedLanguageStrings() -> string |
Type | Function |
Description | Searches for any unused language strings in English.json. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 66 |
Signature | cp.dev.highlight(element) -> axuielementObject |
Type | Function |
Description | Highlights an AX element on the screen. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 277 |
Signature | cp.dev.highlightFrame(frame) -> none |
Type | Function |
Description | Highlights aa frame on the screen. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 319 |
Signature | cp.dev.highlightPoint(point) -> none |
Type | Function |
Description | Highlights a point on the screen. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 352 |
Signature | cp.dev.hotkey(fn) -> none |
Type | Function |
Description | Assigns a function to the CONTROL+OPTION+COMMAND+SHIFT+Q keyboard combination. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 53 |
Signature | cp.dev.inspect(item, options) -> string |
Type | Function |
Description | Inspect an item. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 195 |
Signature | cp.dev.inspectAtMouse(options) -> none |
Type | Function |
Description | Inspects an AX element under the current mouse position. Writes results to Debug Console. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 159 |
Signature | cp.dev.inspectElement(element[, options]) -> none |
Type | Function |
Description | Inspect an AX element. Writes results to Debug Console. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/dev/init.lua line 234 |
Signature | cp.dev.inspectElementAtMousePath(options) -> none |
Type | Function |
Description | Inspects an AX element at the mouse path. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 393 |
Signature | cp.dev.test(id) -> cp.test |
Type | Function |
Description | This function will return a cp.test. |
Parameters |
|
Returns |
|
Notes |
|
Examples | None |
Source | src/extensions/cp/dev/init.lua line 406 |
Signature | cp.dev.which(cmd) -> none |
Type | Function |
Description | The which utility takes a list of command names and searches the path for each executable file that would be run had these commands actually been invoked. |
Parameters |
|
Returns |
|
Notes | None |
Examples | None |
Source | src/extensions/cp/dev/init.lua line 122 |