cp.ui.Popover

UI Group.


API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • Popover

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

  • doHide
  • hide

API Documentation

Functions

matches

   
Signature cp.ui.Popover.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
Notes None
Examples None
Source src/extensions/cp/ui/Popover.lua line 12

Constructors

Popover

   
Signature cp.ui.Popover(parent, uiFinder) -> Popover
Type Constructor
Description Creates 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.
Notes None
Examples None
Source src/extensions/cp/ui/Popover.lua line 25

Methods

doHide

   
Signature cp.ui.Popover:doHide() -> cp.rx.go.Statement
Type Method
Description Returns a Statement which will hide the popover.
Parameters
  • None
Returns
  • The Statement.
Notes None
Examples None
Source src/extensions/cp/ui/Popover.lua line 53

hide

   
Signature cp.ui.Popover:hide() -> Popover
Type Method
Description Hides a popover.
Parameters
  • None
Returns
  • Self
Notes None
Examples None
Source src/extensions/cp/ui/Popover.lua line 36