Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
80 lines (64 loc) · 5.69 KB

cp.apple.finalcutpro.main.FullScreenWindow.md

File metadata and controls

80 lines (64 loc) · 5.69 KB
Raw

docs » cp.apple.finalcutpro.main.FullScreenWindow

Full Screen Window Player.

Triggered by the "View > Playback > Play Full Screen" menubar item.

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Constructors - API calls which return an object, typically one that offers API methods
  • FullScreenWindow
  • Fields - Variables which can only be accessed from an object returned by a constructor
  • isFullScreen
  • rootGroupUI
  • viewerGroupUI
  • Methods - API calls which can only be made on an object returned by a constructor
  • doShow
  • show

API Documentation

Functions

matches

Signature cp.apple.finalcutpro.main.FullScreenWindow.matches(element) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false

Constructors

FullScreenWindow

Signature cp.apple.finalcutpro.main.FullScreenWindow(app) -> FullScreenWindow
Type Constructor
Description Creates a new FCPX FullScreenWindow instance.
Parameters
  • app - The FCP app instance.
Returns
  • The new FullScreenWindow.

Fields

isFullScreen

Signature cp.apple.finalcutpro.main.FullScreenWindow.isFullScreen <cp.prop; boolean; read-only; live>
Type Field
Description Checks if the window is full-screen.

rootGroupUI

Signature cp.apple.finalcutpro.main.FullScreenWindow.rootGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type Field
Description The root AXGroup.

viewerGroupUI

Signature cp.apple.finalcutpro.main.FullScreenWindow.viewerGroupUI <cp.prop: hs._asm.axuielement; read-only; live>
Type Field
Description The Viewer's group UI element.

Methods

doShow

Signature cp.apple.finalcutpro.main.FullScreenWindow:doShow() -> <cp.rx.go.Statement>
Type Method
Description A Statement that attempts to show the full screen window.
Parameters
  • None
Returns
  • The Statement to execute.

show

Signature cp.apple.finalcutpro.main.FullScreenWindow:show() -> cp.apple.finalcutpro
Type Method
Description Attempts to show the full screen window.
Parameters
  • None
Returns
  • The window instance.