docs » cp.apple.finalcutpro.main.PrimaryWindow


Primary Window Module.

API Overview

API Documentation

Fields

frame

Signature cp.apple.finalcutpro.main.PrimaryWindow.frame <cp.prop: frame>
Type Field
Description The current position (x, y, width, height) of the window.

isFullScreen

Signature cp.apple.finalcutpro.main.PrimaryWindow.isFullScreen <cp.prop: boolean>
Type Field
Description Is true if the window is full-screen.

isShowing

Signature cp.apple.finalcutpro.main.PrimaryWindow.isShowing <cp.prop: boolean>
Type Field
Description Is true if the window is visible.

UI

Signature cp.apple.finalcutpro.main.PrimaryWindow.UI <cp.prop: axuielement; read-only>
Type Field
Description The axuielement for the window.

Methods

app

Signature cp.apple.finalcutpro.main.PrimaryWindow:app() -> hs.application
Type Method
Description Returns the application the display belongs to.
Parameters
  • None
Returns
  • The app instance.

show

Signature cp.apple.finalcutpro.main.PrimaryWindow:show() -> PrimaryWindow
Type Method
Description Attempts to focus the specified window.
Parameters
  • None
Returns
  • `true` if the window exists and

watch

Signature cp.apple.finalcutpro.main.PrimaryWindow:watch() -> string
Type Method
Description Watch for events that happen in the command editor
Parameters
  • `events` - A table of functions with to watch. These may be:
  • `show(window)` - Triggered when the window is shown.
  • `hide(window)` - Triggered when the window is hidden.
  • `move(window)` - Triggered when the window is moved.
Returns
  • An ID which can be passed to `unwatch` to stop watching.

window

Signature cp.apple.finalcutpro.main.PrimaryWindow:window() -> cp.ui.Window
Type Method
Description Returns the Window instance.
Parameters
  • None
Returns
  • The `Window` instance.

results matching ""

    No results matching ""