aboutsummaryrefslogtreecommitdiffstats
path: root/Framework/MASShortcut.h
blob: 8ba1b538f2ecdf446fe25681424d46eaee4a455e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#import "MASKeyCodes.h"

/**
    A model class to hold a key combination.

    This class just represents a combination of keys. It does not care if
    the combination is valid or can be used as a hotkey, it doesn’t watch
    the input system for the shortcut appearance, nor it does access user
    defaults.
*/
@interface MASShortcut : NSObject <NSSecureCoding, NSCopying>

/**
    The virtual key code for the keyboard key.

    Hardware independent, same as in `NSEvent`. See `Events.h` in the HIToolbox
    framework for a complete list, or Command-click this symbol: `kVK_ANSI_A`.
*/
@property (nonatomic, readonly) NSUInteger keyCode;

/**
    Cocoa keyboard modifier flags.

    Same as in `NSEvent`: `NSCommandKeyMask`, `NSAlternateKeyMask`, etc.
*/
@property (nonatomic, readonly) NSUInteger modifierFlags;

/**
    Same as `keyCode`, just a different type.
*/
@property (nonatomic, readonly) UInt32 carbonKeyCode;

/**
    Carbon modifier flags.

    A bit sum of `cmdKey`, `optionKey`, etc.
*/
@property (nonatomic, readonly) UInt32 carbonFlags;

/**
    A string representing the “key” part of a shortcut, like the `5` in `⌘5`.
*/
@property (nonatomic, readonly) NSString *keyCodeString;

/**
    A key-code string used in key equivalent matching.

    For precise meaning of “key equivalents” see the `keyEquivalent`
    property of `NSMenuItem`. Here the string is used to support shortcut
    validation (“is the shortcut already taken in this menu?”) and
    for display in `NSMenu`.
*/
@property (nonatomic, readonly) NSString *keyCodeStringForKeyEquivalent;

/**
    A string representing the shortcut modifiers, like the `⌘` in `⌘5`.
*/
@property (nonatomic, readonly) NSString *modifierFlagsString;

- (instancetype)initWithKeyCode:(NSUInteger)code modifierFlags:(NSUInteger)flags;
+ (instancetype)shortcutWithKeyCode:(NSUInteger)code modifierFlags:(NSUInteger)flags;

/**
    Creates a new shortcut from an `NSEvent` object.

    This is just a convenience initializer that reads the key code and modifiers from an `NSEvent`.
*/
+ (instancetype)shortcutWithEvent:(NSEvent *)anEvent;

@end