docs » plugins.core.preferences.manager


Manager for the CommandPost Preferences Panel.

Submodules

API Overview

API Documentation

Constants

lastTab

Signature plugins.core.preferences.manager.lastTab
Type Constant
Description Returns the last tab saved in settings.

position

Signature plugins.core.preferences.manager.position
Type Constant
Description Returns the last frame saved in settings.

Functions

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.

init

Signature plugins.core.preferences.manager.init() -> nothing
Type Function
Description Initialises the preferences panel.
Parameters
  • * None
Returns
  • * Nothing

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.

show

Signature plugins.core.preferences.manager.show() -> boolean
Type Function
Description Shows the Preferences Window
Parameters
  • None
Returns
  • True if successful or nil if an error occurred

results matching ""

    No results matching ""