#cp.apple.finalcutpro.inspector.BasePanel

A base class for the different panels in the Inspector.

Extends Element.


#API Overview

Constructors - API calls which return an object, typically one that offers API methods

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Constructors

Signaturecp.apple.finalcutpro.inspector.BasePanel(parent, panelType) -> BasePanel
TypeConstructor
DescriptionConstructs the panel, initialising the parent and the UI.
Parameters
Returns
  • The new BasePanel instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/BasePanel.lua line 16

#Methods

Signaturecp.apple.finalcutpro.inspector.BasePanel:doShow() -> cp.rx.go.Statment
TypeMethod
DescriptionA Statement that hides the panel.
Parameters
  • None
Returns
  • The Statement, resolving to true if successful and sending an error if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/BasePanel.lua line 101

Signaturecp.apple.finalcutpro.inspector.BasePanel:hide() -> none
TypeMethod
DescriptionHides the panel.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/BasePanel.lua line 85

Signaturecp.apple.finalcutpro.inspector.BasePanel:panelType() -> string
TypeMethod
DescriptionGets the type of panel this is.
Parameters
  • None
Returns
  • The panel type identifier.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/BasePanel.lua line 41

Signaturecp.apple.finalcutpro.inspector.BasePanel:show() -> none
TypeMethod
DescriptionShows the panel.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/BasePanel.lua line 54