Changeset 13071

Timestamp:

Nov 2, 2011, 11:13:02 PM (11 years ago)

Author:

livings124

Message:

#4611 Update Growl framework to 1.3

Location:

trunk/macosx/Growl.framework/Versions/A

Files:

• Growl (modified) (previous)
• Headers/Growl.h (modified) (1 diff)
• Headers/GrowlApplicationBridge-Carbon.h (deleted)
• Headers/GrowlApplicationBridge.h (modified) (7 diffs)
• Headers/GrowlDefines.h (modified) (8 diffs)
• Resources/Info.plist (modified) (2 diffs)
• _CodeSignature (added)
• _CodeSignature/CodeResources (added)

trunk/macosx/Growl.framework/Versions/A/Headers/Growl.h

@@ -1 @@
-#include "GrowlDefines.h"
+#include <Growl/GrowlDefines.h>
 
 #ifdef __OBJC__
-#       include "GrowlApplicationBridge.h"
+#       include <Growl/GrowlApplicationBridge.h>
 #endif
-#include "GrowlApplicationBridge-Carbon.h"

trunk/macosx/Growl.framework/Versions/A/Headers/GrowlApplicationBridge.h

@@ -19 +19 @@
 #import <Foundation/Foundation.h>
 #import <AppKit/AppKit.h>
-#import "GrowlDefines.h"
+#import <Growl/GrowlDefines.h>
 
 //Forward declarations
 @protocol GrowlApplicationBridgeDelegate;
-
-//Internal notification when the user chooses not to install (to avoid continuing to cache notifications awaiting installation)
-#define GROWL_USER_CHOSE_NOT_TO_INSTALL_NOTIFICATION @"User chose not to install"
 
 //------------------------------------------------------------------------------
@@ -46 +43 @@
  *      @abstract Detects whether Growl is installed.
  *      @discussion Determines if the Growl prefpane and its helper app are installed.
- *      @result Returns YES if Growl is installed, NO otherwise.
- */
-+ (BOOL) isGrowlInstalled;
+ *      @result this method will forever return YES.
+ */
++ (BOOL) isGrowlInstalled __attribute__((deprecated));
 
 /*!
@@ -57 +54 @@
  */
 + (BOOL) isGrowlRunning;
+
+
+/*!
+ *      @method isMistEnabled
+ *      @abstract Gives the caller a fairly good indication of whether or not built-in notifications(Mist) will be used.
+ *      @discussion since this call makes use of isGrowlRunning it is entirely possible for this value to change between call and
+ *    executing a notification dispatch
+ *      @result Returns YES if Growl isn't reachable and the developer has not opted-out of
+ *    Mist and the user hasn't set the global mist enable key to false.
+ */
++ (BOOL)isMistEnabled;
+
+/*!
+ *      @method setShouldUseBuiltInNotifications
+ *      @abstract opt-out mechanism for the mist notification style in the event growl can't be reached.
+ *      @discussion if growl is unavailable due to not being installed or as a result of being turned off then
+ *    this option can enable/disable a built-in fire and forget display style
+ *      @param should Specifies whether or not the developer wants to opt-in (default) or opt out
+ *    of the built-in Mist style in the event Growl is unreachable.
+ */
++ (void)setShouldUseBuiltInNotifications:(BOOL)should;
+
+/*!
+ *      @method shouldUseBuiltInNotifications
+ *      @abstract returns the current opt-in state of the framework's use of the Mist display style.
+ *      @result Returns NO if the developer opt-ed out of Mist, the default value is YES.
+ */
++ (BOOL)shouldUseBuiltInNotifications;
 
 #pragma mark -
@@ -324 +349 @@
  *       ---                                                                 -----
  *       <code>GROWL_APP_NAME</code>                 <code>CFBundleExecutableName</code>
- *       <code>GROWL_APP_ICON</code>                 The icon of the application.
+ *       <code>GROWL_APP_ICON_DATA</code>            The data of the icon of the application.
  *       <code>GROWL_APP_LOCATION</code>             The location of the application.
  *       <code>GROWL_NOTIFICATIONS_DEFAULT</code>    <code>GROWL_NOTIFICATIONS_ALL</code>
@@ -345 +370 @@
  *       ---                                                                 -----
  *       <code>GROWL_APP_NAME</code>                 <code>CFBundleExecutableName</code>
- *       <code>GROWL_APP_ICON</code>                 The icon of the application.
+ *       <code>GROWL_APP_ICON_DATA</code>            The data of the icon of the application.
  *       <code>GROWL_APP_LOCATION</code>             The location of the application.
  *       <code>GROWL_NOTIFICATIONS_DEFAULT</code>    <code>GROWL_NOTIFICATIONS_ALL</code>
@@ -369 +394 @@
  *
  *       \li <code>GROWL_APP_NAME</code>
- *       \li <code>GROWL_APP_ICON</code>
+ *       \li <code>GROWL_APP_ICON_DATA</code>
  *
  *      @since Growl.framework 1.1
@@ -511 +536 @@
 - (void) growlNotificationTimedOut:(id)clickContext;
 
+
+/*!
+ * @method hasNetworkClientEntitlement
+ * @abstract Used only in sandboxed situations since we don't know whether the app has com.apple.security.network.client entitlement
+ * @discussion GrowlDelegate calls to find out if we have the com.apple.security.network.client entitlement,
+ *  since we can't find this out without hitting the sandbox.  We only call it if we detect that the application is sandboxed.
+ */
+- (BOOL) hasNetworkClientEntitlement;
+
 @end
 
 #pragma mark -
-/*!
- *      @category NSObject(GrowlApplicationBridgeDelegate_Installation_InformalProtocol)
- *      @abstract Methods which may be optionally implemented by the Growl delegate when used with Growl-WithInstaller.framework.
- *      @discussion The methods in this informal protocol will only be called if
- *       implemented by the delegate.  They allow greater control of the information
- *       presented to the user when installing or upgrading Growl from within your
- *       application when using Growl-WithInstaller.framework.
- */
-@interface NSObject (GrowlApplicationBridgeDelegate_Installation_InformalProtocol)
-
-/*!
- *      @method growlInstallationWindowTitle
- *      @abstract Return the title of the installation window.
- *      @discussion If not implemented, Growl will use a default, localized title.
- *      @result An NSString object to use as the title.
- */
-- (NSString *)growlInstallationWindowTitle;
-
-/*!
- *      @method growlUpdateWindowTitle
- *      @abstract Return the title of the upgrade window.
- *      @discussion If not implemented, Growl will use a default, localized title.
- *      @result An NSString object to use as the title.
- */
-- (NSString *)growlUpdateWindowTitle;
-
-/*!
- *      @method growlInstallationInformation
- *      @abstract Return the information to display when installing.
- *      @discussion This information may be as long or short as desired (the window
- *       will be sized to fit it).  It will be displayed to the user as an
- *       explanation of what Growl is and what it can do in your application.  It
- *       should probably note that no download is required to install.
- *
- *       If this is not implemented, Growl will use a default, localized explanation.
- *      @result An NSAttributedString object to display.
- */
-- (NSAttributedString *)growlInstallationInformation;
-
-/*!
- *      @method growlUpdateInformation
- *      @abstract Return the information to display when upgrading.
- *      @discussion This information may be as long or short as desired (the window
- *       will be sized to fit it).  It will be displayed to the user as an
- *       explanation that an updated version of Growl is included in your
- *       application and no download is required.
- *
- *       If this is not implemented, Growl will use a default, localized explanation.
- *      @result An NSAttributedString object to display.
- */
-- (NSAttributedString *)growlUpdateInformation;
-
-@end
-
-//private
-@interface GrowlApplicationBridge (GrowlInstallationPrompt_private)
-+ (void) _userChoseNotToInstallGrowl;
-@end
 
 #endif /* __GrowlApplicationBridge_h__ */

trunk/macosx/Growl.framework/Versions/A/Headers/GrowlDefines.h

@@ -8 +8 @@
 #ifdef __OBJC__
 #define XSTR(x) (@x)
-#define STRING_TYPE NSString *
 #else
 #define XSTR CFSTR
-#define STRING_TYPE CFStringRef
 #endif
 
@@ -57 +55 @@
  */
 #define GROWL_APP_ID                                    XSTR("ApplicationId")
-/*!     @defined GROWL_APP_ICON
+/*!     @defined GROWL_APP_ICON_DATA
  *      @abstract The image data for your application's icon.
  *      @discussion Image data representing your application's icon. This may be
@@ -67 +65 @@
  *       Optional. Not supported by all display plugins.
  */
-#define GROWL_APP_ICON                                  XSTR("ApplicationIcon")
+#define GROWL_APP_ICON_DATA                             XSTR("ApplicationIcon")
 /*!     @defined GROWL_NOTIFICATIONS_DEFAULT
  *      @abstract The array of notifications to turn on by default.
@@ -145 +143 @@
 #define GROWL_NOTIFICATION_DESCRIPTION          XSTR("NotificationDescription")
 /*!     @defined GROWL_NOTIFICATION_ICON
- *      @discussion Image data for the notification icon. Must be in a format
+ *      @discussion Image data for the notification icon. Image data must be in a format
  *       supported by NSImage, such as TIFF, PNG, GIF, JPEG, BMP, PICT, or PDF.
  *
  *       Optional. Not supported by all display plugins.
  */
-#define GROWL_NOTIFICATION_ICON                 XSTR("NotificationIcon")
+#define GROWL_NOTIFICATION_ICON_DATA                    XSTR("NotificationIcon")
 /*!     @defined GROWL_NOTIFICATION_APP_ICON
  *      @discussion Image data for the application icon, in case GROWL_APP_ICON does
- *       not apply for some reason. Must be in a format supported by NSImage, such
+ *       not apply for some reason. Image data be in a format supported by NSImage, such
  *       as TIFF, PNG, GIF, JPEG, BMP, PICT, or PDF.
  *
  *       Optional. Not supported by all display plugins.
  */
-#define GROWL_NOTIFICATION_APP_ICON             XSTR("NotificationAppIcon")
+#define GROWL_NOTIFICATION_APP_ICON_DATA                XSTR("NotificationAppIcon")
 /*!     @defined GROWL_NOTIFICATION_PRIORITY
  *      @discussion The priority of the notification as an integer number from
@@ -185 +183 @@
  */
 #define GROWL_NOTIFICATION_CLICK_CONTEXT                        XSTR("NotificationClickContext")
-
-/*!     @defined GROWL_DISPLAY_PLUGIN
- *      @discussion The name of a display plugin which should be used for this notification.
- *    Optional. If this key is not set or the specified display plugin does not
- *    exist, the display plugin stored in the application ticket is used. This key
- *    allows applications to use different default display plugins for their
- *    notifications. The user can still override those settings in the preference
- *    pane.
- */
-#define GROWL_DISPLAY_PLUGIN                            XSTR("NotificationDisplayPlugin")
 
 /*!     @defined GROWL_NOTIFICATION_IDENTIFIER
@@ -246 +234 @@
  *       <ul>
  *              <li>GROWL_APP_NAME</li>
- *              <li>GROWL_APP_ICON</li>
+ *              <li>GROWL_APP_ICON_DATA</li>
  *              <li>GROWL_NOTIFICATIONS_ALL</li>
  *              <li>GROWL_NOTIFICATIONS_DEFAULT</li>
@@ -289 +277 @@
  */
 #define GROWL_NOTIFICATION                              XSTR("GrowlNotification")
-/*!     @defined GROWL_SHUTDOWN
-*       @abstract The distributed notification name that tells Growl to shutdown.
-*       @discussion The Growl preference pane posts this notification when the
-*        "Stop Growl" button is clicked.
-*/
-#define GROWL_SHUTDOWN                                  XSTR("GrowlShutdown")
 /*!     @defined GROWL_PING
  *      @abstract A distributed notification to check whether Growl is running.
@@ -314 +296 @@
  */
 #define GROWL_IS_READY                                  XSTR("Lend Me Some Sugar; I Am Your Neighbor!")
-/*!     @defined GROWL_NOTIFICATION_CLICKED
- *      @abstract The distributed notification sent when a supported notification is clicked.
+
+
+/*!     @defined GROWL_DISTRIBUTED_NOTIFICATION_CLICKED_SUFFIX
+ *      @abstract Part of the name of the distributed notification sent when a supported notification is clicked.
  *      @discussion When a Growl notification with a click context is clicked on by
- *       the user, Growl posts this distributed notification.
- *       The GrowlApplicationBridge responds to this notification by calling a
- *       callback in its delegate.
- */
-#define GROWL_NOTIFICATION_CLICKED              XSTR("GrowlClicked!")
-#define GROWL_NOTIFICATION_TIMED_OUT    XSTR("GrowlTimedOut!")
+ *       the user, Growl posts a distributed notification whose name is in the format:
+ *        [NSString stringWithFormat:@"%@-%d-%@", appName, pid, GROWL_DISTRIBUTED_NOTIFICATION_CLICKED_SUFFIX]
+ *       The GrowlApplicationBridge responds to this notification by calling a callback in its delegate.
+ */
+#define GROWL_DISTRIBUTED_NOTIFICATION_CLICKED_SUFFIX           XSTR("GrowlClicked!")
+
+/*!     @defined GROWL_DISTRIBUTED_NOTIFICATION_TIMED_OUT_SUFFIX
+ *      @abstract Part of the name of the distributed notification sent when a supported notification times out without being clicked.
+ *      @discussion When a Growl notification with a click context times out, Growl posts a distributed notification
+ *       whose name is in the format:
+ *                [NSString stringWithFormat:@"%@-%d-%@", appName, pid, GROWL_DISTRIBUTED_NOTIFICATION_TIMED_OUT_SUFFIX]
+ *       The GrowlApplicationBridge responds to this notification by calling a callback in its delegate.
+ *   NOTE: The user may have actually clicked the 'close' button; this triggers an *immediate* time-out of the notification.
+ */
+#define GROWL_DISTRIBUTED_NOTIFICATION_TIMED_OUT_SUFFIX         XSTR("GrowlTimedOut!")
 
 /*!     @group Other symbols */

trunk/macosx/Growl.framework/Versions/A/Resources/Info.plist

@@ -4 +4 @@
 <dict>
         <key>BuildMachineOSBuild</key>
-        <string>10J869</string>
+        <string>11A511</string>
         <key>CFBundleDevelopmentRegion</key>
         <string>English</string>
@@ -16 +16 @@
         <string>FMWK</string>
         <key>CFBundleShortVersionString</key>
-        <string>1.2.2</string>
+        <string>1.3</string>
         <key>CFBundleSignature</key>
         <string>GRRR</string>
         <key>CFBundleVersion</key>
-        <string>1.2.2</string>
+        <string>1.3</string>
         <key>DTCompiler</key>
-        <string>4.0</string>
+        <string>com.apple.compilers.llvm.clang.1_0</string>
         <key>DTPlatformBuild</key>
-        <string>10M2518</string>
+        <string>4D199</string>
         <key>DTPlatformVersion</key>
-        <string>PG</string>
+        <string>GM</string>
         <key>DTSDKBuild</key>
-        <string>9L31a</string>
+        <string>11C63</string>
         <key>DTSDKName</key>
-        <string>macosx10.5</string>
+        <string>macosx10.7</string>
         <key>DTXcode</key>
-        <string>0400</string>
+        <string>0420</string>
         <key>DTXcodeBuild</key>
-        <string>10M2518</string>
+        <string>4D199</string>
         <key>NSPrincipalClass</key>
         <string>GrowlApplicationBridge</string>