Rewrite KeyInputTextView into NJKeyInputField. New class communicates using a proper...

[enjoyable.git] / NJKeyInputField.h

diff --git a/NJKeyInputField.h b/NJKeyInputField.h
new file mode 100644 (file)
index 0000000..ad026d3
--- /dev/null
+++ b/NJKeyInputField.h
@@ -0,0 +1,45 @@
+//
+//  NJKeyInputField.h
+//  Enjoyable
+//
+//  Copyright 2013 Joe Wreschnig.
+//
+
+#import <Cocoa/Cocoa.h>
+
+extern CGKeyCode NJKeyInputFieldEmpty;
+
+@protocol NJKeyInputFieldDelegate;
+
+@interface NJKeyInputField : NSTextField
+    // An NJKeyInputField is a NSTextField-like widget that receives
+    // exactly one key press, and displays the name of that key, then
+    // resigns its first responder status. It can also inform a
+    // special delegate when its content changes.
+
++ (NSString *)stringForKeyCode:(CGKeyCode)keyCode;
+    // Give the string name for a virtual key code.
+
+@property (nonatomic, weak) IBOutlet id <NJKeyInputFieldDelegate> keyDelegate;
+
+@property (nonatomic, assign) CGKeyCode keyCode;
+    // The currently displayed key code, or NJKeyInputFieldEmpty if no
+    // key is active.  Changing this will update the display but not
+    // inform the delegate.
+
+@property (nonatomic, readonly) BOOL hasKeyCode;
+    // True if any key is active, false otherwise.
+
+- (void)clear;
+    // Clear the currently active key and call the delegate.
+
+@end
+
+@protocol NJKeyInputFieldDelegate <NSObject>
+
+- (void)keyInputField:(NJKeyInputField *)keyInput
+         didChangeKey:(CGKeyCode)keyCode;
+- (void)keyInputFieldDidClear:(NJKeyInputField *)keyInput;
+
+@end
+