aboutsummaryrefslogtreecommitdiffstats
path: root/Framework/MASShortcutValidator.h
blob: 95fe8282b1183d3c39905a884e3cf36ed4679934 (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
#import "MASShortcut.h"

/**
 This class is used by the recording control to tell which shortcuts are acceptable.

 There are two kinds of shortcuts that are not considered acceptable: shortcuts that
 are too simple (like single letter keys) and shortcuts that are already used by the
 operating system.
*/
@interface MASShortcutValidator : NSObject

/**
 Set to `YES` if you want to accept Option-something shortcuts.

 `NO` by default, since Option-something shortcuts are often used by system,
 for example Option-G will type the © sign. This also applies to Option-Shift
 shortcuts – in other words, shortcut recorder will not accept shortcuts like
 Option-Shift-K by default. (Again, since Option-Shift-K inserts the Apple
 logo sign by default.)
*/
@property(assign) BOOL allowAnyShortcutWithOptionModifier;

+ (instancetype) sharedValidator;

- (BOOL) isShortcutValid: (MASShortcut*) shortcut;
- (BOOL) isShortcut: (MASShortcut*) shortcut alreadyTakenInMenu: (NSMenu*) menu explanation: (NSString**) explanation;
- (BOOL) isShortcutAlreadyTakenBySystem: (MASShortcut*) shortcut explanation: (NSString**) explanation;

@end