Changeset 74 for trunk/ICeCoffEE/ICeCoffEE/ICeCoffEE.h

Timestamp:

01/30/03 05:31:29 (21 years ago)

Author:

Nicholas Riley

Message:

ICeCoffEE 1.3b2 plus some changes for 1.3

File:

• trunk/ICeCoffEE/ICeCoffEE/ICeCoffEE.h (modified) (1 diff)

trunk/ICeCoffEE/ICeCoffEE/ICeCoffEE.h

@@ -3 +3 @@
 #import "ICeCoffEESuper.h"
 #import "ICeCoffEEShared.h"
-
-#if ICCF_DEBUG
-#define ICLog NSLog
-#else
-#define ICLog (void)
-#endif
+#import "ICeCoffEEConfig.h"
 
 #define ICCF_OSErrAssert(err, context) NSAssert(err == noErr, ICCF_ErrString(err, context));
 #define ICCF_OSErrCAssert(err, context) NSCAssert(err == noErr, ICCF_ErrString(err, context));
 
-extern const long ICCF_MAX_URL_LEN;
-extern BOOL ICCF_enabled;
+// search for: (?<!ICCF_LocalizedString\()(?<!ICLog\()(?<!ICapeprintf("\()(?<!%)(@"(?!Internal error: )[^"]+") replace with: ICCF_LocalizedString(\1)
+#define ICCF_LocalizedString(key) \
+    [(NSString *)CFBundleCopyLocalizedString(ICCF_bundle, (CFStringRef)(key), CFSTR(""), NULL) autorelease]
 
-// functions shared between implementations
+// returns an explanation for the provided OSStatus in the supplied
+// if nil is returned, the error is harmless (e.g., user cancelled)
 NSString *ICCF_ErrString(OSStatus err, NSString *context);
-void ICCF_HandleException(NSException *e);
+
+// handles an exception as specified by ICError* preferences
+// if NO is returned, the exception is harmless (e.g., user cancelled)
+BOOL ICCF_HandleException(NSException *e);
+
+// returns YES if the event is a command-mouse down
 BOOL ICCF_EventIsCommandMouseDown(NSEvent *e);
+
+// returns YES if the current event's modifier flags include the option key
+BOOL ICCF_OptionKeyIsDown();
+
+// throws an exception if the URL range is nonexistent or too big
 void ICCF_CheckRange(NSRange range);
+
+// returns NSCharacterSets representing valid URL delimiters for left and right sides
 void ICCF_Delimiters(NSCharacterSet **leftPtr, NSCharacterSet **rightPtr);
+
+// start Internet Config (before ICCF_LaunchURL)
 void ICCF_StartIC();
+
+// stop Internet Config (after ICCF_LaunchURL)
 void ICCF_StopIC();
+
+// calls ICParseURL, returns output range
 void ICCF_ParseURL(NSString *string, NSRange *range);
-void ICCF_LaunchURL(NSString *string);
+
+// calls ICLaunchURL or ICCF_LaunchURLWithApplication (if chooseApp)
+void ICCF_LaunchURL(NSString *string, BOOL chooseApp);
+
+// launch URL from on selected text view cursor position or selection
 void ICCF_LaunchURLFromTextView(NSTextView *self);
+
+// returns contextual menu with Services item added, if selected
 NSMenu *ICCF_MenuForEvent(NSTextView *self, NSMenu *contextMenu, NSEvent *e);
+
+// adds or removes services menu in menu bar
+void ICCF_AddRemoveServicesMenu();
 
 @interface ICeCoffEE : ICeCoffEESuper