Ctrl K

#plugins.finder.window

Handy tools for Windows Management in macOS.

Inspired by WinWin for Hammerspoon.

#API Overview

Variables - Configurable values

gridparts

Functions - API calls offered directly by the extension

centerCursor
grid
hints
moveAndResize
moveToScreen
stepMove
stepResize
undo

#API Documentation

#Variables

#gridparts


Signature	`plugins.finder.window.gridparts`
Type	Variable
Description	An integer specifying how many gridparts the screen should be divided into. Defaults to 30.
Notes	None
Source	src/plugins/finder/window/window.lua line 72

#Functions

#centerCursor


Signature	`plugins.finder.window.centerCursor() -> nil`
Type	Function
Description	Center the cursor on the focused window.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 42

#grid


Signature	`plugins.finder.window.grid() -> nil`
Type	Function
Description	Shows a modal keyboard driven interface for interactive window resizing.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 16

#hints


Signature	`plugins.finder.window.hints() -> nil`
Type	Function
Description	Displays a keyboard hint for switching focus to each window.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 29

#moveAndResize


Signature	`plugins.finder.window.moveAndResize(option)`
Type	Function
Description	Move and resize the focused window.
Parameters	option - A string specifying the option, valid strings are: `halfleft`, `halfright`, `halfup`, `halfdown`, `cornerNW`, `cornerSW`, `cornerNE`, `cornerSE`, `center`, `fullscreen`, `expand`, `shrink`.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 182

#moveToScreen


Signature	`plugins.finder.window.moveToScreen(direction)`
Type	Function
Description	Move the focused window between all of the screens in the `direction`.
Parameters	direction - A string specifying the direction, valid strings are: `left`, `right`, `up`, `down`, `next`.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 237

#stepMove


Signature	`plugins.finder.window.stepMove(direction)`
Type	Function
Description	Move the focused window in the `direction` by one step. The step scale equals to the width/height of one gridpart.
Parameters	direction - A string specifying the direction, valid strings are: `left`, `right`, `up`, `down`.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 77

#stepResize


Signature	`plugins.finder.window.stepResize(direction)`
Type	Function
Description	Resize the focused window in the `direction` by on step.
Parameters	direction - A string specifying the direction, valid strings are: `left`, `right`, `up`, `down`.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 128

#undo


Signature	`plugins.finder.window.undo()`
Type	Function
Description	Undo the last window manipulation. Only those "moveAndResize" manipulations can be undone.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finder/window/window.lua line 106

Ctrl K