ShortcutRecorder

The framework provides several specialized classes to handle different parts of the shortcut lifecycle:

• UI & Capture: SRRecorderControl is used to render the recording interface and capture user input.
• Styling: SRRecorderControlStyle allows for custom visual styles.
• Data Model: SRShortcut represents the actual shortcut model.
• Global Monitoring:
  • SRGlobalShortcutMonitor: Registers a global hotkey to turn a shortcut into an action.
  • SRAXGlobalShortcutMonitor: Uses macOS Accessibility to handle any kind of keyboard event.
• Local Monitoring: SRLocalShortcutMonitor handles events manually within the responder chain or via NSEvent monitors.
• Integration & Validation:
  • SRShortcutController: Provides smooth Cocoa Bindings and Interface Builder integration.
  • SRShortcutValidator: Validates shortcuts against Cocoa key equivalents and global hot keys.
• Formatting: Includes NSValueTransformer and NSFormatter subclasses for custom data alterations.

To use ShortcutRecorder, you typically combine a RecorderControl (for UI) with a GlobalShortcutMonitor (for background actions).

Swift Usage

1. Define a key path and binding options.
2. Create a ShortcutAction to execute code when the shortcut is triggered.
3. Register the action with GlobalShortcutMonitor.shared.
4. Bind a RecorderControl instance to your data model (e.g., NSUserDefaultsController).

Objective-C Usage

1. Define a key path and binding options.
2. Create an SRShortcutAction with an action handler.
3. Register the action with [SRGlobalShortcutMonitor sharedMonitor].
4. Bind an SRRecorderControl instance to your data model.

import ShortcutRecorder

let defaults = NSUserDefaultsController.shared
let keyPath = "values.shortcut"
let options = [NSBindingOption.valueTransformerName: .keyedUnarchiveFromDataTransformerName]

let beepAction = ShortcutAction(keyPath: keyPath, of: defaults) { _ in
    NSSound.beep()
    return true
}
GlobalShortcutMonitor.shared.addAction(beepAction, forKeyEvent: .down)

let recorder = RecorderControl()
recorder.bind(.value, to: defaults, withKeyPath: keyPath, options: options)

recorder.objectValue = Shortcut(keyEquivalent: "⇧⌘A")