aboutsummaryrefslogtreecommitdiffstats
path: root/Framework/MASShortcut.h
diff options
context:
space:
mode:
authorTomáš Znamenáček2015-01-16 12:57:08 +0100
committerTomáš Znamenáček2015-01-16 12:57:08 +0100
commitbf3a032c4b9205437003a7decca66bd6533fc8bb (patch)
tree7919d16edbd74676c6f30d89c9428ed70b2a8820 /Framework/MASShortcut.h
parent3ebbb7efde52d97abf9d215e5446e10a30223057 (diff)
downloadMASShortcut-bf3a032c4b9205437003a7decca66bd6533fc8bb.tar.bz2
Decrease headerdoc indenting to appease appledoc (see #55).
I think I have finally found out the reason for CocoaDocs ignoring our markup: I have indented the documentation by four spaces, which was interpreted as “code” by appledoc. Trying now without the indent, that should finally help.
Diffstat (limited to 'Framework/MASShortcut.h')
-rw-r--r--Framework/MASShortcut.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/Framework/MASShortcut.h b/Framework/MASShortcut.h
index 8ba1b53..e175317 100644
--- a/Framework/MASShortcut.h
+++ b/Framework/MASShortcut.h
@@ -1,59 +1,59 @@
#import "MASKeyCodes.h"
/**
- A model class to hold a key combination.
+ 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.
+ 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.
+ 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`.
+ 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.
+ Cocoa keyboard modifier flags.
- Same as in `NSEvent`: `NSCommandKeyMask`, `NSAlternateKeyMask`, etc.
+ Same as in `NSEvent`: `NSCommandKeyMask`, `NSAlternateKeyMask`, etc.
*/
@property (nonatomic, readonly) NSUInteger modifierFlags;
/**
- Same as `keyCode`, just a different type.
+ Same as `keyCode`, just a different type.
*/
@property (nonatomic, readonly) UInt32 carbonKeyCode;
/**
- Carbon modifier flags.
+ Carbon modifier flags.
- A bit sum of `cmdKey`, `optionKey`, etc.
+ 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`.
+ 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.
+ 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`.
+ 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`.
+ A string representing the shortcut modifiers, like the `⌘` in `⌘5`.
*/
@property (nonatomic, readonly) NSString *modifierFlagsString;
@@ -61,9 +61,9 @@
+ (instancetype)shortcutWithKeyCode:(NSUInteger)code modifierFlags:(NSUInteger)flags;
/**
- Creates a new shortcut from an `NSEvent` object.
+ Creates a new shortcut from an `NSEvent` object.
- This is just a convenience initializer that reads the key code and modifiers from an `NSEvent`.
+ This is just a convenience initializer that reads the key code and modifiers from an `NSEvent`.
*/
+ (instancetype)shortcutWithEvent:(NSEvent *)anEvent;