hs.window
Просмотр/манипулирование окнами
Примечания:
- См.
hs.screenиhs.geometryдля получения дополнительной информации о том, как Hammerspoon использует кадры окна/экрана и координаты
Подмодули
Обзор API
- Переменные - Настраиваемые значения
- Функции - API-вызовы, предлагаемые непосредственно расширением
- allWindows
- desktop
- invisibleWindows
- list
- minimizedWindows
- orderedWindows
- setShadows
- snapshotForID
- timeout
- visibleWindows
- Конструкторы - API-вызовы, возвращающие объект, обычно предоставляющий API-методы
- Методы - API-вызовы, которые могут быть выполнены только с объектом, возвращенным конструктором
- application
- becomeMain
- centerOnScreen
- close
- focus
- focusTab
- focusWindowEast
- focusWindowNorth
- focusWindowSouth
- focusWindowWest
- frame
- id
- isFullScreen
- isMaximizable
- isMinimized
- isStandard
- isVisible
- maximize
- minimize
- move
- moveOneScreenEast
- moveOneScreenNorth
- moveOneScreenSouth
- moveOneScreenWest
- moveToScreen
- moveToUnit
- otherWindowsAllScreens
- otherWindowsSameScreen
- raise
- role
- screen
- sendToBack
- setFrame
- setFrameInScreenBounds
- setFrameWithWorkarounds
- setFullScreen
- setSize
- setTopLeft
- size
- snapshot
- subrole
- tabCount
- title
- toggleFullScreen
- toggleZoom
- topLeft
- unminimize
- windowsToEast
- windowsToNorth
- windowsToSouth
- windowsToWest
- zoomButtonRect
Документация API
Раздел переменных
animationDuration
| Подпись | hs.window.animationDuration (number) |
|---|---|
| Тип | Переменная |
| Описание |
Длительность анимации по умолчанию в секундах. Начальное значение 0,2; установите в 0, чтобы отключить анимации. |
| Источник | extensions/window/window.lua строка 21 |
setFrameCorrectness
| Подпись | hs.window.setFrameCorrectness |
|---|---|
| Тип | Переменная |
| Описание |
Использование |
| Источник | extensions/window/window.lua строка 392 |
Раздел функций
allWindows
| Подпись | hs.window.allWindows() -> list of hs.window objects |
|---|---|
| Тип | Функция |
| Описание |
Возвращает все окна |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 54 |
desktop
| Подпись | hs.window.desktop() -> hs.window object |
|---|---|
| Тип | Функция |
| Описание |
Возвращает "окно" рабочего стола |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 33 |
invisibleWindows
| Подпись | hs.window.invisibleWindows() -> list of hs.window objects |
|---|---|
| Тип | Функция |
| Описание |
Получение всех невидимых окон |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 139 |
orderedWindows
| Подпись | hs.window.orderedWindows() -> list of hs.window objects |
|---|---|
| Тип | Функция |
| Описание |
Возвращает все видимые окна, от переднего к заднему |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 173 |
setShadows
| Подпись | hs.window.setShadows(shadows) |
|---|---|
| Тип | Функция |
| Описание |
Включает/Отключает тени окон |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 563 |
snapshotForID
| Подпись | hs.window.snapshotForID(ID [, keepTransparency]) -> hs.image-object |
|---|---|
| Тип | Функция |
| Описание |
Возвращает снимок окна, указанного по ID, как |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 589 |
timeout
| Подпись | hs.window.timeout(value) -> boolean |
|---|---|
| Тип | Функция |
| Описание |
Устанавливает значение таймаута, используемое в API доступности. |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 65 |
visibleWindows
| Подпись | hs.window.visibleWindows() -> list of hs.window objects |
|---|---|
| Тип | Функция |
| Описание |
Получает все видимые окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 122 |
Конструкторы
find
| Подпись | hs.window.find(hint) -> hs.window object(s) |
|---|---|
| Тип | Конструктор |
| Описание |
Ищет окна |
| Параметры |
|
| Возвращает |
|
| Примечания |
Использование: |
| Источник | extensions/window/window.lua строка 208 |
focusedWindow
| Подпись | hs.window.focusedWindow() -> window |
|---|---|
| Тип | Конструктор |
| Описание |
Возвращает окно, имеющее фокус клавиатуры/мыши |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 94 |
frontmostWindow
| Подпись | hs.window.frontmostWindow() -> hs.window object |
|---|---|
| Тип | Конструктор |
| Описание |
Возвращает окно с фокусом или, если ни одно окно не имеет фокуса, возвращает самое переднее |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 748 |
get
| Подпись | hs.window.get(hint) -> hs.window object |
|---|---|
| Тип | Конструктор |
| Описание |
Получает конкретное окно |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 189 |
Методы
application
| Подпись | hs.window:application() -> app or nil |
|---|---|
| Тип | Метод |
| Описание |
Получает |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 482 |
becomeMain
| Подпись | hs.window:becomeMain() -> window |
|---|---|
| Тип | Метод |
| Описание |
Делает окно основным окном своего приложения |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 500 |
centerOnScreen
| Подпись | hs.window:centerOnScreen([screen][, ensureInScreenBounds][, duration]) --> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Центрирует окно на экране |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 864 |
close
| Подпись | hs.window:close() -> bool |
|---|---|
| Тип | Метод |
| Описание |
Закрывает окно |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 324 |
focus
| Подпись | hs.window:focus() -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Фокусирует окно |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 508 |
focusTab
| Signature | hs.window:focusTab(index) -> bool |
|---|---|
| Type | Method |
| Description |
Фокусирует вкладку в группе вкладок окна по индексу или последнюю вкладку, если индекс вне границ. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/libwindow.m строка 341 |
focusWindowEast
| Signature | hs.window:focusWindowEast([candidateWindows[, frontmost[, strict]]]) -> boolean |
|---|---|
| Type | Method |
| Description |
Фокусирует ближайшее возможное окно к востоку (то есть справа). |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/window.lua строка 783 |
focusWindowNorth
| Signature | hs.window:focusWindowNorth([candidateWindows[, frontmost[, strict]]]) -> boolean |
|---|---|
| Type | Method |
| Description |
Фокусирует ближайшее возможное окно к северу (то есть вверх). |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/window.lua строка 823 |
focusWindowSouth
| Signature | hs.window:focusWindowSouth([candidateWindows[, frontmost[, strict]]]) -> boolean |
|---|---|
| Type | Method |
| Description |
Фокусирует ближайшее возможное окно к югу (то есть вниз). |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/window.lua строка 843 |
focusWindowWest
| Signature | hs.window:focusWindowWest([candidateWindows[, frontmost[, strict]]]) -> boolean |
|---|---|
| Type | Method |
| Description |
Фокусирует ближайшее возможное окно к западу (то есть слева). |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/window.lua строка 803 |
frame
| Signature | hs.window:frame() -> hs.geometry rect |
|---|---|
| Type | Method |
| Description |
Получает рамку окна в абсолютных координатах. |
| Parameters |
|
| Returns |
|
| Source | extensions/window/window.lua строка 430 |
id
| Signature | hs.window:id() -> number or nil |
|---|---|
| Type | Method |
| Description |
Получает уникальный идентификатор окна. |
| Parameters |
|
| Returns |
|
| Source | extensions/window/libwindow.m строка 546 |
isFullScreen
| Signature | hs.window:isFullScreen() -> bool or nil |
|---|---|
| Type | Method |
| Description |
Получает состояние окна в полноэкранном режиме. |
| Parameters |
|
| Returns |
|
| Source | extensions/window/libwindow.m строка 400 |
isMaximizable
| Signature | hs.window:isMaximizable() -> bool or nil |
|---|---|
| Type | Method |
| Description |
Определяет, можно ли увеличить окно. |
| Parameters |
|
| Returns |
|
| Source | extensions/window/libwindow.m строка 296 |
isMinimized
| Signature | hs.window:isMinimized() -> bool |
|---|---|
| Type | Method |
| Description |
Получает состояние минимизированности окна. |
| Parameters |
|
| Returns |
|
| Source | extensions/window/libwindow.m строка 456 |
isStandard
| Signature | hs.window:isStandard() -> bool |
|---|---|
| Type | Method |
| Description |
Определяет, является ли окно стандартным окном. |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/libwindow.m строка 164 |
isVisible
| Signature | hs.window:isVisible() -> boolean |
|---|---|
| Type | Method |
| Description |
Определяет, является ли окно видимым (то есть не скрыто и не минимизировано). |
| Parameters |
|
| Returns |
|
| Notes |
|
| Source | extensions/window/window.lua строка 243 |
максимизировать
| Подпись | hs.window:maximize([duration]) -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Максимизирует окно |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 581 |
минимизировать
| Подпись | hs.window:minimize() -> window |
|---|---|
| Тип | Метод |
| Описание |
Минимизирует окно |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 417 |
переместить
| Подпись | hs.window:move(rect[, screen][, ensureInScreenBounds][, duration]) --> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Перемещает окно |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 930 |
переместитьНаОдинЭкранВосток
переместитьНаОдинЭкранСевер
переместитьНаОдинЭкранЮг
переместитьНаОдинЭкранЗапад
переместитьНаЭкран
переместитьНаЕдиницу
другиеОкнаВсеЭкраны
другиеОкнаТотЖеЭкран
поднять
роль
| Подпись | hs.window:role() -> string |
|---|---|
| Тип | Метод |
| Описание |
Получает роль окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 147 |
экран
| Подпись | hs.window:screen() -> hs.screen object |
|---|---|
| Тип | Метод |
| Описание |
Получает экран, на котором находится окно |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 618 |
отправитьНазад
| Подпись | hs.window:sendToBack() -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Отправляет окно назад |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 539 |
установитьКадр
| Подпись | hs.window:setFrame(rect[, duration]) -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Устанавливает кадр окна в абсолютных координатах |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 368 |
установитьКадрВГраницахЭкрана
| Подпись | hs.window:setFrameInScreenBounds([rect][, duration]) -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Устанавливает кадр окна в абсолютных координатах, возможно, скорректированный для обеспечения его полного расположения внутри экрана |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 412 |
установитьКадрСОбходнымиПутями
| Подпись | hs.window:setFrameWithWorkarounds(rect[, duration]) -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Устанавливает кадр окна в абсолютных координатах, используя дополнительные обходные пути, описанные в |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/window.lua строка 380 |
установитьПолноэкранныйРежим
| Подпись | hs.window:setFullScreen(fullscreen) -> window |
|---|---|
| Тип | Метод |
| Описание |
Устанавливает полноэкранный режим окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 382 |
изменитьРазмер
| Подпись | hs.window:setSize(size) -> window |
|---|---|
| Тип | Метод |
| Описание |
Изменяет размер окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 239 |
установитьЛевыйВерхнийУгол
| Подпись | hs.window:setTopLeft(point) -> window |
|---|---|
| Тип | Метод |
| Описание |
Перемещает окно в заданную точку |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 218 |
размер
| Подпись | hs.window:size() -> size |
|---|---|
| Тип | Метод |
| Описание |
Получает размер окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 201 |
снимок
| Подпись | hs.window:snapshot([keepTransparency]) -> hs.image-object |
|---|---|
| Тип | Метод |
| Описание |
Возвращает снимок окна как объект |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 611 |
подроль
| Подпись | hs.window:subrole() -> string |
|---|---|
| Тип | Метод |
| Описание |
Получает подроль окна |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 127 |
количествоВкладок
| Подпись | hs.window:tabCount() -> number or nil |
|---|---|
| Тип | Метод |
| Описание |
Получает количество вкладок в окне |
| Параметры |
|
| Возвращает |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 362 |
заголовок
| Подпись | hs.window:title() -> string |
|---|---|
| Тип | Метод |
| Описание |
Получает заголовок окна |
| Параметры |
|
| Возвращает |
|
| Источник | extensions/window/libwindow.m строка 110 |
toggleFullScreen
| Подпись | hs.window:toggleFullScreen() -> hs.window object |
|---|---|
| Тип | Метод |
| Описание |
Переключает полноэкранный режим окна |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 597 |
toggleZoom
| Подпись | hs.window:toggleZoom() -> window |
|---|---|
| Тип | Метод |
| Описание |
Переключает режим масштабирования окна (это эквивалентно нажатию на зеленую кнопку максимизации/полноэкранного режима в левом верхнем углу окна) |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/window/libwindow.m строка 257 |
topLeft
| Подпись | hs.window:topLeft() -> point |
|---|---|
| Тип | Метод |
| Описание |
Получает абсолютные координаты левого верхнего угла окна |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/window/libwindow.m строка 184 |
unminimize
| Подпись | hs.window:unminimize() -> window |
|---|---|
| Тип | Метод |
| Описание |
Выводит окно из минимизированного состояния |
| Параметры |
|
| Возвращаемое значение |
|
| Источник | extensions/window/libwindow.m строка 438 |
windowsToEast
| Подпись | hs.window:windowsToEast([candidateWindows[, frontmost[, strict]]]) -> list of hs.window objects |
|---|---|
| Тип | Метод |
| Описание |
Получает все окна, расположенные к востоку от текущего окна |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 688 |
windowsToNorth
| Подпись | hs.window:windowsToNorth([candidateWindows[, frontmost[, strict]]]) -> list of hs.window objects |
|---|---|
| Тип | Метод |
| Описание |
Получает все окна, расположенные к северу от текущего окна |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 718 |
windowsToSouth
| Подпись | hs.window:windowsToSouth([candidateWindows[, frontmost[, strict]]]) -> list of hs.window objects |
|---|---|
| Тип | Метод |
| Описание |
Получает все окна, расположенные к югу от текущего окна |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 733 |
windowsToWest
| Подпись | hs.window:windowsToWest([candidateWindows[, frontmost[, strict]]]) -> list of hs.window objects |
|---|---|
| Тип | Метод |
| Описание |
Получает все окна, расположенные к западу от текущего окна |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/window.lua строка 703 |
zoomButtonRect
| Подпись | hs.window:zoomButtonRect() -> rect-table or nil |
|---|---|
| Тип | Метод |
| Описание |
Получает прямоугольник-таблицу для расположения кнопки масштабирования (зеленая кнопка, обычно в левом верхнем углу окна) |
| Параметры |
|
| Возвращаемое значение |
|
| Примечания |
|
| Источник | extensions/window/libwindow.m строка 275 |
© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.window.html