Spec-Zone.ru › Hammerspoon

hs.dialog

Набор полезных диалоговых окон, сообщений и панелей для взаимодействия пользователя.

Подмодули

  • hs.dialog.color

Обзор API

  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • alert
    • blockAlert
    • chooseFileOrFolder
    • textPrompt
    • webviewAlert

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

Функции

alert
Подпись hs.dialog.alert(x, y, callbackFn, message, [informativeText], [buttonOne], [buttonTwo], [style]) -> string
Тип Функция
Описание

Отображает простое неблокирующее диалоговое окно с использованием NSAlert и скрытого hs.webview, которое автоматически уничтожается при закрытии сообщения.

Параметры
  • x - Число, содержащее горизонтальную координату левой верхней точки диалогового окна. По умолчанию 1.
  • y - Число, содержащее вертикальную координату левой верхней точки диалогового окна. По умолчанию 1.
  • callbackFn - Функция обратного вызова, которая вызывается при нажатии кнопки.
  • message - Текст сообщения для отображения.
  • [informativeText] - Необязательный информативный текст для отображения.
  • [buttonOne] - Необязательное значение для первой кнопки в виде строки. По умолчанию «OK».
  • [buttonTwo] - Необязательное значение для второй кнопки в виде строки. Если используется nil, вторая кнопка не будет отображаться.
  • [style] - Необязательный стиль диалогового окна в виде строки. По умолчанию «warning».
Возвращаемое значение
  • nil
Примечания
  • Необязательные значения должны вводиться в порядке (т.е. вы не можете указать style, не указав также buttonOne и buttonTwo).
  • [style] может быть «warning», «informational» или «critical». Если задано значение, отличное от этих строк, будет использоваться «informational».
  • Пример:
    testCallbackFn = function(result) print("Callback Result: " .. result) end
    hs.dialog.alert(100, 100, testCallbackFn, "Message", "Informative Text", "Button One", "Button Two", "NSCriticalAlertStyle")
    hs.dialog.alert(200, 200, testCallbackFn, "Message", "Informative Text", "Single Button")```
    
Источник extensions/dialog/dialog.lua строка 20
blockAlert
Подпись hs.dialog.blockAlert(message, informativeText, [buttonOne], [buttonTwo], [style]) -> string
Тип Функция
Описание

Отображает простое диалоговое окно с использованием NSAlert, которое приостановит обработку кода Lua, пока сообщение не будет закрыто.

Параметры
  • message - Текст сообщения для отображения.
  • informativeText - Информативный текст для отображения.
  • [buttonOne] - Необязательное значение для первой кнопки в виде строки. По умолчанию «OK».
  • [buttonTwo] - Необязательное значение для второй кнопки в виде строки. Если используется nil, вторая кнопка не будет отображаться.
  • [style] - Необязательный стиль диалогового окна в виде строки. По умолчанию «informational».
Возвращаемое значение
  • Значение кнопки в виде строки.
Примечания
  • Необязательные значения должны вводиться в порядке (т.е. вы не можете указать style, не указав также buttonOne и buttonTwo).
  • [style] может быть «warning», «informational» или «critical». Если задано значение, отличное от этих строк, будет использоваться «informational».
  • Пример: hs.dialog.blockAlert("Message", "Informative Text", "Button One", "Button Two", "NSCriticalAlertStyle")
Источник extensions/dialog/libdialog.m строка 564
chooseFileOrFolder
Подпись hs.dialog.chooseFileOrFolder([message], [defaultPath], [canChooseFiles], [canChooseDirectories], [allowsMultipleSelection], [allowedFileTypes], [resolvesAliases]) -> string
Тип Функция
Описание

Отображает диалоговое окно выбора файла и/или папки с использованием NSOpenPanel.

Параметры
  • [message] - Необязательный текст сообщения для отображения.
  • [defaultPath] - Необязательный путь, к которому вы хотите открыть диалоговое окно.
  • [canChooseFiles] - Разрешает ли пользователю выбирать файлы. По умолчанию true.
  • [canChooseDirectories] - Разрешает ли пользователю выбирать папки. По умолчанию false.
  • [allowsMultipleSelection] - Разрешить множественный выбор файлов и/или папок. По умолчанию false.
  • [allowedFileTypes] - Необязательный массив разрешённых типов файлов. По умолчанию true.
  • [resolvesAliases] - Необязательный булевый параметр, указывающий, разрешает ли панель псевдонимы.
Возвращаемое значение
  • Выбранные файлы в массиве или nil если была нажата отмена.
Примечания
  • Необязательные значения должны вводиться в порядке (т.е. вы не можете указать allowsMultipleSelection, не указав также canChooseFiles и canChooseDirectories).
  • Пример: hs.inspect(hs.dialog.chooseFileOrFolder("Please select a file:", "~/Desktop", true, false, true, {"jpeg", "pdf"}, true))
Источник extensions/dialog/libdialog.m строка 327
textPrompt
Подпись hs.dialog.textPrompt(message, informativeText, [defaultText], [buttonOne], [buttonTwo], [secureField]) -> string, string
Тип Функция
Описание

Отображает простое диалоговое окно для ввода текста.

Параметры
  • message - Текст сообщения для отображения
  • informativeText - Информативный текст для отображения
  • [defaultText] - Информативный текст для отображения
  • [buttonOne] - Необязательное значение для первой кнопки в виде строки
  • [buttonTwo] - Необязательное значение для второй кнопки в виде строки
  • [secureField] - Необязательный булевый параметр. Если true, вместо TextField используется PasswordField. По умолчанию false.
Возвращаемое значение
  • Значение кнопки в виде строки
  • Значение введённого текста в виде строки
Примечания
  • buttonOne по умолчанию «OK», если значение не указано.
  • buttonOne также будет вызван при нажатии ENTER, в то время как buttonTwo будет вызван при нажатии ESC.
  • Примеры: hs.dialog.textPrompt("Main message.", "Please enter something:") hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK") hs.dialog.textPrompt("Main message.", "Please enter something:", "Default Value", "OK", "Cancel") hs.dialog.textPrompt("Main message.", "Please enter something:", "", "OK", "Cancel", true)
Источник extensions/dialog/libdialog.m строка 665
webviewAlert
Подпись hs.dialog.webviewAlert(webview, callbackFn, message, [informativeText], [buttonOne], [buttonTwo], [style]) -> string
Тип Функция
Описание

Отображает простое диалоговое окно с использованием NSAlert в hs.webview.

Параметры
  • webview - hs.webview для отображения сообщения.
  • callbackFn - Функция обратного вызова, которая вызывается при нажатии кнопки.
  • message - Текст сообщения для отображения.
  • [informativeText] - Необязательный информативный текст для отображения.
  • [buttonOne] - Необязательное значение для первой кнопки в виде строки. По умолчанию «OK».
  • [buttonTwo] - Необязательное значение для второй кнопки в виде строки. Если nil используется, вторая кнопка не будет отображаться.
  • [style] - Необязательный стиль диалогового окна в виде строки. По умолчанию «warning».
Возвращаемое значение
  • nil
Примечания
  • Это сообщение блокирует взаимодействие пользователя с hs.webview до нажатия кнопки в сообщении.
  • Необязательные значения должны вводиться в порядке (т.е. вы не можете указать style, не указав также buttonOne и buttonTwo).
  • [style] может быть «warning», «informational» или «critical». Если задано значение, отличное от этих строк, будет использоваться «informational».
  • Пример:
    testCallbackFn = function(result) print("Callback Result: " .. result) end
    testWebviewA = hs.webview.newBrowser(hs.geometry.rect(250, 250, 250, 250)):show()
    testWebviewB = hs.webview.newBrowser(hs.geometry.rect(450, 450, 450, 450)):show()
    hs.dialog.webviewAlert(testWebviewA, testCallbackFn, "Message", "Informative Text", "Button One", "Button Two", "warning")
    hs.dialog.webviewAlert(testWebviewB, testCallbackFn, "Message", "Informative Text", "Single Button")```
    
Источник extensions/dialog/libdialog.m строка 440

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

Spec-Zone.ru

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