cp.ui.Splitter

Represents an AXSplitter.


API Overview

Constants - Useful values which cannot be changed

  • HORIZONTAL_ORIENTATION
  • VERTICAL_ORIENTATION

Functions - API calls offered directly by the extension

  • matches

Fields - Variables which can only be accessed from an object returned by a constructor

  • horizontal
  • maxValue
  • minValue
  • nextContentsUI
  • orientation
  • previousContentsUI
  • vertical

API Documentation

Constants

HORIZONTAL_ORIENTATION

   
Signature cp.ui.Splitter.HORIZONTAL_ORIENTATION <string>
Type Constant
Description The value for AXOrientation when it is horizontal.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 17

VERTICAL_ORIENTATION

   
Signature cp.ui.Splitter.VERTICAL_ORIENTATION <string>
Type Constant
Description The value for AXOrientation when it is vertical.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 12

Functions

matches

   
Signature cp.ui.Splitter.matches(value) -> boolean
Type Function
Description Checks to see if an element matches what we think it should be.
Parameters
  • value - The value to check.
Returns
  • true if the value matches, false otherwise.
Notes None
Examples None
Source src/extensions/cp/ui/Splitter.lua line 22

Fields

horizontal

   
Signature cp.ui.Splitter.horizontal <cp.prop: boolean; read-only>
Type Field
Description Is true if the Splitter is horizontal, otherwise false.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 77

maxValue

   
Signature cp.ui.Splitter.maxValue <cp.prop: number, read-only>
Type Field
Description The maximum value of the splitter.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 33

minValue

   
Signature cp.ui.Splitter.minValue <cp.prop: number, read-only>
Type Field
Description The minimum value of the splitter.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 40

nextContentsUI

   
Signature cp.ui.Splitter.nextContentsUI <cp.prop: axuielementObject, read-only, live?>
Type Field
Description The axuielementObject for the next contents of the splitter.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 47

orientation

   
Signature cp.ui.Splitter.orientation <cp.prop: string; read-only>
Type Field
Description The AXOrientation string.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 61

previousContentsUI

   
Signature cp.ui.Splitter.previousContentsUI <cp.prop: axuielementObject, read-only, live?>
Type Field
Description The axuielementObject for the previous contents of the splitter.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 54

vertical

   
Signature cp.ui.Splitter.vertical <cp.prop: boolean; read-only>
Type Field
Description Is true if the Splitter is vertical, otherwise false.
Notes None
Source src/extensions/cp/ui/Splitter.lua line 68