Spec-Zone.ru › Hammerspoon

hs.webview.toolbar

Создавайте и управляйте панелями инструментов, которые могут быть присоединены к консоли Hammerspoon или объектам hs.webview.

Панели инструментов прикрепляются к окнам с заголовком и предоставляют кнопки, которые могут быть использованы для выполнения различных действий в приложении. Hammerspoon может использовать этот модуль для добавления панелей инструментов в консоль или hs.webview объекты, имеющие строку заголовка (см. hs.webview.windowMasks и hs.webview:windowStyle). Панели инструментов идентифицируются уникальным идентификатором, который используется macOS для идентификации информации, которая может быть автоматически сохранена в пользовательских настройках приложения, чтобы отразить изменения, внесённые пользователем в порядок кнопок панели инструментов или список активных кнопок (для этого необходимо установить hs.webview.toolbar:autosaves и hs.webview.toolbar:canCustomize в значение true).

Можно создать несколько копий одной и той же панели инструментов с помощью метода hs.webview.toolbar:copy, например, чтобы несколько окон webview использовали одну и ту же панель инструментов. Если пользователь настраивает скопированную панель инструментов, изменения активных кнопок или их порядка будут отражены во всех копиях панели инструментов.

Пример:

t = require("hs.webview.toolbar")
a = t.new("myConsole", {
        { id = "select1", selectable = true, image = hs.image.imageFromName("NSStatusAvailable") },
        { id = "NSToolbarSpaceItem" },
        { id = "select2", selectable = true, image = hs.image.imageFromName("NSStatusUnavailable") },
        { id = "notShown", default = false, image = hs.image.imageFromName("NSBonjour") },
        { id = "NSToolbarFlexibleSpaceItem" },
        { id = "navGroup", label = "Navigation", groupMembers = { "navLeft", "navRight" }},
        { id = "navLeft", image = hs.image.imageFromName("NSGoLeftTemplate"), allowedAlone = false },
        { id = "navRight", image = hs.image.imageFromName("NSGoRightTemplate"), allowedAlone = false },
        { id = "NSToolbarFlexibleSpaceItem" },
        { id = "cust", label = "customize", fn = function(t, w, i) t:customizePanel() end, image = hs.image.imageFromName("NSAdvanced") }
    }):canCustomize(true)
      :autosaves(true)
      :selectedItem("select2")
      :setCallback(function(...)
                        print("a", inspect(table.pack(...)))
                   end)

t.attachToolbar(a)

Примечания:

  • Этот модуль поддерживается в версиях macOS до 10.10 (только для консоли Hammerspoon), даже если его родительский hs.webview нет. Чтобы загрузить этот модуль напрямую, используйте require("hs.webview.toolbar") вместо полагания на автоматическую загрузку модулей.
  • Элементы панели инструментов отображаются в порядке их предоставления, хотя если панель инструментов помечена как настраиваемая, пользователь может изменить порядок.

Обзор API

  • Константы - полезные значения, которые нельзя изменить
    • itemPriorities
    • systemToolbarItems
  • Функции - вызовы API, предлагаемые непосредственно расширением
    • attachToolbar
    • inTitleBar
    • uniqueName
  • Конструкторы - вызовы API, которые возвращают объект, обычно объект, предлагающий методы API
    • new
  • Методы - вызовы API, которые могут быть выполнены только на объекте, возвращённом конструктором
    • addItems
    • allowedItems
    • autosaves
    • canCustomize
    • copy
    • customizePanel
    • delete
    • deleteItem
    • displayMode
    • identifier
    • insertItem
    • isAttached
    • isCustomizing
    • itemDetails
    • items
    • modifyItem
    • notifyOnChange
    • removeItem
    • savedSettings
    • selectedItem
    • selectSearchField
    • separator
    • setCallback
    • sizeMode
    • toolbarStyle
    • visible
    • visibleItems

Документация API

Константы

itemPriorities
Подпись hs.webview.toolbar.itemPriorities
Тип Константа
Описание

Таблица, содержащая некоторые предопределённые значения приоритетов элементов панели инструментов для использования при определении порядка элементов на панели инструментов.

Источник extensions/webview/libwebview_toolbar.m строка 1938
systemToolbarItems
Подпись hs.webview.toolbar.systemToolbarItems
Тип Константа
Описание

Массив, содержащий строковые идентификаторы поддерживаемых системных элементов панели инструментов.

Источник extensions/webview/libwebview_toolbar.m строка 1926

Функции

attachToolbar
Подпись hs.webview.toolbar.attachToolbar([obj1], [obj2]) -> obj1
Тип Функция
Описание

Получить или прикрепить/открепить панель инструментов к webview, выбору или консоли.

Параметры
  • obj1 - Необязательный объект toolbarObject
  • obj2 - Необязательный объект toolbarObject
    • если аргументы отсутствуют, эта функция возвращает текущий объект toolbarObject для консоли Hammerspoon или nil, если он не прикреплён.
    • если предоставлен один аргумент, и это объект toolbarObject или nil, эта функция прикрепит или открепит объект toolbarObject к/от консоли Hammerspoon.
    • если предоставлен один аргумент, и это объект hs.webview или hs.chooser, эта функция вернёт текущий объект toolbarObject для объекта или nil, если он не прикреплён.
    • если предоставлены два аргумента, и первый - объект hs.webview или hs.chooser, а второй - объект toolbarObject или nil, эта функция прикрепит или открепит объект toolbarObject к/от объекта.
Возвращаемое значение
  • если функция используется для прикрепления/открепления панели инструментов, то будет возвращён первый предоставленный объект (целевой); если эта функция используется для получения текущего объекта панели инструментов для webview, выбора или консоли, то будет возвращён объект toolbarObject или nil.
Примечания
  • Не ожидается, что эта функция будет использоваться напрямую (хотя это возможно) - она добавляется в метатаблицы объектов hs.webview и hs.chooser, чтобы её можно было вызывать как hs.webview:attachedToolbar([toolbarObject | nil])/hs.chooser:attachedToolbar([toolbarObject | nil]), и в модуль hs.console, чтобы её можно было вызывать как hs.console.toolbar([toolbarObject | nil]).

  • Если панель инструментов в данный момент прикреплена к другому окну при вызове этой функции, она будет откреплена от исходного окна и прикреплена к новому окну, указанному в этой функции.

Источник extensions/webview/libwebview_toolbar.m строка 863
inTitleBar
Подпись hs.webview.toolbar:inTitleBar([state]) -> toolbarObject | boolean
Тип Функция
Описание

Получить или установить, отображается ли панель инструментов в строке заголовка содержащего окна, подобно Safari.

Параметры
  • state - необязательный булево значение, указывающее, должна ли панель инструментов отображаться в строке заголовка окна.
Возвращаемое значение
  • если параметр указан, возвращается объект панели инструментов, в противном случае текущее значение.
Примечания
  • Когда это значение true, панель инструментов, когда она видна, будет отображаться в строке заголовка окна аналогично панели инструментов, как в таких приложениях, как Safari. В этом состоянии панель инструментов установит отображение элементов панели инструментов на значки без меток, игнорируя изменения, внесённые с помощью hs.webview.toolbar:displayMode.

  • Этот метод действителен только при прикреплении панели инструментов к webview, выбору или консоли.

Источник extensions/webview/libwebview_toolbar.m строка 986
uniqueName
Подпись hs.webview.toolbar.uniqueName(toolbarName) -> boolean
Тип Функция
Описание

Проверяет, используется ли имя панели инструментов уже.

Параметры
  • toolbarName - строка, определяющая имя панели инструментов
Возвращаемое значение
  • true если имя уникально, в противном случае false
Источник extensions/webview/libwebview_toolbar.m строка 846

Конструкторы

new
Подпись hs.webview.toolbar.new(toolbarName, [toolbarTable]) -> toolbarObject
Тип Конструктор
Описание

Создаёт новую панель инструментов для webview, выбора или консоли.

Параметры
  • toolbarName - строка, определяющая имя для этой панели инструментов
  • toolbarTable - необязательная таблица, описывающая возможные элементы для панели инструментов
Возвращаемое значение
  • объект toolbarObject
Примечания
  • Имена панелей инструментов должны быть уникальными, но панель инструментов может быть скопирована с помощью hs.webview.toolbar:copy, если вы хотите прикрепить её к нескольким окнам (webview, выбор или консоль).
  • См. hs.webview.toolbar:addItems для описания формата toolbarTable.
Источник extensions/webview/libwebview_toolbar.m строка 809

Методы

addItems
Signature hs.webview.toolbar:addItems(toolbarTable) -> toolbarObject
Type Method
Description

Добавить один или несколько элементов панели инструментов на панель инструментов

Parameters
  • toolbarTable - таблица, описывающая один элемент панели инструментов, или массив таблиц, каждая из которых описывает отдельный элемент панели инструментов, который нужно добавить на панель инструментов.
Returns
  • объект панели инструментов
Notes
  • Каждый элемент панели инструментов определяется как таблица пар ключ-значение. Следующий список описывает допустимые ключи, используемые при описании элемента панели инструментов для этого метода, конструктора hs.webview.toolbar.new и метода hs.webview.toolbar:modifyItem. Обратите внимание, что поле id является обязательным для всех трёх случаев.
    • id - уникальный строковый идентификатор, необходимый для каждого элемента и группы панели инструментов. Этот ключ нельзя изменить после создания элемента.
    • allowedAlone - булево значение, по умолчанию true, определяющее, можно ли добавить элемент панели инструментов на панель инструментов программно или через панель настройки (true), или же его можно добавить только в качестве члена группы (false).
    • default - булево значение, по умолчанию совпадающее со значением allowedAlone для данного элемента, указывающее, должен ли этот элемент или группа отображаться на панели инструментов по умолчанию, если это не переопределено пользователем или сохранённой конфигурацией (если такие опции включены).
    • enable - булево значение, по умолчанию true, указывающее, активен ли элемент панели инструментов (и можно ли на него нажать) или неактивен и серым цветом (выключен). Это поле игнорируется, когда применяется к группе элементов панели инструментов; примените его к членам группы вместо этого.
    • fn - функция обратного вызова или false для удаления, специфичная для элемента панели инструментов. Это свойство игнорируется, если оно назначено группе кнопок. Эта функция переопределит функцию обратного вызова панели инструментов, определённую с помощью hs.webview.toolbar:setCallback для этого конкретного элемента. Функция должна принимать три (четыре, если элемент является searchfield) аргумента и не возвращать значения. См. hs.webview.toolbar:setCallback за информацией о параметрах обратного вызова.
    • groupMembers - массив (таблица) строк, определяющих идентификаторы элементов панели инструментов, которые являются членами этой группы элементов панели инструментов. Если значение равно false, это поле удаляется, а элемент восстанавливается в качестве обычного элемента панели инструментов. Обратите внимание, что нельзя изменить текущий видимый элемент панели инструментов на группу или из группы; его сначала нужно удалить из активной панели инструментов с помощью hs.webview.toolbar:removeItem.
    • image - объект hs.image, или false для удаления, определяющий изображение, используемое в качестве значка элемента панели инструментов при отображении значков на панели инструментов или панели настроек. Этот ключ игнорируется для группы элементов панели инструментов, но не для её отдельных членов.
    • label - строковая метка или false для удаления, для элемента или группы панели инструментов, когда текст отображается на панели инструментов или на панели настройки. Для элемента панели инструментов значение по умолчанию - строка id; для группы - false. Если группе назначена метка, метка группы будет отображаться для группы элементов, которые она содержит. Если у группы нет метки, отдельные элементы, составляющие группу, будут отображать свои индивидуальные метки.
    • priority - целочисленное значение, используемое для определения порядка элементов панели инструментов и того, какие элементы отображаются или помещаются в раскрывающееся меню, когда количество элементов на панели инструментов превышает ширину окна, к которому прикреплена панель инструментов. Некоторые примерные значения приведены в таблице hs.webview.toolbar.itemPriorities. Если элемент панели инструментов находится в группе, его приоритет игнорируется, и группа элементов упорядочивается по приоритету группы элементов.
    • searchfield - булево значение (по умолчанию false), указывающее, является ли этот элемент панели инструментов полем поиска. Если true, разрешены следующие дополнительные ключи:
      • searchHistory - массив (таблица) строк, определяющих предыдущие поиски, которые автоматически включаются в меню поля поиска, если searchPredefinedMenuTitle не равно false
      • searchHistoryAutosaveName - строка, определяющая имя ключа для сохранения истории поиска в значениях приложения (доступных через hs.settings). Если это значение установлено, история поиска будет сохраняться при перезапуске Hammerspoon.
      • searchHistoryLimit - максимальное количество элементов для хранения в истории поиска.
      • searchPredefinedMenuTitle - строка или булево значение, определяющее, как предварительно определённый список «ответов» поля поиска следует включать в меню поля поиска. Если это значение true, этот список элементов, указанный для searchPredefinedSearches, будет отображаться в подменю с заголовком «Предварительно определённые поиски». Если это значение является строкой, список элементов будет отображаться в подменю с заголовком, указанным этим значением. Если это значение false, тогда меню поля поиска будет содержать только элементы, указанные в searchPredefinedSearches, и история поиска не будет включена в меню.
      • searchPredefinedSearches - массив (таблица) строк, определяющих элементы, которые будут отображаться в подменю предварительно определённых поисков. Если установлено значение false, любое существующее меню будет удалено, и меню поля поиска будет сброшено до значения по умолчанию.
      • searchReleaseFocusOnCallback - булево значение, по умолчанию false, указывающее, удаляется ли фокус из текстового поля поиска при вызове обратного вызова. Установка этого значения в true может быть полезной, если вы хотите, чтобы последующие нажатия клавиш регистрировались веб-вью после реакции на введённое пользователем значение в поле поиска.
      • searchText - строка, определяющая текст для отображения в поле поиска.
      • searchWidth - ширина текстового поля ввода поля поиска.
    • selectable - булево значение, по умолчанию false, указывающее, можно ли выбрать этот элемент панели инструментов (т. е. выделять, как выделенную вкладку) при нажатии. Одновременно может быть выделен только один настраиваемый элемент панели инструментов, и вы можете получить или установить/сбросить выбранный элемент с помощью hs.webview.toolbar:selectedItem.
    • tag - целочисленное значение, которое можно использовать для собственных целей; не влияет на визуальный аспект элемента или его поведение.
    • tooltip - строковая метка или false для удаления, которая отображается в качестве подсказки, когда пользователь наводит курсор мыши на кнопку или группу кнопок. Если кнопка находится в группе, её подсказка игнорируется в пользу подсказки группы.
Source extensions/webview/webview_toolbar.lua строка 53
allowedItems
Signature hs.webview.toolbar:allowedItems() -> array
Type Method
Description

Возвращает массив всех идентификаторов элементов панели инструментов, определённых для этой панели инструментов.

Parameters
  • None
Returns
  • таблица в виде массива всех идентификаторов элементов панели инструментов, определённых для этой панели инструментов. См. также hs.webview.toolbar:items и hs.webview.toolbar:visibleItems.
Source extensions/webview/libwebview_toolbar.m строка 1657
autosaves
Signature hs.webview.toolbar:autosaves([bool]) -> toolbarObject | bool
Type Method
Description

Получить или установить, сохраняются ли автоматически изменения, внесённые в панель инструментов.

Parameters
  • необязательное булево значение, указывающее, сохраняются ли автоматически внесённые изменения в видимые элементы панели инструментов или их порядок.
Returns
  • если аргумент предоставлен, возвращает объект панели инструментов; в противном случае возвращает текущее значение
Notes
  • Если для панели инструментов установлено автоматическое сохранение, в домене org.hammerspoon.Hammerspoon создаётся запись пользовательских параметров с ключом "NSToolbar Configuration XXX", где XXX - идентификатор панели инструментов, указанный при её создании.
  • Информация, сохраняемая для панели инструментов, состоит из следующего:
    • идентификаторы элементов по умолчанию, отображаемые при первом создании панели инструментов или при перетаскивании набора по умолчанию из панели настроек.
    • текущий режим отображения (значок, текст, оба)
    • текущий режим размера (обычный, малый)
    • видимость панели инструментов
    • текущие отображаемые идентификаторы и их порядок
  • Обратите внимание, что метки, значки, функции обратного вызова и т. д. не сохраняются — они определяются при создании панели инструментов, методом hs.webview.toolbar:addItems или hs.webview.toolbar:modifyItem и могут различаться между вызовами панелей инструментов с одинаковым идентификатором и идентификаторами кнопок.
Source extensions/webview/libwebview_toolbar.m строка 1853
canCustomize
Signature hs.webview.toolbar:canCustomize([bool]) -> toolbarObject | bool
Type Method
Description

Получить или установить, разрешено ли пользователю настраивать панель инструментов с помощью панели настроек.

Parameters
  • необязательное булево значение, указывающее, разрешено ли пользователю настраивать панель инструментов.
Returns
  • если аргумент предоставлен, возвращает объект панели инструментов; в противном случае возвращает текущее значение
Notes
  • панель настроек можно открыть, щелкнув по панели инструментов правой кнопкой мыши или вызвав hs.webview.toolbar:customizePanel.
Source extensions/webview/libwebview_toolbar.m строка 1827
END_OF_DOCUMENT_MARKER
копия
Подпись hs.webview.toolbar:copy() -> toolbarObject
Тип Метод
Описание

Возвращает копию объекта панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • копию панели инструментов, которую можно подключить к другому окну (webview, chooser или консоль).
Источник extensions/webview/libwebview_toolbar.m строка 1040
панель настройки
Подпись hs.webview.toolbar:customizePanel() -> toolbarObject
Тип Метод
Описание

Открывает панель настройки панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • объект панели инструментов
Источник extensions/webview/libwebview_toolbar.m строка 1792
удалить
Подпись hs.webview.toolbar:delete() -> none
Тип Метод
Описание

Удаляет панель инструментов, удаляя ее из окна, если она подключена.

Параметры
  • Нет
Возвращаемое значение
  • Нет
Источник extensions/webview/libwebview_toolbar.m строка 2066
удалитьЭлемент
Подпись hs.webview.toolbar:deleteItem(identifier) -> toolbarObject
Тип Метод
Описание

Полностью удаляет указанный элемент панели инструментов из панели инструментов, предварительно удаляя его, если элемент панели инструментов активен.

Параметры
  • identifier - идентификатор элемента панели инструментов
Возвращаемое значение
  • объект панели инструментов
Примечания
  • Этот метод полностью удаляет элемент панели инструментов из словаря определения панели инструментов, тем самым удаляя его из активного использования в панели инструментов, а также удаляя его из панели настройки, если она поддерживается. Если вы хотите только удалить элемент панели инструментов из активной панели инструментов, используйте hs.webview.toolbar:removeItem.
Источник extensions/webview/libwebview_toolbar.m строка 1557
режимОтображения
Подпись hs.webview.toolbar:displayMode([mode]) -> toolbarObject
Тип Метод
Описание

Получение или установка режима отображения панели инструментов.

Параметры
  • режим - необязательная строка для установки размера панели инструментов на "стандартный", "метка", "иконка" или "оба".
Возвращаемое значение
  • если аргумент предоставлен, возвращает объект панели инструментов; в противном случае возвращает текущее значение
Источник extensions/webview/libwebview_toolbar.m строка 1281
идентификатор
Подпись hs.webview.toolbar:identifier() -> identifier
Тип Метод
Описание

Идентификатор этой панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • Идентификатор этой панели инструментов.
Источник extensions/webview/libwebview_toolbar.m строка 1775
вставитьЭлемент
Подпись hs.webview.toolbar:insertItem(id, index) -> toolbarObject
Тип Метод
Описание

Вставка или перемещение элемента панели инструментов в указанную позицию индекса

Параметры
  • id - строковый идентификатор элемента панели инструментов
  • индекс - числовая позиция, куда должен быть вставлен/перемещен элемент панели инструментов.
Возвращаемое значение
  • объект панели инструментов
Примечания
  • позиция панели инструментов должна быть от 1 до количества активных элементов панели инструментов.
Источник extensions/webview/libwebview_toolbar.m строка 1177
прикреплено
Подпись hs.webview.toolbar:isAttached() -> boolean
Тип Метод
Описание

Возвращает булево значение, указывающее, подключена ли панель инструментов к окну.

Параметры
  • Нет
Возвращаемое значение
  • булево значение, указывающее, подключена ли панель инструментов к окну.
Источник extensions/webview/libwebview_toolbar.m строка 1023
настройка
Подпись hs.webview.toolbar:isCustomizing() -> bool
Тип Метод
Описание

Указывает, открыта ли панель настройки для панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • true или false, указывающее, открыта ли панель настройки для панели инструментов
Источник extensions/webview/libwebview_toolbar.m строка 1810
деталиЭлемента
Подпись hs.webview.toolbar:itemDetails(id) -> table
Тип Метод
Описание

Возвращает таблицу, содержащую подробности о заданном элементе панели инструментов

Параметры
  • id - строковый идентификатор, указывающий на элемент панели инструментов
Возвращаемое значение
  • таблица, содержащая определение элемента панели инструментов
Примечания
  • Список возможных ключей атрибутов элемента панели инструментов см. в hs.webview.toolbar:addItems.
  • Таблица также будет содержать privateCallback, которое будет булевым значением, указывающим, назначена ли данному элементу панели инструментов собственная функция обратного вызова (true) или используется общая функция обратного вызова панели инструментов (false).
  • Возвращаемая таблица также может содержать следующие ключи, если элемент назначен на панель инструментов:
    • toolbar - объект панели инструментов, к которому принадлежит элемент
    • subItems - если элемент панели инструментов на самом деле является группой, это будет содержать таблицу с основной информацией о членах группы. Если вам нужны полные данные для каждого подэлемента, вы можете перебрать предоставленные идентификаторы в groupMembers.
Источник extensions/webview/libwebview_toolbar.m строка 1593
элементы
Подпись hs.webview.toolbar:items() -> array
Тип Метод
Описание

Возвращает массив идентификаторов элементов панели инструментов, назначенных панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • таблица в виде массива текущих активных (назначенных) идентификаторов элементов панели инструментов. Элементы панели инструментов, которые находятся в раскрывающемся меню, включены в этот массив. См. также hs.webview.toolbar:visibleItems и hs.webview.toolbar:allowedItems.
Источник extensions/webview/libwebview_toolbar.m строка 1674
изменитьЭлемент
Подпись hs.webview.toolbar:modifyItem(table) -> toolbarObject
Тип Метод
Описание

Изменяет элемент панели инструментов, заданный ключом "id" в аргументе таблицы.

Параметры
  • таблица, содержащая ключ "id" и атрибуты для изменения элемента панели инструментов.
Возвращаемое значение
  • объект панели инструментов
Примечания
  • Вы не можете изменить id
  • Список возможных ключей атрибутов элемента панели инструментов см. в hs.webview.toolbar:addItems.
Источник extensions/webview/libwebview_toolbar.m строка 1414
уведомитьОбИзменении
Подпись hs.webview.toolbar:notifyOnChange([bool]) -> toolbarObject | bool
Тип Метод
Описание

Получение или установка значения, указывающего, вызывается ли функция глобального обратного вызова при добавлении или удалении элемента панели инструментов из панели инструментов.

Параметры
  • необязательное булево значение для включения или отключения вызова глобальной функции обратного вызова при изменении панели инструментов.
Возвращаемое значение
  • если аргумент предоставлен, возвращает объект панели инструментов; в противном случае возвращает текущее значение
Источник extensions/webview/libwebview_toolbar.m строка 1155
END_OF_DOCUMENT_MARKER
removeItem
Подпись hs.webview.toolbar:removeItem(index | identifier) -> toolbarObject
Тип Метод
Описание

Удаляет элемент панели инструментов по указанному индексу или по указанному идентификатору, если он присутствует в панели инструментов.

Параметры
  • index - числовая позиция элемента панели инструментов, который нужно удалить.
  • identifier - идентификатор элемента панели инструментов, который нужно удалить, если он активен в панели инструментов.
Возвращаемое значение
  • объект панели инструментов
Примечания
  • позиция элемента панели инструментов должна быть между 1 и количеством активных элементов панели инструментов.
Источник extensions/webview/webview_toolbar.lua строка 97
savedSettings
Подпись hs.webview.toolbar:savedSettings() -> table
Тип Метод
Описание

Возвращает таблицу, содержащую настройки, которые будут сохранены для панели инструментов, если hs.webview.toolbar:autosaves имеет значение true.

Параметры
  • Нет
Возвращаемое значение
  • таблица, содержащая настройки панели инструментов
Примечания
  • Если для панели инструментов установлено автоматическое сохранение, в домене org.hammerspoon.Hammerspoon создается запись user-defaults с ключом "NSToolbar Configuration XXX", где XXX — идентификатор панели инструментов, указанный при её создании.
  • Этот метод предоставляется в случае, если вы не хотите, чтобы изменения в панели инструментов автоматически сохранялись при каждом изменении, но хотите сохранить их программно в определённых условиях.
Источник extensions/webview/libwebview_toolbar.m строка 1090
selectedItem
Подпись hs.webview.toolbar:selectedItem([item]) -> toolbarObject | item
Тип Метод
Описание

Получить или установить выбранный элемент панели инструментов.

Параметры
  • item - необязательный идентификатор элемента панели инструментов, который нужно выделить, или явное nil, если вы хотите, чтобы не было выделенного элемента.
Возвращаемое значение
  • при предоставлении аргумента возвращается объект панели инструментов; в противном случае возвращается текущее значение
Примечания
  • Выбрать можно только те элементы панели инструментов, которые были определены как selectable при создании с помощью hs.webview.toolbar.new.
Источник extensions/webview/libwebview_toolbar.m строка 1708
selectSearchField
Подпись hs.webview.toolbar:selectSearchField([identifier]) -> toolbarObject | false
Тип Метод
Описание

Программно фокусировать поле поиска для ввода с клавиатуры.

Параметры
  • identifier - необязательная строка, определяющая идентификатор конкретного поля поиска, на котором нужно сфокусироваться. Если этот параметр не предоставлен, этот метод пытается сфокусироваться на первом активном поле поиска, найденном в панели инструментов.
Возвращаемое значение
  • если поле поиска найдено и в настоящее время находится в панели инструментов, возвращается toolbarObject; в противном случае возвращается false.
Примечания
  • если в поле поиска есть текст, он будет выделен, чтобы любое последующее нажатие клавиш пользователем заменяло текущее значение в поле поиска.
Источник extensions/webview/libwebview_toolbar.m строка 1741
separator
Подпись hs.webview.toolbar:separator([bool]) -> toolbarObject | bool
Тип Метод
Описание

Получить или установить, отображает ли панель инструментов разделитель между панелью инструментов и содержимым основного окна.

Параметры
  • необязательное логическое значение для включения или выключения разделителя.
Возвращаемое значение
  • при предоставлении аргумента возвращается объект панели инструментов; в противном случае возвращается текущее значение
Источник extensions/webview/libwebview_toolbar.m строка 1111
setCallback
Подпись hs.webview.toolbar:setCallback(fn) -> toolbarObject
Тип Метод
Описание

Устанавливает или удаляет глобальную функцию обратного вызова для панели инструментов.

Параметры
  • fn - функция, которая должна быть установлена в качестве глобальной функции обратного вызова для панели инструментов, или nil для удаления глобальной функции обратного вызова. Функция должна ожидать три (четыре, если searchfield или notifyOnChange равно true) аргумента и не возвращать ничего: объект панели инструментов, "консоль" или объект webview/chooser, к которому прикреплена панель инструментов, и идентификатор элемента панели инструментов, на который был нажат.
Возвращаемое значение
  • объект панели инструментов
Примечания
  • глобальная функция обратного вызова вызывается для элемента кнопки панели инструментов, которому не назначена конкретная функция непосредственно.
  • если hs.webview.toolbar:notifyOnChange установлено в true, то эта функция обратного вызова также будет вызываться при добавлении или удалении элемента панели инструментов из панели инструментов, как программно с помощью hs.webview.toolbar:insertItem и hs.webview.toolbar:removeItem, так и под управлением пользователя с помощью hs.webview.toolbar:customizePanel, и функция обратного вызова получит строку "add" или "remove" в качестве четвёртого аргумента.
Источник extensions/webview/libwebview_toolbar.m строка 1062
sizeMode
Подпись hs.webview.toolbar:sizeMode([size]) -> toolbarObject
Тип Метод
Описание

Получить или установить размер панели инструментов.

Параметры
  • size - необязательная строка для установки размера панели инструментов на "default", "regular" или "small".
Возвращаемое значение
  • при предоставлении аргумента возвращается объект панели инструментов; в противном случае возвращается текущее значение
Источник extensions/webview/libwebview_toolbar.m строка 1234
toolbarStyle
Подпись hs.webview.toolbar:toolbarStyle([style]) -> toolbarObject
Тип Метод
Описание

Получить или установить стиль панели инструментов.

Параметры
  • style - необязательная строка для установки стиля панели инструментов на "automatic", "expanded", "preference", "unified" или "unifiedCompact".
Возвращаемое значение
  • при предоставлении аргумента возвращается объект панели инструментов; в противном случае возвращается текущее значение
Примечания
  • Доступно только для macOS 11.0+. Вернёт nil при получении на более ранних версиях macOS.
  • automatic - Стиль, указывающий, что система определяет внешний вид и расположение панели инструментов.
  • expanded - Стиль, указывающий, что панель инструментов отображается под заголовком окна.
  • preference - Стиль, указывающий, что панель инструментов отображается под заголовком окна с центрированными элементами.
  • unified - Стиль, указывающий, что панель инструментов отображается рядом с заголовком окна.
  • unifiedCompact - Стиль, указывающий, что панель инструментов отображается рядом с заголовком окна с уменьшенными отступами, что позволяет сконцентрироваться на содержимом окна.
Источник extensions/webview/libwebview_toolbar.m строка 1333
visible
Подпись hs.webview.toolbar:visible([bool]) -> toolbarObject | bool
Тип Метод
Описание

Получить или установить, отображается ли панель инструментов в окне, к которому она прикреплена.

Параметры
  • необязательное логическое значение для отображения или скрытия панели инструментов.
Возвращаемое значение
  • при предоставлении аргумента возвращается объект панели инструментов; в противном случае возвращается текущее значение
Источник extensions/webview/libwebview_toolbar.m строка 1133
visibleItems
Подпись hs.webview.toolbar:visibleItems() -> array
Тип Метод
Описание

Возвращает массив текущих видимых идентификаторов элементов панели инструментов.

Параметры
  • Нет
Возвращаемое значение
  • таблица в виде массива текущих видимых идентификаторов элементов панели инструментов. Элементы панели инструментов, которые находятся в меню переполнения, не включены в этот массив. См. также hs.webview.toolbar:items и hs.webview.toolbar:allowedItems.
Источник extensions/webview/libwebview_toolbar.m строка 1691

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.webview.toolbar.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API