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

Latest commit

 

History

History
33 lines (25 loc) · 2.49 KB

cp.ui.ComboBox.md

File metadata and controls

33 lines (25 loc) · 2.49 KB
Raw

docs » cp.ui.ComboBox

Combo Box Module.

API Overview

  • Functions - API calls offered directly by the extension
  • matches
  • Methods - API calls which can only be made on an object returned by a constructor
  • ComboBox

API Documentation

Functions

matches

Signature cp.ui.ComboBox.matches(element[, subrole]) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • element - An axuielementObject to check.
  • subrole - (optional) If provided, the field must have the specified subrole.
Returns
  • true if matches otherwise false

Methods

ComboBox

Signature cp.ui.ComboBox(parent, uiFinder, listAdaptorFn, [, getConvertFn[, setConvertFn]]) -> ComboBox
Type Method
Description Creates a new ComboBox. They have a parent and a finder function.
Parameters
  • parent - The parent object.
  • uiFinder - The function will return the axuielement for the ComboBox.
  • listAdaptorFn - A function that will recieve a List and AXUIElement value and return an Element
  • getConvertFn - (optional) If provided, will be passed the string value when returning.
  • setConvertFn - (optional) If provided, will be passed the number value when setting.
Returns
  • The new ComboBox.