cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.md

docs » cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover

---

Browser Marker Popup.

API Overview

• Functions - API calls offered directly by the extension
• matches
• Constructors - API calls which return an object, typically one that offers API methods
• BrowserMarkerPopover
• Fields - Variables which can only be accessed from an object returned by a constructor
• chapter
• completed
• delete
• done
• name
• standard
• toDo
• Methods - API calls which can only be made on an object returned by a constructor
• hide
• show

API Documentation

Functions

matches

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.matches(element) -> boolean
Type	Function
Description	Checks 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

Constructors

BrowserMarkerPopover

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover(parent) -> BrowserMarkerPopover
Type	Constructor
Description	Constructs a new Browser Marker Popover
Parameters	parent - The parent object
Returns	The new BrowserMarkerPopover instance.

Fields

chapter

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.chapter <cp.ui.RadioButton>
Type	Field
Description	The "Chapter" Marker button.

completed

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.completed <cp.ui.CheckBox>
Type	Field
Description	Gets the "Completed" checkbox. This only available if you have a "To Do" marker selected.
Parameters	None
Returns	A Button object.

delete

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.delete <cp.ui.Button>
Type	Field
Description	Gets the "Delete" Button.
Parameters	None
Returns	A Button object.

done

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.done <cp.ui.Button>
Type	Field
Description	The "Done" Button.
Parameters	None
Returns	A Button object.

name

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.name <cp.ui.TextField>
Type	Field
Description	Gets the Marker Name TextField.
Parameters	None
Returns	A TextField object.

standard

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.standard <cp.ui.RadioButton>
Type	Field
Description	The "Standard" Marker button.

toDo

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover.toDo <cp.ui.RadioButton>
Type	Field
Description	The "To Do" Marker button.

Methods

hide

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover:hide() -> BrowserMarkerPopover
Type	Method
Description	Hides the Browser Marker Popover by clicking "Done" on the popover.
Parameters	None
Returns	BrowserMarkerPopover object

show

Signature	cp.apple.finalcutpro.main.Browser.BrowserMarkerPopover:show() -> BrowserMarkerPopover
Type	Method
Description	Shows the Browser Marker Popover by triggering "Add Marker and Modify" from the menu bar.
Parameters	None
Returns	BrowserMarkerPopover object