#cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover

Browser Marker Popup.


#API Overview

Functions - API calls offered directly by the extension

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

Fields - Variables which can only be accessed from an object returned by a constructor

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


#API Documentation

#Functions

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.matches(element) -> boolean
TypeFunction
DescriptionChecks to see if a GUI element is the Browser Marker Popover or not
Parameters
  • element - The element you want to check
Returns
  • true if the element is the Browser Marker Popover otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 26

#Constructors

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover(parent) -> BrowserMarkerPopover
TypeConstructor
DescriptionConstructs a new Browser Marker Popover
Parameters
  • parent - The parent object
Returns
  • The new BrowserMarkerPopover instance.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 39

#Fields

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.chapter <cp.ui.RadioButton>
TypeField
DescriptionThe "Chapter" Marker button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 133

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.completed <cp.ui.CheckBox>
TypeField
DescriptionGets the "Completed" checkbox. This only available if you have a "To Do" marker selected.
Parameters
  • None
Returns
  • A Button object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 172

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.delete <cp.ui.Button>
TypeField
DescriptionGets the "Delete" Button.
Parameters
  • None
Returns
  • A Button object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 157

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.done <cp.ui.Button>
TypeField
DescriptionThe "Done" Button.
Parameters
  • None
Returns
  • A Button object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 142

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.name <cp.ui.TextField>
TypeField
DescriptionGets the Marker Name TextField.
Parameters
  • None
Returns
  • A TextField object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 187

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.standard <cp.ui.RadioButton>
TypeField
DescriptionThe "Standard" Marker button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 115

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.toDo <cp.ui.RadioButton>
TypeField
DescriptionThe "To Do" Marker button.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 124

#Methods

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover:hide() -> BrowserMarkerPopover
TypeMethod
DescriptionHides the Browser Marker Popover by clicking "Done" on the popover.
Parameters
  • None
Returns
  • BrowserMarkerPopover object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 81

Signaturecp.apple.finalcutpro.main.Browser.BrowserMarkerPopover:show() -> BrowserMarkerPopover
TypeMethod
DescriptionShows the Browser Marker Popover by triggering "Add Marker and Modify" from the menu bar.
Parameters
  • None
Returns
  • BrowserMarkerPopover object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/main/BrowserMarkerPopover.lua line 65