xKey
xKey is a Cocoa key handler extension for OSX written in Swift
Examples
- Operate in order of keyDown(K), keyDown(L), keyUp(L).
-
When not using xKey, keyDown(K) event does not fire in spite of K key is pressing.
- keyDown(K)→keyDown(L)→keyUp(L)→ not to call keyDown(K)
-
When using xKey, xKey trigger a keyDown(K) event automatically.
- keyDown(K)→keyDown(L)→keyUp(L)→keyDown(K)
Usage
Write below code in AppDelegate.swift.
import XKey
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
func applicationDidFinishLaunching(_ aNotification: Notification) {
XKey.shared.extend() // Insert this line into your AppDelegate.
}
func applicationWillTerminate(_ aNotification: Notification) {
// Insert code here to tear down your application
}
}Option
enabled
XKey.enabled = true // enabled xKey
XKey.enabled = false // disabled xKeylogger
XKey.logger = [.keyDown(.characters)] // output pressed key's character when key downed
XKey.logger = [.keyDown(.keyCode), .keyUp(.keyCode)] // output keyCode when keyDown and keyUpenum KeyLogger {
case keyDown(KeyLoggerType)
case keyUp(KeyLoggerType)
}
enum KeyLoggerType {
case keyCode
case characters
case charactersIgnoringModifiers
}Instration
CocoaPods
Add the following to your Podfile:
pod "xKey"
pod "xKey"
Carthage
Add the following to your Cartfile:
github "natmark/xKey"
github "natmark/xKey"
License
xKey is available under the MIT license. See the LICENSE file for more info.