Spec-Zone.ru › Hammerspoon

hs.console

Некоторые функции для управления консолью Hammerspoon.

Эти функции позволяют изменять поведение и отображение консоли Hammerspoon. Они следует считать экспериментальными, но работают хорошо.

Обзор API

  • Устаревшие - Функциональные возможности API, которые будут удалены в будущих релизах
    • asHSDrawing
    • asHSWindow
  • Константы - Полезные значения, которые нельзя изменить
    • defaultToolbar
  • Функции - Вызовы API, предлагаемые непосредственно расширением
    • alpha
    • behaviorAsLabels
    • очиститьКонсоль
    • цветКомандыКонсоли
    • шрифтКонсоли
    • цветВыводаКонсоли
    • цветРезультатаКонсоли
    • режимНочи
    • получитьКонсоль
    • получитьИсторию
    • hswindow
    • цветФонаВвода
    • уровень
    • максимальнаяИсторияВывода
    • цветФонаВывода
    • вывестиСтилевыйТекст
    • установитьКонсоль
    • установитьИсторию
    • smartInsertDeleteEnabled
    • видимостьЗаголовка
    • цветФонаОкна
  • Методы - Вызовы API, которые могут быть выполнены только на объекте, возвращённом конструктором
    • поведение
    • панельИнструментов

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

Устаревшие

asHSDrawing
Подпись hs.console.asHSDrawing() -> hs.drawing object
Тип Устаревший
Описание

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

Источник extensions/console/console.lua строка 43
asHSWindow
Подпись hs.console.asHSWindow() -> hs.window object
Тип Устаревший
Описание

Возвращает объект hs.window для консоли, чтобы вы могли использовать методы hs.window на нём.

Источник extensions/console/console.lua строка 78

Константы

defaultToolbar
Подпись hs.console.defaultToolbar
Тип Константа
Описание

Стандартная панель инструментов для окна консоли

Примечания
  • Это объект hs.toolbar, который по умолчанию отображается в консоли Hammerspoon
  • Вы можете удалить эту панель инструментов, добавив hs.console.toolbar(nil) в свою конфигурацию, или заменить её собственным объектом hs.webview.toolbar
Источник extensions/_coresetup/_coresetup.lua строка 700
END_OF_DOCUMENT_MARKER

Функции

alpha
Подпись hs.console.alpha([alpha]) -> currentValue
Тип Функция
Описание

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

Параметры
  • alpha - необязательное число от 0,0 до 1,0, определяющее новый уровень прозрачности консоли Hammerspoon.
Возвращает
  • текущее, возможно новое, значение.
Исходный код extensions/console/libconsole.m строка 506
behaviorAsLabels
Подпись hs.console.behaviorAsLabels(behaviorTable) -> currentValue
Тип Функция
Описание

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

Параметры
  • behaviorTable - необязательная таблица строк и/или чисел, определяющая желаемое поведение окна консоли Hammerspoon.
Возвращает
  • текущее (возможно, новое) значение.
Примечания
  • Настройки поведения окна определяют, как консоль обрабатывается функциями Spaces и Exposé. Подробнее см. в hs.drawing.windowBehaviors.
Исходный код extensions/console/console.lua строка 88
clearConsole
Подпись hs.console.clearConsole() -> nil
Тип Функция
Описание

Очистить окно вывода консоли Hammerspoon.

Параметры
  • Нет
Возвращает
  • Нет
Примечания
  • Эквивалентно hs.console.setConsole()
Исходный код extensions/console/console.lua строка 27
consoleCommandColor
Подпись hs.console.consoleCommandColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет, которым отображаются команды в консоли Hammerspoon.

Параметры
  • color - необязательная таблица с ключами цвета, как описано в hs.drawing.color
Возвращает
  • текущую настройку цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash, или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить дополнительную информацию о том, как указать цвет.
  • Обратите внимание, что это влияет только на будущий вывод — всё, что уже есть в консоли, останется своим первоначальным цветом.
Исходный код extensions/console/libconsole.m строка 143
consoleFont
Подпись hs.console.consoleFont([font]) -> fontTable
Тип Функция
Описание

Получить или установить шрифт, используемый в консоли Hammerspoon.

Параметры
  • font - необязательная строка или таблица, описывающая шрифт для использования в консоли. Если указана строка, используется стандартный системный размер шрифта. Если указана таблица, она должна содержать пары ключ-значение name, и size, описывающие используемый шрифт.
Возвращает
  • текущую настройку шрифта в виде таблицы, содержащей ключ name, и ключ size.
Примечания
  • См. запись hs.drawing.color в документации Dash, или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить дополнительную информацию о том, как указать цвет.
  • Обратите внимание, что это влияет только на будущий вывод — всё, что уже есть в консоли, сохранит свой текущий шрифт.
Исходный код extensions/console/libconsole.m строка 117
consolePrintColor
Подпись hs.console.consolePrintColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет, которым отображается обычный вывод в консоли Hammerspoon.

Параметры
  • color - необязательная таблица с ключами цвета, как описано в hs.drawing.color
Возвращает
  • текущую настройку цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash, или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить дополнительную информацию о том, как указать цвет.
  • Обратите внимание, что это влияет только на будущий вывод — всё, что уже есть в консоли, останется своим первоначальным цветом.
Исходный код extensions/console/libconsole.m строка 65
consoleResultColor
Подпись hs.console.consoleResultColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет, которым отображаются результаты функций в консоли Hammerspoon.

Параметры
  • color - необязательная таблица с ключами цвета, как описано в hs.drawing.color
Возвращает
  • текущую настройку цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash, или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить дополнительную информацию о том, как указать цвет.
  • Обратите внимание, что это влияет только на будущий вывод — всё, что уже есть в консоли, останется своим первоначальным цветом.
Исходный код extensions/console/libconsole.m строка 169
END_OF_DOCUMENT_MARKER
darkMode
Подпись hs.console.darkMode([state]) -> bool
Тип Функция
Описание

Устанавливает или отображает, должен ли оконный Console отображаться в тёмном режиме.

Параметры
  • state - необязательный булевый параметр, который устанавливает, должен ли оконный Console отображаться в тёмном режиме.
Возвращаемое значение
  • Булево значение, true, если тёмный режим включён, в противном случае false.
Примечания
  • Включение тёмного режима для окна Console затрагивает только фоновый цвет окна, и не изменяет автоматически цвет фона Console, поэтому вам необходимо добавить что-то подобное:
    if hs.console.darkMode() then
        hs.console.outputBackgroundColor{ white = 0 }
        hs.console.consoleCommandColor{ white = 1 }
        hs.console.alpha(.8)
    end
    

. ```

Источник extensions/console/libconsole.m строка 33
getConsole
Подпись hs.console.getConsole([styled]) -> text | styledText
Тип Функция
Описание

Получить текст из окна вывода консоли Hammerspoon.

Параметры
  • styled - необязательный булевый параметр, указывающий, возвращается ли текст консоли как строка или объект styledText. По умолчанию false.
Возвращаемое значение
  • Текст, отображаемый в окне вывода консоли Hammerspoon, в виде строки или объекта hs.styledtext.
Примечания
  • Если текст консоли извлекается как строка, информация о цвете или стиле в выводе консоли не извлекается — только сам текст.
Источник extensions/console/libconsole.m строка 373
getHistory
Подпись hs.console.getHistory() -> array
Тип Функция
Описание

Получить историю команд консоли Hammerspoon в виде массива.

Параметры
  • Нет
Возвращаемое значение
  • массив, содержащий историю команд, введённых в консоль Hammerspoon.
Источник extensions/console/libconsole.m строка 314
hswindow
Подпись hs.console.hswindow() -> hs.window object
Тип Функция
Описание

Получить объект hs.window, представляющий окно консоли Hammerspoon.

Параметры
  • Нет
Возвращаемое значение
  • объект hs.window
Источник extensions/console/libconsole.m строка 195
inputBackgroundColor
Подпись hs.console.inputBackgroundColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет фона поля ввода консоли Hammerspoon.

Параметры
  • color - необязательный столбец, содержащий ключи цвета, как описано в hs.drawing.color
Возвращаемое значение
  • текущее значение цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить более подробную информацию о том, как указать цвет.
Источник extensions/console/libconsole.m строка 266
level
Подпись hs.console.level([theLevel]) -> currentValue
Тип Функция
Описание

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

Параметры
  • theLevel - необязательный параметр, определяющий желаемый уровень как целое число, которое можно получить из hs.drawing.windowLevels.
Возвращаемое значение
  • текущее, возможно новое, значение
Примечания
  • см. примечания для hs.drawing.windowLevels
Источник extensions/console/libconsole.m строка 474
maxOutputHistory
Подпись hs.console.maxOutputHistory([length]) -> number
Тип Функция
Описание

Получить или установить максимальную длину истории прокрутки консоли Hammerspoon.

Параметры
  • length - необязательное число, содержащее максимальный размер в байтах истории консоли Hammerspoon.
Возвращаемое значение
  • текущий максимальный размер истории консоли
Примечания
  • Значение length, равное нулю, позволит истории расти бесконечно
  • По умолчанию история консоли составляет 100 000 символов
Источник extensions/console/libconsole.m строка 91
outputBackgroundColor
Подпись hs.console.outputBackgroundColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет фона области вывода консоли Hammerspoon.

Параметры
  • color - необязательный столбец, содержащий ключи цвета, как описано в hs.drawing.color
Возвращаемое значение
  • текущее значение цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить более подробную информацию о том, как указать цвет.
Источник extensions/console/libconsole.m строка 241
printStyledtext
Подпись hs.console.printStyledtext(...) -> none
Тип Функция
Описание

Функция вывода, распознающая объекты hs.styledtext и отображающая их как таковые в консоли Hammerspoon.

Параметры
  • Можно указать любое количество аргументов, как и в встроенной Lua print команде. Если аргумент соответствует типу userdata hs.styledtext, текст отображается в соответствии с его атрибутами стиля в консоли Hammerspoon; в противном случае он отображается так же, как и с помощью традиционной print команды в Hammerspoon.
Возвращаемое значение
  • Нет
Примечания
  • Это сделано максимально близко к Lua print команде. Вы можете заменить существующую команду print на эту, добавив следующее в ваш файл init.lua:
   print = function(...)
       hs.rawprint(...)
       hs.console.printStyledtext(...)
   end
Источник extensions/console/libconsole.m строка 423
setConsole
Подпись hs.console.setConsole([styledText]) -> none
Тип Функция
Описание

Очистить окно вывода консоли Hammerspoon.

Параметры
  • styledText - необязательный объект hs.styledtext содержащий текст, которым вы хотите заменить вывод консоли Hammerspoon. Если вы не предоставляете аргумент, консоль очищается от всего содержимого.
Возвращаемое значение
  • Нет
Примечания
  • Вы можете указать содержимое консоли как строку или как объект hs.styledtext в формате userdata или таблицы.
Источник extensions/console/libconsole.m строка 332
setHistory
Подпись hs.console.setHistory(array) -> nil
Тип Функция
Описание

Установить историю команд консоли Hammerspoon на элементы, указанные в заданном массиве.

Параметры
  • array - список команд, на которые нужно установить историю консоли Hammerspoon.
Возвращаемое значение
  • Нет
Примечания
  • Вы можете очистить историю консоли, используя пустой массив (например, hs.console.setHistory({})
Источник extensions/console/libconsole.m строка 400
smartInsertDeleteEnabled
Подпись hs.console.smartInsertDeleteEnabled([flag]) -> bool
Тип Функция
Описание

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

Параметры
  • flag - необязательное булевое значение, указывающее, включено ли «умное» поведение пробелов при копировании из консоли Hammerspoon.
Возвращаемое значение
  • текущее значение
Примечания
  • Это относится только к будущим операциям копирования из консоли Hammerspoon — уже имеющиеся в буфере обмена данные не затрагиваются.
Источник extensions/console/libconsole.m строка 291
titleVisibility
Подпись hs.console.titleVisibility([state]) -> current value
Тип Функция
Описание

Получить или установить, отображается ли текст "Hammerspoon Console" в строке заголовка консоли Hammerspoon.

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

  • Если к консоли прикреплена панель инструментов, вы можете добиться того же эффекта с помощью hs.console.toolbar():inTitleBar(boolean).

Источник extensions/console/libconsole.m строка 563
windowBackgroundColor
Подпись hs.console.windowBackgroundColor([color]) -> color
Тип Функция
Описание

Получить или установить цвет фона окна консоли Hammerspoon.

Параметры
  • color - необязательная таблица, содержащая ключи цвета, как описано в hs.drawing.color
Возвращаемое значение
  • текущая настройка цвета в виде таблицы
Примечания
  • См. запись hs.drawing.color в документации Dash или введите help.hs.drawing.color в консоли Hammerspoon, чтобы получить больше информации о том, как указать цвет.
Источник extensions/console/libconsole.m строка 216

Методы

behavior
Подпись hs.console.behavior([behavior]) -> currentValue
Тип Метод
Описание

Получить или установить настройки поведения окна для консоли.

Параметры
  • behavior - необязательное число, представляющее желаемые параметры поведения окна для консоли Hammerspoon.
Возвращаемое значение
  • текущее, возможно новое, значение.
Примечания
  • Настройки поведения окна определяют, как объект webview обрабатывается Spaces и Exposé. См. hs.drawing.windowBehaviors для получения дополнительной информации.
Источник extensions/console/libconsole.m строка 528
toolbar
Подпись hs.console.toolbar([toolbar]) -> toolbarObject | currentValue
Тип Метод
Описание

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

Параметры
  • toolbar - если указан объект hs.webview.toolbar, он будет прикреплён к консоли Hammerspoon. Если указан явный nil, текущая панель инструментов будет удалена из консоли.
Возвращаемое значение
  • если указан toolbarObject или явный nil, возвращает toolbarObject; в противном случае возвращает текущий toolbarObject или nil, если к консоли не прикреплена никакая панель инструментов.
Примечания
  • Этот метод — это удобная оболочка для функции hs.webview.toolbar.attachToolbar.

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

Источник extensions/console/console.lua строка 136

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

Spec-Zone.ru

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