Inspect/manipulate the position of the mouse pointer
This module is based primarily on code from the previous incarnation of Mjolnir by Steven Degutis.
This module uses ManyMouse by Ryan C. Gordon.
MANYMOUSE LICENSE:
Copyright (c) 2005-2012 Ryan C. Gordon and others.
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.
Ryan C. Gordon [email protected]
Signature | hs.mouse.absolutePosition([point]) -> point |
---|---|
Type | Function |
Description |
Get or set the absolute co-ordinates of the mouse pointer |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/libmouse.m line 202 |
Signature | hs.mouse.count([includeInternal]) -> number |
---|---|
Type | Function |
Description |
Gets the total number of mice connected to your system. |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/libmouse.m line 154 |
Signature | hs.mouse.currentCursorType() -> string |
---|---|
Type | Function |
Description |
Gets the identifier of the current mouse cursor type. |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/libmouse.m line 274 |
Signature | hs.mouse.getButtons() -> table |
---|---|
Type | Function |
Description |
Returns a table containing the current mouse buttons being pressed at this instant. |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/mouse.lua line 154 |
Signature | hs.mouse.getCurrentScreen() -> screen or nil |
---|---|
Type | Function |
Description |
Gets the screen the mouse pointer is on |
Parameters |
|
Returns |
|
Source | extensions/mouse/mouse.lua line 140 |
Signature | hs.mouse.getRelativePosition() -> point or nil |
---|---|
Type | Function |
Description |
Gets the co-ordinates of the mouse pointer, relative to the screen it is on |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/mouse.lua line 84 |
Signature | hs.mouse.names() -> table |
---|---|
Type | Function |
Description |
Gets the names of any mice connected to the system. |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/libmouse.m line 182 |
Signature | hs.mouse.scrollDirection() -> string |
---|---|
Type | Function |
Description |
Gets the system-wide direction of scrolling |
Parameters |
|
Returns |
|
Source | extensions/mouse/libmouse.m line 257 |
Signature | hs.mouse.setRelativePosition(point[, screen]) |
---|---|
Type | Function |
Description |
Sets the co-ordinates of the mouse pointer, relative to a screen |
Parameters |
|
Returns |
|
Source | extensions/mouse/mouse.lua line 112 |
Signature | hs.mouse.trackingSpeed([speed]) -> number |
---|---|
Type | Function |
Description |
Gets/Sets the current system mouse tracking speed setting |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/mouse/libmouse.m line 227 |
© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.mouse.html