#plugins.core.preferences.manager

Manager for the CommandPost Preferences Window.

#Submodules

plugins.core.preferences.manager.panel

#API Overview

Constants - Useful values which cannot be changed

DEFAULT_HEIGHT
DEFAULT_WIDTH
lastTab
position
WEBVIEW_LABEL

Variables - Configurable values

_handlers
_panels

Functions - API calls offered directly by the extension

addHandler
addPanel
currentPanelID
focus
getHandler
getLabel
getWebview
hide
init
injectScript
maxPanelHeight
new
refresh
selectPanel
setPanelRenderer
show

#API Documentation

#Constants

#DEFAULT_HEIGHT


Signature	`plugins.core.preferences.manager.DEFAULT_HEIGHT -> number`
Type	Constant
Description	Default Height of Preferences Window
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 37

#DEFAULT_WIDTH


Signature	`plugins.core.preferences.manager.DEFAULT_WIDTH -> number`
Type	Constant
Description	Default Width of Preferences Window
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 42

#lastTab


Signature	`plugins.core.preferences.manager.lastTab`
Type	Constant
Description	Returns the last tab saved in settings.
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 62

#position


Signature	`plugins.core.preferences.manager.position`
Type	Constant
Description	Returns the last frame saved in settings.
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 57

#WEBVIEW_LABEL


Signature	`plugins.core.preferences.manager.WEBVIEW_LABEL -> string`
Type	Constant
Description	The WebView Label
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 32

#Variables

#_handlers


Signature	`plugins.core.preferences.manager._handlers -> table`
Type	Variable
Description	Table containing handlers.
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 52

#_panels


Signature	`plugins.core.preferences.manager._panels -> table`
Type	Variable
Description	Table containing panels.
Notes	None
Source	src/plugins/core/preferences/manager/init.lua line 47

#Functions

#addHandler


Signature	`plugins.core.preferences.manager.addHandler(id, handlerFn) -> string`
Type	Function
Description	Adds a Handler
Parameters	id - The ID handlerFn - the handler function
Returns	Nothing
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 93

#addPanel


Signature	`plugins.core.preferences.manager.addPanel(params) -> plugins.core.preferences.manager.panel`
Type	Function
Description	Adds a new panel with the specified `params` to the preferences manager.
Parameters	`params` - The parameters table. Details below.
Returns	The new `panel` instance.
Notes	The `params` can have the following properties. The `priority` and `id` and properties are required. `priority` - An integer value specifying the priority of the panel compared to others. `id` - A string containing the unique ID of the panel. `label` - The human-readable label for the panel icon. `image` - The `hs.image` for the panel icon. `tooltip` - The human-readable details for the toolbar icon when the mouse is hovering over it. `closeFn` - A callback function that's triggered when the Preferences window is closed.
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 550

#currentPanelID


Signature	`plugins.core.preferences.manager.currentPanelID() -> string`
Type	Function
Description	Returns the panel ID with the highest priority.
Parameters	None
Returns	The panel ID as a string
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 151

#focus


Signature	`plugins.core.preferences.manager.focus() -> boolean`
Type	Function
Description	Puts focus on the Preferences Window.
Parameters	None
Returns	`true` if successful or otherwise `false`.
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 406

#getHandler


Signature	`plugins.core.preferences.manager.getHandler(id) -> string`
Type	Function
Description	Returns the handler for a given ID.
Parameters	id - The ID
Returns	Table
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 107

#getLabel


Signature	`plugins.core.preferences.manager.getLabel() -> string`
Type	Function
Description	Returns the Webview label.
Parameters	None
Returns	The Webview label as a string.
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 80

#getWebview


Signature	`plugins.core.preferences.manager.getWebview() -> hs.webview`
Type	Function
Description	Returns the Webview of the Preferences Window.
Parameters	None
Returns	A `hs.webview`
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 67

#hide


Signature	`plugins.core.preferences.manager.hide() -> none`
Type	Function
Description	Hides the Preferences Window.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 425

#init


Signature	`plugins.core.preferences.manager.init() -> nothing`
Type	Function
Description	Initialises the preferences panel.
Parameters	None
Returns	Nothing
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 233

#injectScript


Signature	`plugins.core.preferences.manager.injectScript(script) -> none`
Type	Function
Description	Injects JavaScript into the Preferences Webview.
Parameters	script - The JavaScript code you want to inject in the form of a string.
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 463

#maxPanelHeight


Signature	`plugins.core.preferences.manager.maxPanelHeight() -> number`
Type	Function
Description	Returns the maximum size defined by a panel.
Parameters	None
Returns	The maximum panel height.
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 248

#new


Signature	`plugins.core.preferences.manager.new() -> none`
Type	Function
Description	Creates a new Preferences Window.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 289

#refresh


Signature	`plugins.core.preferences.manager.refresh() -> none`
Type	Function
Description	Refreshes the Preferences Window.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 441

#selectPanel


Signature	`plugins.core.preferences.manager.selectPanel(id) -> none`
Type	Function
Description	Selects a Preferences Panel.
Parameters	id - the ID of the panel you want to select.
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 484

#setPanelRenderer


Signature	`plugins.core.preferences.manager.setPanelRenderer(renderer) -> none`
Type	Function
Description	Sets a Panel Renderer
Parameters	renderer - The renderer
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 120

#show


Signature	`plugins.core.preferences.manager.show([panelID]) -> boolean`
Type	Function
Description	Shows the Preferences Window
Parameters	[panelID] - An optional panel ID
Returns	True if successful or nil if an error occurred
Notes	None
Examples	None
Source	src/plugins/core/preferences/manager/init.lua line 374