#cp.ui.MenuButton

Menu Button Module.

#API Overview

Functions - API calls offered directly by the extension

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

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

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

#API Documentation

#Functions

Signaturecp.ui.MenuButton.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/MenuButton.lua line 26

#Constructors

Signaturecp.ui.MenuButton(parent, uiFinder) -> MenuButton
TypeConstructor
DescriptionCreates a new MenuButton.
Parameters
  • parent - The parent object. Should have an isShowing property.
  • uiFinder - A cp.prop or function which will return a hs.axuielement, or nil if it's not available.
Returns
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 39

    #Fields

    Signaturecp.ui.MenuButton.menuUI <cp.prop: hs.axuielement; read-only; live?>
    TypeField
    DescriptionReturns the AXMenu for the MenuButton if it is currently visible.
    NotesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 80
    Signaturecp.ui.MenuButton.title <cp.prop: string; read-only>
    TypeField
    DescriptionReturns the title for the MenuButton.
    NotesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 100
    Signaturecp.ui.MenuButton.value <cp.prop: anything>
    TypeField
    DescriptionReturns or sets the current MenuButton value.
    NotesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 47

    #Methods

    Signaturecp.ui.MenuButton:doPress() -> cp.rx.go.Statement
    TypeMethod
    DescriptionA Statement that presses the MenuButton.
    Parameters
    • None
    Returns
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 311
    Signaturecp.ui.MenuButton:doSelectItem(index) -> cp.rx.go.Statement
    TypeMethod
    DescriptionA Statement that will select an item on the MenuButton by index.
    Parameters
    • index - The index number of the item to match.
    Returns
    • the Statement.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 154
    Signaturecp.ui.MenuButton:doSelectItemMatching(pattern[, altPattern]) -> cp.rx.go.Statement
    TypeMethod
    DescriptionA Statement that will select an item on the MenuButton by pattern.
    Parameters
    • pattern - The pattern to match.
    • [altPattern] - An optional alternate pattern to match if the first pattern fails.
    Returns
    • the Statement.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 237
    Signaturecp.ui.MenuButton:doSelectValue(value) -> cp.rx.go.Statement
    TypeMethod
    DescriptionA Statement that will select an item on the MenuButton by value.
    Parameters
    • value - The value of the item to match.
    Returns
    • the Statement.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 170
    Signaturecp.ui.MenuButton:doShowMenu() -> cp.rx.go.Statement
    TypeMethod
    DescriptionA Statement that presses the MenuButton if the menu is not showing.
    Parameters
    • None
    Returns
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 330
    Signaturecp.ui.MenuButton:getTitle() -> string | nil
    TypeMethod
    DescriptionGets the MenuButton title.
    Parameters
    • None
    Returns
    • The MenuButton title as string, or nil if the title cannot be determined.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 254
    Signaturecp.ui.MenuButton:getValue() -> string | nil
    TypeMethod
    DescriptionGets the MenuButton value.
    Parameters
    • None
    Returns
    • The MenuButton value as string, or nil if the value cannot be determined.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 267
    Signaturecp.ui.MenuButton:loadLayout(layout) -> none
    TypeMethod
    DescriptionLoads a MenuButton layout.
    Parameters
    • layout - A table containing the MenuButton layout settings - created using saveLayout.
    Returns
    • None
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 360
    Signaturecp.ui.MenuButton:press() -> self
    TypeMethod
    DescriptionPresses the MenuButton.
    Parameters
    • None
    Returns
    • self
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 294
    Signaturecp.ui.MenuButton:saveLayout() -> table
    TypeMethod
    DescriptionSaves the current MenuButton layout to a table.
    Parameters
    • None
    Returns
    • A table containing the current MenuButton Layout.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 345
    Signaturecp.ui.MenuButton:selectItem(index) -> boolean
    TypeMethod
    DescriptionSelect an item on the MenuButton by index.
    Parameters
    • index - The index of the item you want to select.
    Returns
    • true if successfully selected, otherwise false.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 124
    Signaturecp.ui.MenuButton:selectItemMatching(pattern) -> boolean
    TypeMethod
    DescriptionSelect an item on the MenuButton by pattern.
    Parameters
    • pattern - A pattern used to select the MenuButton item.
    Returns
    • true if successfully selected, otherwise false.
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 186
    Signaturecp.ui.MenuButton:setValue(value) -> self
    TypeMethod
    DescriptionSets the MenuButton value.
    Parameters
    • value - The value you want to set the MenuButton to.
    Returns
    • self
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 280
    Signaturecp.ui.MenuButton:show() -> self
    TypeMethod
    DescriptionShow's the MenuButton.
    Parameters
    • None
    Returns
    • self
    NotesNone
    ExamplesNone
    Sourcesrc/extensions/cp/ui/MenuButton.lua line 107

    © Copyright 2024 LateNite Films Pty Ltd. All rights reserved.