Spec-Zone.ru › Hammerspoon

hs.drawing

УСТАРЕВШАЯ. Примитивы для рисования на экране различными способами.

hs.drawing теперь устарел и будет удалён в будущей версии. Его функциональность теперь реализована в hs.canvas, и вам следует перенести свой код на его непосредственное использование. Документация API для hs.drawing остаётся здесь для удобства.

Подмодули

  • hs.drawing.color

Обзор API

  • Константы - Полезные значения, которые нельзя изменить
    • windowBehaviors
    • windowLevels
  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • defaultTextStyle
    • disableScreenUpdates
    • enableScreenUpdates
    • getTextDrawingSize
  • Конструкторы - API-вызовы, возвращающие объект, обычно тот, который предлагает API-методы
    • appImage
    • arc
    • circle
    • ellipticalArc
    • image
    • line
    • rectangle
    • text
  • Методы - API-вызовы, которые могут быть выполнены только на объекте, возвращённом конструктором
    • alpha
    • behavior
    • behaviorAsLabels
    • bringToFront
    • clickCallbackActivating
    • clippingRectangle
    • delete
    • frame
    • getStyledText
    • hide
    • imageAlignment
    • imageAnimates
    • imageFrame
    • imageScaling
    • orderAbove
    • orderBelow
    • rotateImage
    • sendToBack
    • setAlpha
    • setArcAngles
    • setBehavior
    • setBehaviorByLabels
    • setClickCallback
    • setFill
    • setFillColor
    • setFillGradient
    • setFrame
    • setImage
    • setImageASCII
    • setImageFromPath
    • setLevel
    • setRoundedRectRadii
    • setSize
    • setStroke
    • setStrokeColor
    • setStrokeWidth
    • setStyledText
    • setText
    • setTextColor
    • setTextFont
    • setTextSize
    • setTextStyle
    • setTopLeft
    • show

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

Раздел "Константы"

windowBehaviors
Подпись hs.drawing.windowBehaviors[]
Тип Константа
Описание

Массив меток поведения окна для определения того, как объект hs.drawing обрабатывается в Пространствах и Экспонировании

Примечания
  • Эта таблица имеет метаметод __tostring(), который позволяет перечислить её содержимое в консоли Hammerspoon, набрав hs.drawing.windowBehaviors.
Источник extensions/drawing/drawing.lua строка 690
windowLevels
Подпись hs.drawing.windowLevels
Тип Константа
Описание

Таблица предопределённых уровней окон, используемых с hs.drawing:setLevel(...)

Примечания
  • Эта таблица имеет метаметод __tostring(), который позволяет перечислить её содержимое в консоли Hammerspoon, набрав hs.drawing.windowLevels.

  • Эти имена ключей отображаются в константы, используемые в CoreGraphics для задания уровней окон и могут фактически не использоваться для того, что подсказывает их название. Например, тесты показывают, что активный экран сберегателя фактически работает на уровне 2002, а не на 1000, который соответствует уровню окна kCGScreenSaverWindowLevelKey.

  • Каждый уровень рисования сортируется отдельно, и hs.drawing:orderAbove(...) и hs.drawing:orderBelow(...)` организуют окна только в пределах одного уровня.

  • Если вы используете скрытие Папки (или в 10.11, скрытие Меню), обратите внимание, что при всплывании Папки (или Главного меню) это делается с неявным orderAbove, который расположит её над любыми элементами, которые вы также можете нарисовать на уровне Папки (или Главного меню).

  • Объект рисования с функцией hs.drawing:setClickCallback может надёжно получать события нажатия мыши только тогда, когда его уровень окна находится на уровне hs.drawing.windowLevels.desktopIcon + 1 или выше.

Источник extensions/drawing/drawing.lua строка 707

Раздел "Функции"

defaultTextStyle
Подпись hs.drawing.defaultTextStyle() -> hs.styledtext attributes table
Тип Функция
Описание

Возвращает таблицу, содержащую шрифт, размер, цвет и paragraphStyle по умолчанию, используемые hs.drawing для объектов рисования текста.

Параметры
  • Нет
Возвращаемые значения
  • таблица, содержащая атрибуты стиля по умолчанию, которые hs.drawing использует для объектов рисования текста в формате таблицы атрибутов hs.styledtext.
Примечания
  • Этот метод возвращает шрифт, размер, цвет и paragraphStyle по умолчанию, используемые hs.drawing для объектов текста. Если вы измените значения по умолчанию для объекта рисования с помощью hs.drawing:setColor, hs.drawing:setTextFont или hs.drawing:setTextSize, эти изменения не будут отражены в этой функции.
Источник extensions/drawing/drawing.lua строка 774
disableScreenUpdates
Подпись hs.drawing.disableScreenUpdates() -> None
Тип Функция
Описание

Сообщает серверу окон OS X о приостановке обновления физических дисплеев на короткое время.

Параметры
  • Нет
Возвращаемые значения
  • Нет
Примечания
  • Этот метод может использоваться для того, чтобы несколько изменений, вносимых в дисплей пользователя, казались выполненными одновременно, отложив обновление экрана по обычному расписанию.
  • Этот метод всегда должен сопровождаться вызовом hs.drawing.enableScreenUpdates после завершения обновлений. Отсутствие этого приведет к записи в системные журналы.
  • Сервер окон позволит приостановить обновления не более чем на 1 секунду. Это предотвращает блокировку дисплея системы некорректным или зависшим процессом. Обновления будут возобновлены при встрече с hs.drawing.enableScreenUpdates или через 1 секунду, в зависимости от того, что произойдёт раньше.
  • Подлежащая OS функция для отключения обновлений экрана устарела.
Источник extensions/drawing/drawing.lua строка 85
enableScreenUpdates
Подпись hs.drawing.enableScreenUpdates() -> None
Тип Функция
Описание

Сообщает серверу окон OS X о возобновлении обновления физических дисплеев после предыдущей паузы.

Параметры
  • Нет
Возвращаемые значения
  • Нет
Примечания
  • В сочетании с hs.drawing.disableScreenUpdates, этот метод может использоваться для того, чтобы несколько изменений, вносимых в дисплей пользователя, казались выполненными одновременно, отложив обновление экрана по обычному расписанию.
  • Сервер окон позволит приостановить обновления не более чем на 1 секунду. Это предотвращает блокировку дисплея системы некорректным или зависшим процессом. Обновления будут возобновлены при встрече с этой функцией или через 1 секунду, в зависимости от того, что произойдёт раньше.
  • Подлежащая OS функция для включения обновлений экрана устарела.
Источник extensions/drawing/drawing.lua строка 101
getTextDrawingSize
Signature hs.drawing.getTextDrawingSize(styledTextObject or theText, [textStyle]) -> sizeTable | nil
Type Функция
Description

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

Parameters
  • styledTextObject - объект, созданный с помощью модуля hs.styledtext или его табличного представления (см. hs.styledtext).
  • textStyle - необязательная таблица, содержащая один или несколько из следующих ключей для установки параметров текста объекта отрисовки (если textStyle равен nil или отсутствует, используются значения по умолчанию hs.drawing):
Returns
  • sizeTable - таблица, содержащая высоту и ширину, необходимые для полного отображения объекта отрисовки текста, или nil, если произошла ошибка
Notes
  • Эта функция предполагает значения по умолчанию для любого ключа, который не указан в предоставленном textStyle.
  • Возвращаемый размер является приблизительным и может возвращать ширину, отличающуюся примерно на 4 точки. Используйте возвращаемый размер как минимальную начальную точку. Иногда использование режимов перевода строк "clip" или "truncateMiddle" или выравнивания "justified" может подойти, но для большей безопасности добавьте свой буфер, если в макете есть место.
  • Поддерживается многострочный текст (разделенный новой строкой или символом возврата каретки). Высота будет для нескольких строк, а возвращаемая ширина — для самой длинной строки.
  • Для использования с hs.drawing:setText и hs.drawing.setTextStyle поддерживается следующий упрощенный формат стиля.
  • theText - текст, который должен быть отображен.
  • textStyle - таблица, содержащая один или несколько из следующих ключей для настройки текста объекта отрисовки (если textStyle равен nil или отсутствует, используются значения по умолчанию hs.drawing):
    • font - имя шрифта для использования (по умолчанию — системный шрифт)
    • size - размер шрифта в пунктах (по умолчанию — 27.0)
    • color - игнорируется, но принимается для совместимости с hs.drawing:setTextStyle()
    • alignment - строка, указывающая выравнивание текста в рамках объекта отрисовки:
      • "left" — текст выровнен по левому краю.
      • "right" — текст выровнен по правому краю.
      • "center" — текст выровнен по центру.
      • "justified" — текст выровнен по ширине
      • "natural" — (по умолчанию) естественное выравнивание шрифта текста
    • lineBreak - строка, указывающая, как обрезать текст, который выходит за рамки объекта отрисовки:
      • "wordWrap" — (по умолчанию) обрезка по словам, если слово само по себе не помещается в одну строку
      • "charWrap" — обрезка перед первой буквой, которая не помещается
      • "clip" — не отображать за пределами рамки объекта отрисовки
      • "truncateHead" — строка отображается так, что конец помещается в рамку, а пропущенный текст в начале строки обозначается многоточием
      • "truncateTail" — строка отображается так, что начало помещается в рамку, а пропущенный текст в конце строки обозначается многоточием
      • "truncateMiddle" — строка отображается так, что начало и конец помещаются в рамку, а пропущенный текст посередине обозначается многоточием
Source extensions/drawing/drawing.lua строка 787

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

appImage
Signature hs.drawing.appImage(sizeRect, bundleID) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект изображения с иконкой заданного приложения

Parameters
  • sizeRect - rect-таблица, содержащая положение/размер изображения. Если значения размера равны -1, изображение будет отображено в родном размере иконки
  • bundleID - строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 38
arc
Signature hs.drawing.arc(centerPoint, radius, startAngle, endAngle) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект дуги

Parameters
  • centerPoint - point-таблица, содержащая центр окружности, используемой для определения дуги
  • radius - радиус окружности, используемой для определения дуги
  • startAngle - начальный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
  • endAngle - конечный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Notes
  • Этот конструктор на самом деле является обёрткой для конструктора hs.drawing.ellipticalArc.
Source extensions/drawing/drawing.lua строка 69
circle
Signature hs.drawing.circle(sizeRect) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект окружности

Parameters
  • sizeRect - rect-таблица, содержащая положение/размер окружности
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 116
ellipticalArc
Signature hs.drawing.ellipticalArc(sizeRect, startAngle, endAngle) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект эллиптической дуги

Parameters
  • sizeRect - rect-таблица, содержащая положение и размер эллипса, используемого для определения дуги
  • startAngle - начальный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
  • endAngle - конечный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 126
image
Signature hs.drawing.image(sizeRect, imageData) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект изображения

Parameters
  • sizeRect - rect-таблица, содержащая положение/размер изображения
  • imageData - может быть:
    • Объектом hs.image
    • Строкой, содержащей путь к файлу изображения
    • Строкой, начинающейся с ASCII:, которая указывает, что остальная часть строки интерпретируется как специальная форма ASCII-диаграммы, которая будет преобразована в изображение. См. примечания ниже для получения информации о специальном формате ASCII-диаграммы.
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
  • Пути, относительные к текущему каталогу Hammerspoon (обычно ~/.hammerspoon/), будут работать, но пути, относительные к символу домашнего каталога UNIX, ~, не будут
  • Поддерживаются анимированные GIF-файлы. Они не очень дружелюбны к вашему процессору, но работают
Notes
  • Чтобы использовать поддержку изображений ASCII-диаграмм, см. http://cocoamine.net/blog/2015/03/20/replacing-photoshop-with-nsstring/ и убедитесь, что ваша ASCII-диаграмма начинается со специальной строки ASCII:
Source extensions/drawing/drawing.lua строка 170
line
Signature hs.drawing.line(originPoint, endPoint) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект линии

Parameters
  • originPoint - point-таблица, содержащая координаты начальной точки линии
  • endPoint - point-таблица, содержащая координаты конечной точки линии
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 148
rectangle
Signature hs.drawing.rectangle(sizeRect) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект прямоугольника

Parameters
  • sizeRect - rect-таблица, содержащая положение/размер прямоугольника
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 138
text
Signature hs.drawing.text(sizeRect, message) -> drawingObject or nil
Type Конструктор
Description

Создаёт новый объект текста

Parameters
  • sizeRect - rect-таблица, содержащая положение/размер текста
  • message - строка, содержащая отображаемый текст. Также может быть любого типа, поддерживаемого hs.styledtext. См. hs.styledtext для получения дополнительной информации.
Returns
  • Объект hs.drawing, или nil, если произошла ошибка
Source extensions/drawing/drawing.lua строка 159

Методы

alpha
Signature hs.drawing:alpha() -> number
Type Method
Description

Получить уровень прозрачности (alpha) окна, содержащего объект hs.drawing.

Parameters
  • None
Returns
  • Текущий уровень прозрачности объекта hs.drawing
Source extensions/drawing/drawing.lua line 650
behavior
Signature hs.drawing:behavior() -> number
Type Method
Description

Возвращает текущее поведение объекта hs.drawing относительно Пространств и Exposé.

Parameters
  • None
Returns
  • Числовое представление текущего поведения объекта hs.drawing
Source extensions/drawing/drawing.lua line 754
behaviorAsLabels
Signature hs.drawing:behaviorAsLabels() -> table
Type Method
Description

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

Parameters
  • None
Returns
  • Возвращает таблицу меток текущего поведения объекта относительно Пространств и Exposé.
Source extensions/drawing/drawing.lua line 59
bringToFront
Signature hs.drawing:bringToFront([aboveEverything]) -> drawingObject
Type Method
Description

Выводит объект отрисовки поверх обычных окон

Parameters
  • aboveEverything - Необязательное логическое значение, определяющее, насколько далеко объект должен быть выведен вперёд. true для размещения объекта поверх всех окон (включая папку и строку меню), false для размещения объекта поверх обычных окон, но ниже папки и строки меню. По умолчанию - false.
Returns
  • Объект отрисовки
Notes
  • Начиная с macOS Sierra и новее, если вы хотите, чтобы объект hs.drawing отображался поверх окон в полноэкранном режиме, вы должны сначала скрыть значок Hammerspoon Dock с помощью: hs.dockicon.hide()
Source extensions/drawing/drawing.lua line 627
clickCallbackActivating
Signature hs.drawing:clickCallbackActivating([false]) -> drawingObject or current value
Type Method
Description

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

Parameters
  • flag - необязательное логическое значение, указывающее, нужно ли активировать Hammerspoon и выводить его окна вперёд при нажатии на объект отрисовки с определённой функцией обратного вызова. По умолчанию - true.
Returns
  • Если задано значение, возвращается объект отрисовки; если аргумент не указан, возвращается текущее значение.
Notes
  • Изменение этого значения на false изменяет значение AXsubrole объекта отрисовки и может повлиять на результаты фильтров, определённых для hs.window.filter, в зависимости от способа их определения.
Source extensions/drawing/drawing.lua line 567
clippingRectangle
Signature hs.drawing:clippingRectangle([rect]) -> drawingObject or current value
Type Method
Description

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

Parameters
  • rect - необязательный прямоугольник, определяющий видимую область экрана, где содержимое отрисовки отображается. Если указан явный nil, прямоугольник обрезки не устанавливается. По умолчанию - nil
Returns
  • если указан аргумент, возвращается объект отрисовки; в противном случае возвращается текущее значение.
Notes
  • Этот метод может использоваться для указания области экрана, где должна отображаться отрисовка. Если какая-либо часть отрисовки выходит за пределы этого прямоугольника, изображение обрезается таким образом, что видна только часть внутри этого прямоугольника.

  • Прямоугольник, определяемый этим методом, независим от фактической рамки отрисовки. Если вы перемещаете отрисовку с помощью hs.drawing:setFrame или hs.drawing:setTopLeft, этот прямоугольник сохраняет своё текущее значение.

  • Этот метод в настоящее время не работает для объектов изображений.

Source extensions/drawing/drawing.lua line 284
delete
Signature hs.drawing:delete()
Type Method
Description

Уничтожает объект отрисовки

Parameters
  • None
Returns
  • None
Notes
  • Этот метод немедленно уничтожает объект отрисовки. Если вы хотите, чтобы он исчезал плавно, используйте сначала :hide() с подходящим временем, а затем hs.timer.doAfter() для планирования вызова :delete()
Source extensions/drawing/drawing.lua line 614
frame
Signature hs.drawing:frame() -> hs.geometry object
Type Method
Description

Получает рамку drawingObject в абсолютных координатах

Parameters
  • None
Returns
  • Объект hs.geometry, содержащий рамку объекта отрисовки
Source extensions/drawing/drawing.lua line 310
getStyledText
Signature hs.drawing:getStyledText() -> hs.styledtext object
Type Method
Description

Получает текст объекта отрисовки в виде объекта hs.styledtext

Parameters
  • None
Returns
  • объект hs.styledtext
Notes
  • Этот метод следует использовать только для текстовых объектов отрисовки
Source extensions/drawing/drawing.lua line 216
hide
Signature hs.drawing:hide([fadeOutTime]) -> drawingObject
Type Method
Description

Скрывает объект отрисовки

Parameters
  • fadeOut - Необязательное число секунд, в течение которых объект отрисовки должен исчезать плавно. По умолчанию - ноль
Returns
  • Объект отрисовки
Source extensions/drawing/drawing.lua line 604
imageAlignment
Signature hs.drawing:imageAlignment([type]) -> drawingObject or current value
Type Method
Description

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

Parameters
  • type - необязательное строковое значение, которое должно соответствовать одному из следующих (по умолчанию - center):
    • topLeft - верхний левый угол изображения совпадает с верхним левым углом рамки объекта отрисовки
    • top - верх изображения совпадает с верхом рамки объекта отрисовки и выравнивается по горизонтали
    • topRight - верхний правый угол изображения совпадает с верхним правым углом рамки объекта отрисовки
    • left - левая сторона изображения совпадает с левой стороной рамки объекта отрисовки и выравнивается по вертикали
    • center - изображение центрируется по горизонтали и вертикали внутри рамки объекта отрисовки
    • right - правая сторона изображения совпадает с правой стороной рамки объекта отрисовки и выравнивается по вертикали
    • bottomLeft - нижний левый угол изображения совпадает с нижним левым углом рамки объекта отрисовки
    • bottom - низ изображения совпадает с низом рамки объекта отрисовки и выравнивается по горизонтали
    • bottomRight - нижний правый угол изображения совпадает с нижним правым углом рамки объекта отрисовки
Returns
  • Если задано значение, возвращается объект отрисовки; если аргумент не указан, возвращается текущее значение.
Source extensions/drawing/drawing.lua line 548
END_OF_DOCUMENT_MARKER
imageAnimates
Подпись hs.drawing:imageAnimates([flag]) -> drawingObject or current value
Тип Метод
Описание

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

Параметры
  • flag - необязательный булевый флаг, указывающий, нужно ли анимированному изображению GIF циклически проходить через анимацию. По умолчанию значение true.
Возвращает
  • Если задано значение, возвращается объект рисования; если аргумент не задан, возвращается текущее значение.
Источник extensions/drawing/drawing.lua строка 520
imageFrame
Подпись hs.drawing:imageFrame([type]) -> drawingObject or current value
Тип Метод
Описание

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

Параметры
  • type - необязательное строковое значение, которое должно соответствовать одному из следующих (по умолчанию - none):
    • none - вокруг рамки frameRect объекта drawingObject нет рамки
    • photo - тонкая чёрная рамка с белым фоном и тенью.
    • bezel - серая вогнутая рамка без фона, которая делает изображение похожим на вдавленное.
    • groove - тонкий желобок с серым фоном, который выглядит гравированным вокруг изображения.
    • button - выпуклая рамка с серым фоном, которая выделяет изображение в рельефе, как кнопку.
Возвращает
  • Если задано значение, возвращается объект рисования; если аргумент не задан, возвращается текущее значение.
Примечания
  • Apple считает стили фото, желобок и кнопку "стилистически устаревшими" и, если нужна рамка, рекомендует использовать стиль рамки bezel или рисовать свою, чтобы более точно соответствовать внешнему виду ОС.
Источник extensions/drawing/drawing.lua строка 530
imageScaling
Подпись hs.drawing:imageScaling([type]) -> drawingObject or current value
Тип Метод
Описание

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

Параметры
  • type - необязательное строковое значение, которое должно соответствовать одному из следующих (по умолчанию - scaleProportionally):
    • shrinkToFit - уменьшить изображение, сохранив соотношение сторон, для вписывания в рамку рисования только если изображение больше, чем рамка рисования.
    • scaleToFit - уменьшить или увеличить изображение, чтобы полностью заполнить рамку рисования. Это не сохраняет соотношение сторон.
    • none - не выполнять масштабирование или изменение размера изображения.
    • scaleProportionally - уменьшить или увеличить изображение, чтобы полностью заполнить рамку рисования, сохранив соотношение сторон.
Возвращает
  • Если задано значение, возвращается объект рисования; если аргумент не задан, возвращается текущее значение.
Источник extensions/drawing/drawing.lua строка 506
orderAbove
Подпись hs.drawing:orderAbove([object2]) -> object
Тип Метод
Описание

Перемещает объект рисования над объектом рисования2, или все объекты рисования на том же уровне презентации, если object2 не задан.

Параметры
  • Необязательный объект рисования, над которым нужно поместить объект рисования.
Возвращает
  • Объект hs.drawing
Источник extensions/drawing/drawing.lua строка 670
orderBelow
Подпись hs.drawing:orderBelow([object2]) -> object1
Тип Метод
Описание

Перемещает объект рисования под объектом рисования2, или все объекты рисования на том же уровне презентации, если object2 не задан.

Параметры
  • Необязательный объект рисования, под которым нужно поместить объект рисования.
Возвращает
  • Объект hs.drawing
Источник extensions/drawing/drawing.lua строка 680
rotateImage
Подпись hs.drawing:rotateImage(angle) -> drawingObject
Тип Метод
Описание

Поворачивает изображение по часовой стрелке вокруг его центра

Параметры
  • angle - угол в градусах поворота изображения по часовой стрелке вокруг его центра.
Возвращает
  • Объект рисования
Примечания
  • Этот метод работает путем поворота представления изображения внутри его окна рисования. Это означает, что изображение, которое полностью заполняет область просмотра, скорее всего, будет обрезано в некоторых местах. Лучшие результаты достигаются с изображениями, у которых есть свободное пространство вокруг краев, или если hs.drawing.imageScaling установлено в "none".
Источник extensions/drawing/drawing.lua строка 493
sendToBack
Подпись hs.drawing:sendToBack() -> drawingObject
Тип Метод
Описание

Помещает объект рисования за обычные окна, между обоями рабочего стола и значками рабочего стола

Параметры
  • Нет
Возвращает
  • Объект рисования
Источник extensions/drawing/drawing.lua строка 640
setAlpha
Подпись hs.drawing:setAlpha(level) -> object
Тип Метод
Описание

Устанавливает уровень альфа-канала окна, содержащего объект hs.drawing.

Параметры
  • level - уровень альфа-канала (0.0 - 1.0), который нужно установить для объекта
Возвращает
  • Объект hs.drawing
Источник extensions/drawing/drawing.lua строка 660
setArcAngles
Подпись hs.drawing:setArcAngles(startAngle, endAngle) -> drawingObject
Тип Метод
Описание

Изменяет начальный и конечный углы для объекта дуги рисования

Параметры
  • startAngle - начальный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
  • endAngle - конечный угол дуги, измеряемый в градусах по часовой стрелке от оси y.
Возвращает
  • Объект рисования
Примечания
  • Этот метод следует использовать только для объектов дуги рисования
Источник extensions/drawing/drawing.lua строка 377
setBehavior
Подпись hs.drawing:setBehavior(behavior) -> object
Тип Метод
Описание

Устанавливает поведение окна, представленное заданным числом для окна, содержащего объект hs.drawing.

Параметры
  • behavior - числовое представление поведения, которое нужно установить для окна объекта
Возвращает
  • Объект hs.drawing
Источник extensions/drawing/drawing.lua строка 764
setBehaviorByLabels
Подпись hs.drawing:setBehaviorByLabels(table) -> object
Тип Метод
Описание

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

Параметры
  • таблица строковых или числовых меток. Признанные значения можно найти в hs.drawing.windowBehaviors.
Возвращает
  • Объект hs.drawing
Источник extensions/drawing/drawing.lua строка 49
setClickCallback
Подпись hs.drawing:setClickCallback(mouseUpFn, mouseDownFn) -> drawingObject
Тип Метод
Описание

Устанавливает обратный вызов для событий щелчков мыши mouseUp и mouseDown

Параметры
  • mouseUpFn - функция, которая может быть nil, и будет вызываться при нажатии на объект рисования и отпускании кнопки мыши. Если этот аргумент равен nil, любой существующий обратный вызов удаляется.
  • mouseDownFn - функция, которая может быть nil, и будет вызываться при нажатии на объект рисования и первом нажатии кнопки мыши. Если этот аргумент равен nil, любой существующий обратный вызов удаляется.
Возвращает
  • Объект рисования
Примечания
  • Не делается различий между левой, правой или другими кнопками мыши — они все вызывают одну и ту же функцию вверх или вниз. Если вам нужно определить, какая именно кнопка была нажата, используйте hs.eventtap.checkMouseButtons() в вашем обратном вызове, чтобы проверить это.
Источник extensions/drawing/drawing.lua строка 580
setFill
Signature hs.drawing:setFill(doFill) -> drawingObject
Type Method
Description

Устанавливает, заливать ли объект рисования

Parameters
  • doFill - Булево значение, true для заливки объекта рисования, false — для отключения заливки
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объектов рисования типа линия, прямоугольник, окружность или дуга
Source extensions/drawing/drawing.lua строка 444
setFillColor
Signature hs.drawing:setFillColor(color) -> drawingObject
Type Method
Description

Устанавливает цвет заливки объекта рисования

Parameters
  • color - таблица цветов, как описано в hs.drawing.color
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объектов рисования типа прямоугольник, окружность или дуга
  • Вызов этого метода удалит любые ранее установленные градиентные цвета заливки с помощью hs.drawing:setFillGradient()
Source extensions/drawing/drawing.lua строка 363
setFillGradient
Signature hs.drawing:setFillGradient(startColor, endColor, angle) -> drawingObject
Type Method
Description

Устанавливает градиент заливки объекта рисования

Parameters
  • startColor - Таблица, содержащая значения компонентов цвета от 0,0 до 1,0 для каждого из ключей:
    • red (по умолчанию 0,0)
    • green (по умолчанию 0,0)
    • blue (по умолчанию 0,0)
    • alpha (по умолчанию 1,0)
  • endColor - Таблица, содержащая значения компонентов цвета от 0,0 до 1,0 для каждого из ключей:
    • red (по умолчанию 0,0)
    • green (по умолчанию 0,0)
    • blue (по умолчанию 0,0)
    • alpha (по умолчанию 1,0)
  • angle - Число, представляющее угол градиента в градусах, против часовой стрелки от левой стороны объекта рисования
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объектов рисования типа прямоугольник, окружность или дуга
  • Вызов этого метода удалит любой ранее установленный цвет заливки с помощью hs.drawing:setFillColor()
Source extensions/drawing/drawing.lua строка 391
setFrame
Signature hs.drawing:setFrame(rect) -> drawingObject
Type Method
Description

Устанавливает рамку drawingObject в абсолютных координатах

Parameters
  • rect - таблица rect, содержащая координаты и размеры, которые следует применить к drawingObject
Returns
  • Объект рисования
Source extensions/drawing/drawing.lua строка 300
setImage
Signature hs.drawing:setImage(image) -> drawingObject
Type Method
Description

Устанавливает изображение объекта рисования

Parameters
  • image - Объект hs.image
Returns
  • Объект рисования
Source extensions/drawing/drawing.lua строка 483
setImageASCII
Signature hs.drawing:setImageASCII(ascii) -> drawingObject
Type Method
Description

Устанавливает изображение объекта рисования из ASCII-представления

Parameters
  • ascii - Строка, содержащая ASCII-изображение для отрисовки
Returns
  • Объект рисования
Notes
  • Для использования поддержки ASCII-диаграммных изображений см. http://cocoamine.net/blog/2015/03/20/replacing-photoshop-with-nsstring
Source extensions/drawing/drawing.lua строка 25
setImageFromPath
Signature hs.drawing:setImageFromPath(imagePath) -> drawingObject
Type Method
Description

Устанавливает путь к изображению объекта рисования

Parameters
  • imagePath - Строка, содержащая путь к файлу изображения
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объекта рисования типа изображение
  • Пути, относительные к PWD Hammerspoon (обычно ~/.hammerspoon/), будут работать, но пути, относительные к символу домашнего каталога UNIX, ~, не будут
  • Поддерживаются анимированные GIF-файлы. Они не очень дружелюбны к вашему процессору, но работают
Source extensions/drawing/drawing.lua строка 10
setLevel
Signature hs.drawing:setLevel(theLevel) -> drawingObject
Type Method
Description

Устанавливает уровень окна более точно, чем sendToBack и bringToFront.

Parameters
  • theLevel - уровень, указанный как число или строка, где должен быть нарисован этот объект. Если это строка, она должна соответствовать одному из ключей в hs.drawing.windowLevels.
Returns
  • объект рисования
Notes
  • см. заметки для hs.drawing.windowLevels
  • Эти уровни могут не позволить явно разместить объекты рисования вокруг окон macOS с полным экраном
Source extensions/drawing/drawing.lua строка 740
setRoundedRectRadii
Signature hs.drawing:setRoundedRectRadii(xradius, yradius) -> drawingObject
Type Method
Description

Устанавливает радиусы углов прямоугольного объекта рисования

Parameters
  • xradius - Число, содержащее радиус каждого угла по оси x
  • yradius - Число, содержащее радиус каждого угла по оси y
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для прямоугольных объектов рисования
  • Если значение любого радиуса больше половины ширины/высоты (соответственно) прямоугольника, значение будет ограничено половиной ширины/высоты
  • Если значения обоих радиусов равны 0, прямоугольник будет нарисован без закруглённых углов
Source extensions/drawing/drawing.lua строка 428
setSize
Signature hs.drawing:setSize(size) -> drawingObject
Type Method
Description

Изменяет размер объекта рисования

Parameters
  • size - таблица size, содержащая ширину и высоту, до которых должен быть изменен размер объекта рисования
Returns
  • Объект рисования
Notes
  • Если это вызывается на объекте hs.drawing.text, будет изменён только размер его окна. Если вы также хотите изменить размер шрифта, используйте :setTextSize()
Source extensions/drawing/drawing.lua строка 271
setStroke
Signature hs.drawing:setStroke(doStroke) -> drawingObject
Type Method
Description

Устанавливает, обводить ли объект рисования

Parameters
  • doStroke - Булево значение, true для обводки объекта рисования, false — для отключения обводки
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объектов рисования типа линия, прямоугольник, окружность или дуга
Source extensions/drawing/drawing.lua строка 457
setStrokeColor
Signature hs.drawing:setStrokeColor(color) -> drawingObject
Type Method
Description

Устанавливает цвет обводки объекта рисования

Parameters
  • color - таблица цветов, как описано в hs.drawing.color
Returns
  • Объект рисования
Notes
  • Этот метод следует использовать только для объектов рисования типа линия, прямоугольник, окружность или дуга
Source extensions/drawing/drawing.lua строка 415
setStrokeWidth
Подпись hs.drawing:setStrokeWidth(width) -> drawingObject
Тип Метод
Описание

Устанавливает ширину обводки объекта рисования

Параметры
  • width - Числовое значение ширины в пунктах для обводки объекта рисования
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для объектов рисования типа линия, прямоугольник, окружность или дуга
Источник extensions/drawing/drawing.lua строка 470
setStyledText
Подпись hs.drawing:setStyledText(message) -> drawingObject
Тип Метод
Описание

Устанавливает текст объекта рисования из объекта hs.styledtext

Параметры
  • message - Любой из типов, поддерживаемых объектом hs.styledtext. См. hs.styledtext для получения дополнительных сведений.
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для текстовых объектов рисования
Источник extensions/drawing/drawing.lua строка 203
setText
Подпись hs.drawing:setText(message) -> drawingObject
Тип Метод
Описание

Устанавливает текст объекта рисования

Параметры
  • message - Строка, содержащая текст для отображения
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для текстовых объектов рисования
  • Если текст объекта рисования пустой (т.е. ""), изменения стиля могут быть потеряны. Используйте маркер, например пробел (" "), или скройте объект, если изменения стиля необходимо сохранить, но текст должен исчезнуть на время.
Источник extensions/drawing/drawing.lua строка 189
setTextColor
Подпись hs.drawing:setTextColor(color) -> drawingObject
Тип Метод
Описание

Устанавливает цвет текста по умолчанию для объекта рисования

Параметры
  • color - таблица цветов, как описано в hs.drawing.color
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует вызывать только для текстовых объектов рисования
  • Этот метод изменяет цвет шрифта для частей объекта текста hs.drawing, у которых в списке атрибутов не установлен конкретный шрифт (см. hs.styledtext для получения более подробной информации).
Источник extensions/drawing/drawing.lua строка 348
setTextFont
Подпись hs.drawing:setTextFont(fontname) -> drawingObject
Тип Метод
Описание

Устанавливает шрифт по умолчанию для объекта рисования

Параметры
  • fontname - Строка, содержащая имя шрифта для использования
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для текстовых объектов рисования
  • Этот метод изменяет шрифт для частей объекта текста hs.drawing, у которых в списке атрибутов не установлен конкретный шрифт (см. hs.styledtext для получения более подробной информации).
Источник extensions/drawing/drawing.lua строка 320
setTextSize
Подпись hs.drawing:setTextSize(size) -> drawingObject
Тип Метод
Описание

Устанавливает размер шрифта по умолчанию для объекта рисования

Параметры
  • size - Числовое значение размера шрифта для использования
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для текстовых объектов рисования
  • Этот метод изменяет размер шрифта для частей объекта текста hs.drawing, у которых в списке атрибутов не установлен конкретный шрифт (см. hs.styledtext для получения более подробной информации).
Источник extensions/drawing/drawing.lua строка 334
setTextStyle
Подпись hs.drawing:setTextStyle([textStyle]) -> drawingObject
Тип Метод
Описание

Устанавливает некоторые простые параметры стиля для всего текста объекта рисования. Для более точного управления стилем, включая наличие нескольких стилей в одном текстовом объекте, используйте hs.styledtext и hs.drawing:setStyledText.

Параметры
  • textStyle - необязательная таблица, содержащая один или несколько из следующих ключей для установки стиля текста объекта рисования (если таблица равна nil или опущена, стиль сбрасывается до значений по умолчанию hs.drawing):
    • font - имя шрифта для использования (по умолчанию - системный шрифт)
    • size - размер шрифта в пунктах для использования (по умолчанию - 27.0)
    • color - таблица цветов, как описано в hs.drawing.color
    • alignment - строка, обозначающая выравнивание текста в пределах рамки объекта рисования: * "left" - текст выравнивается по левому краю. * "right" - текст выравнивается по правому краю. * "center" - текст выравнивается по центру. * "justified" - текст выравнивается по ширине. * "natural" - (по умолчанию) естественное выравнивание текста.
    • lineBreak - строка, обозначающая способ обрезки текста, выходящего за рамки объекта рисования: * "wordWrap" - (по умолчанию) обрезка по словам, если слово не помещается на одной строке. * "charWrap" - обрезка перед первым символом, не помещающимся на строке. * "clip" - не отображать текст за пределами рамки объекта рисования. * "truncateHead" - строка отображается так, что конец помещается в рамку, а пропущенный текст в начале строки обозначается многоточием. * "truncateTail" - строка отображается так, что начало помещается в рамку, а пропущенный текст в конце строки обозначается многоточием. * "truncateMiddle" - строка отображается так, что начало и конец помещаются в рамку, а пропущенный текст посередине обозначается многоточием.
Возвращаемое значение
  • Объект рисования
Примечания
  • Этот метод следует использовать только для текстовых объектов рисования
  • Если текст объекта рисования сейчас пустой (т.е. ""), изменения стиля могут быть потеряны. Используйте маркер, например пробел (" "), или скройте объект, если изменения стиля необходимо сохранить, но текст должен исчезнуть на время.
  • Изменяются только указанные ключи. Чтобы сбросить объект до всех значений по умолчанию, вызовите этот метод с явным nil в качестве единственного параметра (например, hs.drawing:setTextStyle(nil)
  • Шрифт, размер шрифта и цвет шрифта также можно установить отдельными методами; этот метод предоставлен для того, чтобы компоненты стиля могли храниться и применяться совместно, а также использоваться hs.drawing.getTextDrawingSize() для определения правильного размера прямоугольника для текстового объекта рисования.
Источник extensions/drawing/drawing.lua строка 229
setTopLeft
Подпись hs.drawing:setTopLeft(point) -> drawingObject
Тип Метод
Описание

Перемещает объект рисования в заданную точку

Параметры
  • point - таблица точек, содержащая абсолютные координаты, в которые должен быть перемещен объект рисования
Возвращаемое значение
  • Объект рисования
Источник extensions/drawing/drawing.lua строка 261
show
Подпись hs.drawing:show([fadeInTime]) -> drawingObject
Тип Метод
Описание

Отображает объект рисования

Параметры
  • fadeInTime - Необязательное число секунд, в течение которых объект рисования должен плавно появляться. По умолчанию равно нулю
Возвращаемое значение
  • Объект рисования
Источник extensions/drawing/drawing.lua строка 594

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

Spec-Zone.ru

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