# plugins.core.accessibility

Accessibility Plugin.

# Submodules

# API Overview

Constants - Useful values which cannot be changed

enabled

Variables - Configurable values

shouldWeTryCloseSystemPreferences
systemPreferencesAlreadyOpen

Functions - API calls offered directly by the extension

completeSetupPanel
init
showSetupPanel

# API Documentation

# Constants

# enabled


Signature	`plugins.core.accessibility.enabled <cp.prop: boolean; read-only>`
Type	Constant
Description	Is `true` if Accessibility permissions have been enabled for CommandPost.
Notes	None
Source	src/plugins/core/accessibility/accessibility.lua line 27

# Variables

# shouldWeTryCloseSystemPreferences


Signature	`plugins.core.accessibility.shouldWeTryCloseSystemPreferences -> boolean`
Type	Variable
Description	Should we try and close system preferences?
Notes	None
Source	src/plugins/core/accessibility/accessibility.lua line 17

# systemPreferencesAlreadyOpen


Signature	`plugins.core.accessibility.systemPreferencesAlreadyOpen -> boolean`
Type	Variable
Description	Was System Preferences already open?
Notes	None
Source	src/plugins/core/accessibility/accessibility.lua line 22

# Functions

# completeSetupPanel


Signature	`plugins.core.accessibility.completeSetupPanel() -> none`
Type	Function
Description	Called when the setup panel for accessibility was shown and is ready to complete.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/accessibility/accessibility.lua line 54

# init


Signature	`plugins.core.accessibility.init(setup) -> table`
Type	Function
Description	Initialises the module.
Parameters	setup - Dependancies setup
Returns	The module as a table
Notes	None
Examples	None
Source	src/plugins/core/accessibility/accessibility.lua line 85

# showSetupPanel


Signature	`plugins.core.accessibility.showSetupPanel() -> none`
Type	Function
Description	Called when the Setup Panel should be shown to prompt the user about enabling Accessbility.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/accessibility/accessibility.lua line 70