#cp.ui.Popover

UI Group.


#API Overview

Functions - API calls offered directly by the extension

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

#Functions

Signaturecp.ui.Popover.matches(element) -> boolean
TypeFunction
DescriptionChecks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
Returns
  • true if matches otherwise false
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Popover.lua line 12

#Constructors

Signaturecp.ui.Popover(parent, uiFinder) -> Popover
TypeConstructor
DescriptionCreates a new Popover instance.
Parameters
  • parent - The parent object.
  • uiFinder - A function which will return the hs.axuielement when available.
Returns
  • A new Popover object.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Popover.lua line 25

#Methods

Signaturecp.ui.Popover:doHide() -> cp.rx.go.Statement
TypeMethod
DescriptionReturns a Statement which will hide the popover.
Parameters
  • None
Returns
  • The Statement.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Popover.lua line 53

Signaturecp.ui.Popover:hide() -> Popover
TypeMethod
DescriptionHides a popover.
Parameters
  • None
Returns
  • Self
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/ui/Popover.lua line 36