aboutsummaryrefslogtreecommitdiffstats
path: root/Framework/MASShortcutBinder.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/MASShortcutBinder.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/MASShortcutBinder.h')
-rw-r--r--Framework/MASShortcutBinder.h58
1 files changed, 29 insertions, 29 deletions
diff --git a/Framework/MASShortcutBinder.h b/Framework/MASShortcutBinder.h
index 1e65e0d..e7406de 100644
--- a/Framework/MASShortcutBinder.h
+++ b/Framework/MASShortcutBinder.h
@@ -1,66 +1,66 @@
#import "MASShortcutMonitor.h"
/**
- Binds actions to user defaults keys.
+ Binds actions to user defaults keys.
- If you store shortcuts in user defaults (for example by binding
- a `MASShortcutView` to user defaults), you can use this class to
- connect an action directly to a user defaults key. If the shortcut
- stored under the key changes, the action will get automatically
- updated to the new one.
+ If you store shortcuts in user defaults (for example by binding
+ a `MASShortcutView` to user defaults), you can use this class to
+ connect an action directly to a user defaults key. If the shortcut
+ stored under the key changes, the action will get automatically
+ updated to the new one.
- This class is mostly a wrapper around a `MASShortcutMonitor`. It
- watches the changes in user defaults and updates the shortcut monitor
- accordingly with the new shortcuts.
+ This class is mostly a wrapper around a `MASShortcutMonitor`. It
+ watches the changes in user defaults and updates the shortcut monitor
+ accordingly with the new shortcuts.
*/
@interface MASShortcutBinder : NSObject
/**
- A convenience shared instance.
+ A convenience shared instance.
- You may use it so that you don’t have to manage an instance by hand,
- but it’s perfectly fine to allocate and use a separate instance instead.
+ You may use it so that you don’t have to manage an instance by hand,
+ but it’s perfectly fine to allocate and use a separate instance instead.
*/
+ (instancetype) sharedBinder;
/**
- The underlying shortcut monitor.
+ The underlying shortcut monitor.
*/
@property(strong) MASShortcutMonitor *shortcutMonitor;
/**
- Binding options customizing the access to user defaults.
+ Binding options customizing the access to user defaults.
- As an example, you can use `NSValueTransformerNameBindingOption` to customize
- the storage format used for the shortcuts. By default the shortcuts are converted
- from `NSData` (`NSKeyedUnarchiveFromDataTransformerName`). Note that if the
- binder is to work with `MASShortcutView`, both object have to use the same storage
- format.
+ As an example, you can use `NSValueTransformerNameBindingOption` to customize
+ the storage format used for the shortcuts. By default the shortcuts are converted
+ from `NSData` (`NSKeyedUnarchiveFromDataTransformerName`). Note that if the
+ binder is to work with `MASShortcutView`, both object have to use the same storage
+ format.
*/
@property(copy) NSDictionary *bindingOptions;
/**
- Binds given action to a shortcut stored under the given defaults key.
+ Binds given action to a shortcut stored under the given defaults key.
- In other words, no matter what shortcut you store under the given key,
- pressing it will always trigger the given action.
+ In other words, no matter what shortcut you store under the given key,
+ pressing it will always trigger the given action.
*/
- (void) bindShortcutWithDefaultsKey: (NSString*) defaultsKeyName toAction: (dispatch_block_t) action;
/**
- Disconnect the binding between user defaults and action.
+ Disconnect the binding between user defaults and action.
- In other words, the shortcut stored under the given key will no longer trigger an action.
+ In other words, the shortcut stored under the given key will no longer trigger an action.
*/
- (void) breakBindingWithDefaultsKey: (NSString*) defaultsKeyName;
/**
- Register default shortcuts in user defaults.
+ Register default shortcuts in user defaults.
- This is a convenience frontent to `[NSUserDefaults registerDefaults]`.
- The dictionary should contain a map of user defaults’ keys to appropriate
- keyboard shortcuts. The shortcuts will be transformed according to
- `bindingOptions` and registered using `registerDefaults`.
+ This is a convenience frontent to `[NSUserDefaults registerDefaults]`.
+ The dictionary should contain a map of user defaults’ keys to appropriate
+ keyboard shortcuts. The shortcuts will be transformed according to
+ `bindingOptions` and registered using `registerDefaults`.
*/
- (void) registerDefaultShortcuts: (NSDictionary*) defaultShortcuts;