[67869] branches/gsoc10-gui/Pallet
tzikis at macports.org
tzikis at macports.org
Thu May 20 03:57:13 PDT 2010
Revision: 67869
http://trac.macports.org/changeset/67869
Author: tzikis at macports.org
Date: 2010-05-20 03:57:08 -0700 (Thu, 20 May 2010)
Log Message:
-----------
Added Growl Framework files
Modified Paths:
--------------
branches/gsoc10-gui/Pallet/Pallet.xcodeproj/project.pbxproj
Added Paths:
-----------
branches/gsoc10-gui/Pallet/Growl Registration Ticket.growlRegDict
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Growl
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Headers
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Resources
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Growl
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/Growl.h
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge-Carbon.h
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge.h
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlDefines.h
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Resources/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Resources/Info.plist
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/Current
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Info.plist
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Resources/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Resources/DWARF/
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Resources/DWARF/Growl
branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/License.txt
Added: branches/gsoc10-gui/Pallet/Growl Registration Ticket.growlRegDict
===================================================================
--- branches/gsoc10-gui/Pallet/Growl Registration Ticket.growlRegDict (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl Registration Ticket.growlRegDict 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+ <key>TicketVersion</key>
+ <integer>1</integer>
+ <key>AllNotifications</key>
+ <array>
+ <string>InstallCompleted</string>
+ <string>InstallFailed</string>
+ <string>UpgradeCompleted</string>
+ <string>UgrdadeFailed</string>
+ <string>RemoveCompleted</string>
+ <string>RemoveFailed</string>
+ <string>SelfupdateCompleted</string>
+ <string>SelfupdateFailed</string>
+ <string>SyncCompleted</string>
+ <string>SyncFailed</string>
+ <string>OperationsCompleted</string>
+ <string>OperationsFailed</string>
+ </array>
+</dict>
+</plist>
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Growl
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Growl (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Growl 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1 @@
+link Versions/Current/Growl
\ No newline at end of file
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Growl
___________________________________________________________________
Added: svn:special
+ *
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Headers
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Headers (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Headers 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1 @@
+link Versions/Current/Headers
\ No newline at end of file
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Headers
___________________________________________________________________
Added: svn:special
+ *
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Resources
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Resources (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Resources 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1 @@
+link Versions/Current/Resources
\ No newline at end of file
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Resources
___________________________________________________________________
Added: svn:special
+ *
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Growl
===================================================================
(Binary files differ)
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Growl
___________________________________________________________________
Added: svn:executable
+ *
Added: svn:mime-type
+ application/octet-stream
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/Growl.h
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/Growl.h (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/Growl.h 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,6 @@
+#include "GrowlDefines.h"
+
+#ifdef __OBJC__
+# include "GrowlApplicationBridge.h"
+#endif
+#include "GrowlApplicationBridge-Carbon.h"
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge-Carbon.h
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge-Carbon.h (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge-Carbon.h 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,780 @@
+//
+// GrowlApplicationBridge-Carbon.h
+// Growl
+//
+// Created by Mac-arena the Bored Zo on Wed Jun 18 2004.
+// Based on GrowlApplicationBridge.h by Evan Schoenberg.
+// This source code is in the public domain. You may freely link it into any
+// program.
+//
+
+#ifndef _GROWLAPPLICATIONBRIDGE_CARBON_H_
+#define _GROWLAPPLICATIONBRIDGE_CARBON_H_
+
+#include <sys/cdefs.h>
+#include <Carbon/Carbon.h>
+
+#ifndef GROWL_EXPORT
+#define GROWL_EXPORT __attribute__((visibility("default"))) DEPRECATED_ATTRIBUTE
+#endif
+
+/*! @header GrowlApplicationBridge-Carbon.h
+ * @abstract Declares an API that Carbon applications can use to interact with Growl.
+ * @discussion GrowlApplicationBridge uses a delegate to provide information //XXX
+ * to Growl (such as your application's name and what notifications it may
+ * post) and to provide information to your application (such as that Growl
+ * is listening for notifications or that a notification has been clicked).
+ *
+ * You can set the Growldelegate with Growl_SetDelegate and find out the
+ * current delegate with Growl_GetDelegate. See struct Growl_Delegate for more
+ * information about the delegate.
+ */
+
+__BEGIN_DECLS
+
+/*! @struct Growl_Delegate
+ * @abstract Delegate to supply GrowlApplicationBridge with information and respond to events.
+ * @discussion The Growl delegate provides your interface to
+ * GrowlApplicationBridge. When GrowlApplicationBridge needs information about
+ * your application, it looks for it in the delegate; when Growl or the user
+ * does something that you might be interested in, GrowlApplicationBridge
+ * looks for a callback in the delegate and calls it if present
+ * (meaning, if it is not <code>NULL</code>).
+ * XXX on all of that
+ * @field size The size of the delegate structure.
+ * @field applicationName The name of your application.
+ * @field registrationDictionary A dictionary describing your application and the notifications it can send out.
+ * @field applicationIconData Your application's icon.
+ * @field growlInstallationWindowTitle The title of the installation window.
+ * @field growlInstallationInformation Text to display in the installation window.
+ * @field growlUpdateWindowTitle The title of the update window.
+ * @field growlUpdateInformation Text to display in the update window.
+ * @field referenceCount A count of owners of the delegate.
+ * @field retain Called when GrowlApplicationBridge receives this delegate.
+ * @field release Called when GrowlApplicationBridge no longer needs this delegate.
+ * @field growlIsReady Called when GrowlHelperApp is listening for notifications.
+ * @field growlNotificationWasClicked Called when a Growl notification is clicked.
+ * @field growlNotificationTimedOut Called when a Growl notification timed out.
+ */
+struct Growl_Delegate {
+ /* @discussion This should be sizeof(struct Growl_Delegate).
+ */
+ size_t size;
+
+ /*All of these attributes are optional.
+ *Optional attributes can be NULL; required attributes that
+ * are NULL cause setting the Growl delegate to fail.
+ *XXX - move optional/required status into the discussion for each field
+ */
+
+ /* This name is used both internally and in the Growl preferences.
+ *
+ * This should remain stable between different versions and incarnations of
+ * your application.
+ * For example, "SurfWriter" is a good app name, whereas "SurfWriter 2.0" and
+ * "SurfWriter Lite" are not.
+ *
+ * This can be <code>NULL</code> if it is provided elsewhere, namely in an
+ * auto-discoverable plist file in your app bundle
+ * (XXX refer to more information on that) or in registrationDictionary.
+ */
+ CFStringRef applicationName;
+
+ /*
+ * Must contain at least these keys:
+ * GROWL_NOTIFICATIONS_ALL (CFArray):
+ * Contains the names of all notifications your application may post.
+ *
+ * Can also contain these keys:
+ * GROWL_NOTIFICATIONS_DEFAULT (CFArray):
+ * Names of notifications that should be enabled by default.
+ * If omitted, GROWL_NOTIFICATIONS_ALL will be used.
+ * GROWL_APP_NAME (CFString):
+ * Same as the applicationName member of this structure.
+ * If both are present, the applicationName member shall prevail.
+ * If this key is present, you may omit applicationName (set it to <code>NULL</code>).
+ * GROWL_APP_ICON (CFData):
+ * Same as the iconData member of this structure.
+ * If both are present, the iconData member shall prevail.
+ * If this key is present, you may omit iconData (set it to <code>NULL</code>).
+ *
+ * If you change the contents of this dictionary after setting the delegate,
+ * be sure to call Growl_Reregister.
+ *
+ * This can be <code>NULL</code> if you have an auto-discoverable plist file in your app
+ * bundle. (XXX refer to more information on that)
+ */
+ CFDictionaryRef registrationDictionary;
+
+ /* The data can be in any format supported by NSImage. As of
+ * Mac OS X 10.3, this includes the .icns, TIFF, JPEG, GIF, PNG, PDF, and
+ * PICT formats.
+ *
+ * If this is not supplied, Growl will look up your application's icon by
+ * its application name.
+ */
+ CFDataRef applicationIconData;
+
+ /* Installer display attributes
+ *
+ * These four attributes are used by the Growl installer, if this framework
+ * supports it.
+ * For any of these being <code>NULL</code>, a localised default will be
+ * supplied.
+ */
+
+ /* If this is <code>NULL</code>, Growl will use a default,
+ * localized title.
+ *
+ * Only used if you're using Growl-WithInstaller.framework. Otherwise,
+ * this member is ignored.
+ */
+ CFStringRef growlInstallationWindowTitle;
+ /* This information may be as long or short as desired (the
+ * window will be sized to fit it). If Growl is not installed, 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 <code>NULL</code>, Growl will use a default, localized
+ * explanation.
+ *
+ * Only used if you're using Growl-WithInstaller.framework. Otherwise,
+ * this member is ignored.
+ */
+ CFStringRef growlInstallationInformation;
+ /* If this is <code>NULL</code>, Growl will use a default,
+ * localized title.
+ *
+ * Only used if you're using Growl-WithInstaller.framework. Otherwise,
+ * this member is ignored.
+ */
+ CFStringRef growlUpdateWindowTitle;
+ /* This information may be as long or short as desired (the
+ * window will be sized to fit it). If an older version of Growl is
+ * installed, 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 <code>NULL</code>, Growl will use a default, localized
+ * explanation.
+ *
+ * Only used if you're using Growl-WithInstaller.framework. Otherwise,
+ * this member is ignored.
+ */
+ CFStringRef growlUpdateInformation;
+
+ /* This member is provided for use by your retain and release
+ * callbacks (see below).
+ *
+ * GrowlApplicationBridge never directly uses this member. Instead, it
+ * calls your retain callback (if non-<code>NULL</code>) and your release
+ * callback (if non-<code>NULL</code>).
+ */
+ unsigned referenceCount;
+
+ //Functions. Currently all of these are optional (any of them can be NULL).
+
+ /* When you call Growl_SetDelegate(newDelegate), it will call
+ * oldDelegate->release(oldDelegate), and then it will call
+ * newDelegate->retain(newDelegate), and the return value from retain
+ * is what will be set as the delegate.
+ * (This means that this member works like CFRetain and -[NSObject retain].)
+ * This member is optional (it can be <code>NULL</code>).
+ * For a delegate allocated with malloc, this member would be
+ * <code>NULL</code>.
+ * @result A delegate to which GrowlApplicationBridge holds a reference.
+ */
+ void *(*retain)(void *);
+ /* When you call Growl_SetDelegate(newDelegate), it will call
+ * oldDelegate->release(oldDelegate), and then it will call
+ * newDelegate->retain(newDelegate), and the return value from retain
+ * is what will be set as the delegate.
+ * (This means that this member works like CFRelease and
+ * -[NSObject release].)
+ * This member is optional (it can be NULL).
+ * For a delegate allocated with malloc, this member might be
+ * <code>free</code>(3).
+ */
+ void (*release)(void *);
+
+ /* Informs the delegate that Growl (specifically, the GrowlHelperApp) was
+ * launched successfully (or was already running). The application can
+ * take actions with the knowledge that Growl is installed and functional.
+ */
+ void (*growlIsReady)(void);
+
+ /* Informs the delegate that a Growl notification was clicked. It is only
+ * sent for notifications sent with a non-<code>NULL</code> clickContext,
+ * so if you want to receive a message when a notification is clicked,
+ * clickContext must not be <code>NULL</code> when calling
+ * Growl_PostNotification or
+ * Growl_NotifyWithTitleDescriptionNameIconPriorityStickyClickContext.
+ */
+ void (*growlNotificationWasClicked)(CFPropertyListRef clickContext);
+
+ /* Informs the delegate that a Growl notification timed out. It is only
+ * sent for notifications sent with a non-<code>NULL</code> clickContext,
+ * so if you want to receive a message when a notification is clicked,
+ * clickContext must not be <code>NULL</code> when calling
+ * Growl_PostNotification or
+ * Growl_NotifyWithTitleDescriptionNameIconPriorityStickyClickContext.
+ */
+ void (*growlNotificationTimedOut)(CFPropertyListRef clickContext);
+};
+
+/*! @struct Growl_Notification
+ * @abstract Structure describing a Growl notification.
+ * @discussion XXX
+ * @field size The size of the notification structure.
+ * @field name Identifies the notification.
+ * @field title Short synopsis of the notification.
+ * @field description Additional text.
+ * @field iconData An icon for the notification.
+ * @field priority An indicator of the notification's importance.
+ * @field reserved Bits reserved for future usage.
+ * @field isSticky Requests that a notification stay on-screen until dismissed explicitly.
+ * @field clickContext An identifier to be passed to your click callback when a notification is clicked.
+ * @field clickCallback A callback to call when the notification is clicked.
+ */
+struct Growl_Notification {
+ /* This should be sizeof(struct Growl_Notification).
+ */
+ size_t size;
+
+ /* The notification name distinguishes one type of
+ * notification from another. The name should be human-readable, as it
+ * will be displayed in the Growl preference pane.
+ *
+ * The name is used in the GROWL_NOTIFICATIONS_ALL and
+ * GROWL_NOTIFICATIONS_DEFAULT arrays in the registration dictionary, and
+ * in this member of the Growl_Notification structure.
+ */
+ CFStringRef name;
+
+ /* A notification's title describes the notification briefly.
+ * It should be easy to read quickly by the user.
+ */
+ CFStringRef title;
+
+ /* The description supplements the title with more
+ * information. It is usually longer and sometimes involves a list of
+ * subjects. For example, for a 'Download complete' notification, the
+ * description might have one filename per line. GrowlMail in Growl 0.6
+ * uses a description of '%d new mail(s)' (formatted with the number of
+ * messages).
+ */
+ CFStringRef description;
+
+ /* The notification icon usually indicates either what
+ * happened (it may have the same icon as e.g. a toolbar item that
+ * started the process that led to the notification), or what it happened
+ * to (e.g. a document icon).
+ *
+ * The icon data is optional, so it can be <code>NULL</code>. In that
+ * case, the application icon is used alone. Not all displays support
+ * icons.
+ *
+ * The data can be in any format supported by NSImage. As of Mac OS X
+ * 10.3, this includes the .icns, TIFF, JPEG, GIF, PNG, PDF, and PICT form
+ * ats.
+ */
+ CFDataRef iconData;
+
+ /* Priority is new in Growl 0.6, and is represented as a
+ * signed integer from -2 to +2. 0 is Normal priority, -2 is Very Low
+ * priority, and +2 is Very High priority.
+ *
+ * Not all displays support priority. If you do not wish to assign a
+ * priority to your notification, assign 0.
+ */
+ signed int priority;
+
+ /* These bits are not used in Growl 0.6. Set them to 0.
+ */
+ unsigned reserved: 31;
+
+ /* When the sticky bit is clear, in most displays,
+ * notifications disappear after a certain amount of time. Sticky
+ * notifications, however, remain on-screen until the user dismisses them
+ * explicitly, usually by clicking them.
+ *
+ * Sticky notifications were introduced in Growl 0.6. Most notifications
+ * should not be sticky. Not all displays support sticky notifications,
+ * and the user may choose in Growl's preference pane to force the
+ * notification to be sticky or non-sticky, in which case the sticky bit
+ * in the notification will be ignored.
+ */
+ unsigned isSticky: 1;
+
+ /* If this is not <code>NULL</code>, and your click callback
+ * is not <code>NULL</code> either, this will be passed to the callback
+ * when your notification is clicked by the user.
+ *
+ * Click feedback was introduced in Growl 0.6, and it is optional. Not
+ * all displays support click feedback.
+ */
+ CFPropertyListRef clickContext;
+
+ /* If this is not <code>NULL</code>, it will be called instead
+ * of the Growl delegate's click callback when clickContext is
+ * non-<code>NULL</code> and the notification is clicked on by the user.
+ *
+ * Click feedback was introduced in Growl 0.6, and it is optional. Not
+ * all displays support click feedback.
+ *
+ * The per-notification click callback is not yet supported as of Growl
+ * 0.7.
+ */
+ void (*clickCallback)(CFPropertyListRef clickContext);
+
+ CFStringRef identifier;
+};
+
+#pragma mark -
+#pragma mark Easy initialisers
+
+/*! @defined InitGrowlDelegate
+ * @abstract Callable macro. Initializes a Growl delegate structure to defaults.
+ * @discussion Call with a pointer to a struct Growl_Delegate. All of the
+ * members of the structure will be set to 0 or <code>NULL</code>, except for
+ * size (which will be set to <code>sizeof(struct Growl_Delegate)</code>) and
+ * referenceCount (which will be set to 1).
+ */
+#define InitGrowlDelegate(delegate) \
+ do { \
+ if (delegate) { \
+ (delegate)->size = sizeof(struct Growl_Delegate); \
+ (delegate)->applicationName = NULL; \
+ (delegate)->registrationDictionary = NULL; \
+ (delegate)->applicationIconData = NULL; \
+ (delegate)->growlInstallationWindowTitle = NULL; \
+ (delegate)->growlInstallationInformation = NULL; \
+ (delegate)->growlUpdateWindowTitle = NULL; \
+ (delegate)->growlUpdateInformation = NULL; \
+ (delegate)->referenceCount = 1U; \
+ (delegate)->retain = NULL; \
+ (delegate)->release = NULL; \
+ (delegate)->growlIsReady = NULL; \
+ (delegate)->growlNotificationWasClicked = NULL; \
+ (delegate)->growlNotificationTimedOut = NULL; \
+ } \
+ } while(0)
+
+/*! @defined InitGrowlNotification
+ * @abstract Callable macro. Initializes a Growl notification structure to defaults.
+ * @discussion Call with a pointer to a struct Growl_Notification. All of
+ * the members of the structure will be set to 0 or <code>NULL</code>, except
+ * for size (which will be set to
+ * <code>sizeof(struct Growl_Notification)</code>).
+ */
+#define InitGrowlNotification(notification) \
+ do { \
+ if (notification) { \
+ (notification)->size = sizeof(struct Growl_Notification); \
+ (notification)->name = NULL; \
+ (notification)->title = NULL; \
+ (notification)->description = NULL; \
+ (notification)->iconData = NULL; \
+ (notification)->priority = 0; \
+ (notification)->reserved = 0U; \
+ (notification)->isSticky = false; \
+ (notification)->clickContext = NULL; \
+ (notification)->clickCallback = NULL; \
+ (notification)->identifier = NULL; \
+ } \
+ } while(0)
+
+#pragma mark -
+#pragma mark Public API
+
+// @functiongroup Managing the Growl delegate
+
+/*! @function Growl_SetDelegate
+ * @abstract Replaces the current Growl delegate with a new one, or removes
+ * the Growl delegate.
+ * @param newDelegate
+ * @result Returns false and does nothing else if a pointer that was passed in
+ * is unsatisfactory (because it is non-<code>NULL</code>, but at least one
+ * required member of it is <code>NULL</code>). Otherwise, sets or unsets the
+ * delegate and returns true.
+ * @discussion When <code>newDelegate</code> is non-<code>NULL</code>, sets
+ * the delegate to <code>newDelegate</code>. When it is <code>NULL</code>,
+ * the current delegate will be unset, and no delegate will be in place.
+ *
+ * It is legal for <code>newDelegate</code> to be the current delegate;
+ * nothing will happen, and Growl_SetDelegate will return true. It is also
+ * legal for it to be <code>NULL</code>, as described above; again, it will
+ * return true.
+ *
+ * If there was a delegate in place before the call, Growl_SetDelegate will
+ * call the old delegate's release member if it was non-<code>NULL</code>. If
+ * <code>newDelegate</code> is non-<code>NULL</code>, Growl_SetDelegate will
+ * call <code>newDelegate->retain</code>, and set the delegate to its return
+ * value.
+ *
+ * If you are using Growl-WithInstaller.framework, and an older version of
+ * Growl is installed on the user's system, the user will automatically be
+ * prompted to update.
+ *
+ * GrowlApplicationBridge currently does not copy this structure, nor does it
+ * retain any of the CF objects in the structure (it regards the structure as
+ * a container that retains the objects when they are added and releases them
+ * when they are removed or the structure is destroyed). Also,
+ * GrowlApplicationBridge currently does not modify any member of the
+ * structure, except possibly the referenceCount by calling the retain and
+ * release members.
+ */
+GROWL_EXPORT Boolean Growl_SetDelegate(struct Growl_Delegate *newDelegate);
+
+/*! @function Growl_GetDelegate
+ * @abstract Returns the current Growl delegate, if any.
+ * @result The current Growl delegate.
+ * @discussion Returns the last pointer passed into Growl_SetDelegate, or
+ * <code>NULL</code> if no such call has been made.
+ *
+ * This function follows standard Core Foundation reference-counting rules.
+ * Because it is a Get function, not a Copy function, it will not retain the
+ * delegate on your behalf. You are responsible for retaining and releasing
+ * the delegate as needed.
+ */
+GROWL_EXPORT struct Growl_Delegate *Growl_GetDelegate(void);
+
+#pragma mark -
+
+// @functiongroup Posting Growl notifications
+
+/*! @function Growl_PostNotification
+ * @abstract Posts a Growl notification.
+ * @param notification The notification to post.
+ * @discussion This is the preferred means for sending a Growl notification.
+ * The notification name and at least one of the title and description are
+ * required (all three are preferred). All other parameters may be
+ * <code>NULL</code> (or 0 or false as appropriate) to accept default values.
+ *
+ * If using the Growl-WithInstaller framework, if Growl is not installed the
+ * user will be prompted to install Growl.
+ * If the user cancels, this function will have no effect until the next
+ * application session, at which time when it is called the user will be
+ * prompted again. The user is also given the option to not be prompted again.
+ * If the user does choose to install Growl, the requested notification will
+ * be displayed once Growl is installed and running.
+ */
+GROWL_EXPORT void Growl_PostNotification(const struct Growl_Notification *notification);
+
+/*! @function Growl_PostNotificationWithDictionary
+* @abstract Notifies using a userInfo dictionary suitable for passing to
+* CFDistributedNotificationCenter.
+* @param userInfo The dictionary to notify with.
+* @discussion Before Growl 0.6, your application would have posted
+* notifications using CFDistributedNotificationCenter by creating a userInfo
+* dictionary with the notification data. This had the advantage of allowing
+* you to add other data to the dictionary for programs besides Growl that
+* might be listening.
+*
+* This function allows you to use such dictionaries without being restricted
+* to using CFDistributedNotificationCenter. The keys for this dictionary
+ * can be found in GrowlDefines.h.
+*/
+GROWL_EXPORT void Growl_PostNotificationWithDictionary(CFDictionaryRef userInfo);
+
+/*! @function Growl_NotifyWithTitleDescriptionNameIconPriorityStickyClickContext
+ * @abstract Posts a Growl notification using parameter values.
+ * @param title The title of the notification.
+ * @param description The description of the notification.
+ * @param notificationName The name of the notification as listed in the
+ * registration dictionary.
+ * @param iconData Data representing a notification icon. Can be <code>NULL</code>.
+ * @param priority The priority of the notification (-2 to +2, with -2
+ * being Very Low and +2 being Very High).
+ * @param isSticky If true, requests that this notification wait for a
+ * response from the user.
+ * @param clickContext An object to pass to the clickCallback, if any. Can
+ * be <code>NULL</code>, in which case the clickCallback is not called.
+ * @discussion Creates a temporary Growl_Notification, fills it out with the
+ * supplied information, and calls Growl_PostNotification on it.
+ * See struct Growl_Notification and Growl_PostNotification for more
+ * information.
+ *
+ * The icon data can be in any format supported by NSImage. As of Mac OS X
+ * 10.3, this includes the .icns, TIFF, JPEG, GIF, PNG, PDF, and PICT formats.
+ */
+GROWL_EXPORT void Growl_NotifyWithTitleDescriptionNameIconPriorityStickyClickContext(
+ /*inhale*/
+ CFStringRef title,
+ CFStringRef description,
+ CFStringRef notificationName,
+ CFDataRef iconData,
+ signed int priority,
+ Boolean isSticky,
+ CFPropertyListRef clickContext);
+
+#pragma mark -
+
+// @functiongroup Registering
+
+/*! @function Growl_RegisterWithDictionary
+ * @abstract Register your application with Growl without setting a delegate.
+ * @discussion When you call this function with a dictionary,
+ * GrowlApplicationBridge registers your application using that dictionary.
+ * If you pass <code>NULL</code>, GrowlApplicationBridge will ask the delegate
+ * (if there is one) for a dictionary, and if that doesn't work, it will look
+ * in your application's bundle for an auto-discoverable plist.
+ * (XXX refer to more information on that)
+ *
+ * If you pass a dictionary to this function, it must include the
+ * <code>GROWL_APP_NAME</code> key, unless a delegate is set.
+ *
+ * This function is mainly an alternative to the delegate system introduced
+ * with Growl 0.6. Without a delegate, you cannot receive callbacks such as
+ * <code>growlIsReady</code> (since they are sent to the delegate). You can,
+ * however, set a delegate after registering without one.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ * @result <code>false</code> if registration failed (e.g. if Growl isn't installed).
+ */
+GROWL_EXPORT Boolean Growl_RegisterWithDictionary(CFDictionaryRef regDict);
+
+/*! @function Growl_Reregister
+ * @abstract Updates your registration with Growl.
+ * @discussion If your application changes the contents of the
+ * GROWL_NOTIFICATIONS_ALL key in the registrationDictionary member of the
+ * Growl delegate, or if it changes the value of that member, or if it
+ * changes the contents of its auto-discoverable plist, call this function
+ * to have Growl update its registration information for your application.
+ *
+ * Otherwise, this function does not normally need to be called. If you're
+ * using a delegate, your application will be registered when you set the
+ * delegate if both the delegate and its registrationDictionary member are
+ * non-<code>NULL</code>.
+ *
+ * This function is now implemented using
+ * <code>Growl_RegisterWithDictionary</code>.
+ */
+GROWL_EXPORT void Growl_Reregister(void);
+
+#pragma mark -
+
+/*! @function Growl_SetWillRegisterWhenGrowlIsReady
+ * @abstract Tells GrowlApplicationBridge to register with Growl when Growl
+ * launches (or not).
+ * @discussion When Growl has started listening for notifications, it posts a
+ * <code>GROWL_IS_READY</code> notification on the Distributed Notification
+ * Center. GrowlApplicationBridge listens for this notification, using it to
+ * perform various tasks (such as calling your delegate's
+ * <code>growlIsReady</code> callback, if it has one). If this function is
+ * called with <code>true</code>, one of those tasks will be to reregister
+ * with Growl (in the manner of <code>Growl_Reregister</code>).
+ *
+ * This attribute is automatically set back to <code>false</code>
+ * (the default) after every <code>GROWL_IS_READY</code> notification.
+ * @param flag <code>true</code> if you want GrowlApplicationBridge to register with
+ * Growl when next it is ready; <code>false</code> if not.
+ */
+GROWL_EXPORT void Growl_SetWillRegisterWhenGrowlIsReady(Boolean flag);
+/*! @function Growl_WillRegisterWhenGrowlIsReady
+ * @abstract Reports whether GrowlApplicationBridge will register with Growl
+ * when Growl next launches.
+ * @result <code>true</code> if GrowlApplicationBridge will register with
+ * Growl when next it posts GROWL_IS_READY; <code>false</code> if not.
+ */
+GROWL_EXPORT Boolean Growl_WillRegisterWhenGrowlIsReady(void);
+
+#pragma mark -
+
+// @functiongroup Obtaining registration dictionaries
+
+/*! @function Growl_CopyRegistrationDictionaryFromDelegate
+ * @abstract Asks the delegate for a registration dictionary.
+ * @discussion If no delegate is set, or if the delegate's
+ * <code>registrationDictionary</code> member is <code>NULL</code>, this
+ * function returns <code>NULL</code>.
+ *
+ * This function does not attempt to clean up the dictionary in any way - for
+ * example, if it is missing the <code>GROWL_APP_NAME</code> key, the result
+ * will be missing it too. Use
+ * <code>Growl_CreateRegistrationDictionaryByFillingInDictionary</code> or
+ * <code>Growl_CreateRegistrationDictionaryByFillingInDictionaryRestrictedToKeys</code>
+ * to try to fill in missing keys.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CopyRegistrationDictionaryFromDelegate(void);
+
+/*! @function Growl_CopyRegistrationDictionaryFromBundle
+ * @abstract Looks in a bundle for a registration dictionary.
+ * @discussion This function looks in a bundle for an auto-discoverable
+ * registration dictionary file using <code>CFBundleCopyResourceURL</code>.
+ * If it finds one, it loads the file using <code>CFPropertyList</code> and
+ * returns the result.
+ *
+ * If you pass <code>NULL</code> as the bundle, the main bundle is examined.
+ *
+ * This function does not attempt to clean up the dictionary in any way - for
+ * example, if it is missing the <code>GROWL_APP_NAME</code> key, the result
+ * will be missing it too. Use
+ * <code>Growl_CreateRegistrationDictionaryByFillingInDictionary:</code> or
+ * <code>Growl_CreateRegistrationDictionaryByFillingInDictionaryRestrictedToKeys</code>
+ * to try to fill in missing keys.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CopyRegistrationDictionaryFromBundle(CFBundleRef bundle);
+
+/*! @function Growl_CreateBestRegistrationDictionary
+ * @abstract Obtains a registration dictionary, filled out to the best of
+ * GrowlApplicationBridge's knowledge.
+ * @discussion This function creates a registration dictionary as best
+ * GrowlApplicationBridge knows how.
+ *
+ * First, GrowlApplicationBridge examines the Growl delegate (if there is
+ * one) and gets the registration dictionary from that. If no such dictionary
+ * was obtained, GrowlApplicationBridge looks in your application's main
+ * bundle for an auto-discoverable registration dictionary file. If that
+ * doesn't exist either, this function returns <code>NULL</code>.
+ *
+ * Second, GrowlApplicationBridge calls
+ * <code>Growl_CreateRegistrationDictionaryByFillingInDictionary</code> with
+ * whatever dictionary was obtained. The result of that function is the
+ * result of this function.
+ *
+ * GrowlApplicationBridge uses this function when you call
+ * <code>Growl_SetDelegate</code>, or when you call
+ * <code>Growl_RegisterWithDictionary</code> with <code>NULL</code>.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CreateBestRegistrationDictionary(void);
+
+#pragma mark -
+
+// @functiongroup Filling in registration dictionaries
+
+/*! @function Growl_CreateRegistrationDictionaryByFillingInDictionary
+ * @abstract Tries to fill in missing keys in a registration dictionary.
+ * @param regDict The dictionary to fill in.
+ * @result The dictionary with the keys filled in.
+ * @discussion This function examines the passed-in dictionary for missing keys,
+ * and tries to work out correct values for them. As of 0.7, it uses:
+ *
+ * Key Value
+ * --- -----
+ * <code>GROWL_APP_NAME</code> <code>CFBundleExecutableName</code>
+ * <code>GROWL_APP_ICON</code> 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>
+ *
+ * Keys are only filled in if missing; if a key is present in the dictionary,
+ * its value will not be changed.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CreateRegistrationDictionaryByFillingInDictionary(CFDictionaryRef regDict);
+/*! @function Growl_CreateRegistrationDictionaryByFillingInDictionaryRestrictedToKeys
+ * @abstract Tries to fill in missing keys in a registration dictionary.
+ * @param regDict The dictionary to fill in.
+ * @param keys The keys to fill in. If <code>NULL</code>, any missing keys are filled in.
+ * @result The dictionary with the keys filled in.
+ * @discussion This function examines the passed-in dictionary for missing keys,
+ * and tries to work out correct values for them. As of 0.7, it uses:
+ *
+ * Key Value
+ * --- -----
+ * <code>GROWL_APP_NAME</code> <code>CFBundleExecutableName</code>
+ * <code>GROWL_APP_ICON</code> 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>
+ *
+ * Only those keys that are listed in <code>keys</code> will be filled in.
+ * Other missing keys are ignored. Also, keys are only filled in if missing;
+ * if a key is present in the dictionary, its value will not be changed.
+ *
+ * This function was introduced in Growl.framework 0.7.
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CreateRegistrationDictionaryByFillingInDictionaryRestrictedToKeys(CFDictionaryRef regDict, CFSetRef keys);
+
+/*! @brief Tries to fill in missing keys in a notification dictionary.
+ * @param notifDict The dictionary to fill in.
+ * @return The dictionary with the keys filled in. This will be a separate instance from \a notifDict.
+ * @discussion This function examines the \a notifDict for missing keys, and
+ * tries to get them from the last known registration dictionary. As of 1.1,
+ * the keys that it will look for are:
+ *
+ * \li <code>GROWL_APP_NAME</code>
+ * \li <code>GROWL_APP_ICON</code>
+ *
+ * @since Growl.framework 1.1
+ */
+GROWL_EXPORT CFDictionaryRef Growl_CreateNotificationDictionaryByFillingInDictionary(CFDictionaryRef notifDict);
+
+#pragma mark -
+
+// @functiongroup Querying Growl's status
+
+/*! @function Growl_IsInstalled
+ * @abstract Determines whether the Growl prefpane and its helper app are
+ * installed.
+ * @result Returns true if Growl is installed, false otherwise.
+ */
+GROWL_EXPORT Boolean Growl_IsInstalled(void);
+
+/*! @function Growl_IsRunning
+ * @abstract Cycles through the process list to find whether GrowlHelperApp
+ * is running.
+ * @result Returns true if Growl is running, false otherwise.
+ */
+GROWL_EXPORT Boolean Growl_IsRunning(void);
+
+#pragma mark -
+
+// @functiongroup Launching Growl
+
+/*! @typedef GrowlLaunchCallback
+ * @abstract Callback to notify you that Growl is running.
+ * @param context The context pointer passed to Growl_LaunchIfInstalled.
+ * @discussion Growl_LaunchIfInstalled calls this callback function if Growl
+ * was already running or if it launched Growl successfully.
+ */
+typedef void (*GrowlLaunchCallback)(void *context);
+
+/*! @function Growl_LaunchIfInstalled
+ * @abstract Launches GrowlHelperApp if it is not already running.
+ * @param callback A callback function which will be called if Growl was successfully
+ * launched or was already running. Can be <code>NULL</code>.
+ * @param context The context pointer to pass to the callback. Can be <code>NULL</code>.
+ * @result Returns true if Growl was successfully launched or was already
+ * running; returns false and does not call the callback otherwise.
+ * @discussion Returns true and calls the callback (if the callback is not
+ * <code>NULL</code>) if the Growl helper app began launching or was already
+ * running. Returns false and performs no other action if Growl could not be
+ * launched (e.g. because the Growl preference pane is not properly installed).
+ *
+ * If <code>Growl_CreateBestRegistrationDictionary</code> returns
+ * non-<code>NULL</code>, this function will register with Growl atomically.
+ *
+ * The callback should take a single argument; this is to allow applications
+ * to have context-relevant information passed back. It is perfectly
+ * acceptable for context to be <code>NULL</code>. The callback itself can be
+ * <code>NULL</code> if you don't want one.
+ */
+GROWL_EXPORT Boolean Growl_LaunchIfInstalled(GrowlLaunchCallback callback, void *context);
+
+#pragma mark -
+#pragma mark Constants
+
+/*! @defined GROWL_PREFPANE_BUNDLE_IDENTIFIER
+ * @abstract The CFBundleIdentifier of the Growl preference pane bundle.
+ * @discussion GrowlApplicationBridge uses this to determine whether Growl is
+ * currently installed, by searching for the Growl preference pane. Your
+ * application probably does not need to use this macro itself.
+ */
+#ifndef GROWL_PREFPANE_BUNDLE_IDENTIFIER
+#define GROWL_PREFPANE_BUNDLE_IDENTIFIER CFSTR("com.growl.prefpanel")
+#endif
+
+__END_DECLS
+
+#endif /* _GROWLAPPLICATIONBRIDGE_CARBON_H_ */
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge.h
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge.h (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlApplicationBridge.h 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,575 @@
+//
+// GrowlApplicationBridge.h
+// Growl
+//
+// Created by Evan Schoenberg on Wed Jun 16 2004.
+// Copyright 2004-2006 The Growl Project. All rights reserved.
+//
+
+/*!
+ * @header GrowlApplicationBridge.h
+ * @abstract Defines the GrowlApplicationBridge class.
+ * @discussion This header defines the GrowlApplicationBridge class as well as
+ * the GROWL_PREFPANE_BUNDLE_IDENTIFIER constant.
+ */
+
+#ifndef __GrowlApplicationBridge_h__
+#define __GrowlApplicationBridge_h__
+
+#import <Foundation/Foundation.h>
+#import <AppKit/AppKit.h>
+#import "GrowlDefines.h"
+
+//Forward declarations
+ at 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"
+
+//------------------------------------------------------------------------------
+#pragma mark -
+
+/*!
+ * @class GrowlApplicationBridge
+ * @abstract A class used to interface with Growl.
+ * @discussion This class provides a means to interface with Growl.
+ *
+ * Currently it provides a way to detect if Growl is installed and launch the
+ * GrowlHelperApp if it's not already running.
+ */
+ at interface GrowlApplicationBridge : NSObject {
+
+}
+
+/*!
+ * @method isGrowlInstalled
+ * @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;
+
+/*!
+ * @method isGrowlRunning
+ * @abstract Detects whether GrowlHelperApp is currently running.
+ * @discussion Cycles through the process list to find whether GrowlHelperApp is running and returns its findings.
+ * @result Returns YES if GrowlHelperApp is running, NO otherwise.
+ */
++ (BOOL) isGrowlRunning;
+
+#pragma mark -
+
+/*!
+ * @method setGrowlDelegate:
+ * @abstract Set the object which will be responsible for providing and receiving Growl information.
+ * @discussion This must be called before using GrowlApplicationBridge.
+ *
+ * The methods in the GrowlApplicationBridgeDelegate protocol are required
+ * and return the basic information needed to register with Growl.
+ *
+ * The methods in the GrowlApplicationBridgeDelegate_InformalProtocol
+ * informal protocol are individually optional. They provide a greater
+ * degree of interaction between the application and growl such as informing
+ * the application when one of its Growl notifications is clicked by the user.
+ *
+ * The methods in the GrowlApplicationBridgeDelegate_Installation_InformalProtocol
+ * informal protocol are individually optional and are only applicable when
+ * using the Growl-WithInstaller.framework which allows for automated Growl
+ * installation.
+ *
+ * When this method is called, data will be collected from inDelegate, Growl
+ * will be launched if it is not already running, and the application will be
+ * registered with Growl.
+ *
+ * If using the Growl-WithInstaller framework, if Growl is already installed
+ * but this copy of the framework has an updated version of Growl, the user
+ * will be prompted to update automatically.
+ *
+ * @param inDelegate The delegate for the GrowlApplicationBridge. It must conform to the GrowlApplicationBridgeDelegate protocol.
+ */
++ (void) setGrowlDelegate:(NSObject<GrowlApplicationBridgeDelegate> *)inDelegate;
+
+/*!
+ * @method growlDelegate
+ * @abstract Return the object responsible for providing and receiving Growl information.
+ * @discussion See setGrowlDelegate: for details.
+ * @result The Growl delegate.
+ */
++ (NSObject<GrowlApplicationBridgeDelegate> *) growlDelegate;
+
+#pragma mark -
+
+/*!
+ * @method notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:
+ * @abstract Send a Growl notification.
+ * @discussion This is the preferred means for sending a Growl notification.
+ * The notification name and at least one of the title and description are
+ * required (all three are preferred). All other parameters may be
+ * <code>nil</code> (or 0 or NO as appropriate) to accept default values.
+ *
+ * If using the Growl-WithInstaller framework, if Growl is not installed the
+ * user will be prompted to install Growl. If the user cancels, this method
+ * will have no effect until the next application session, at which time when
+ * it is called the user will be prompted again. The user is also given the
+ * option to not be prompted again. If the user does choose to install Growl,
+ * the requested notification will be displayed once Growl is installed and
+ * running.
+ *
+ * @param title The title of the notification displayed to the user.
+ * @param description The full description of the notification displayed to the user.
+ * @param notifName The internal name of the notification. Should be human-readable, as it will be displayed in the Growl preference pane.
+ * @param iconData <code>NSData</code> object to show with the notification as its icon. If <code>nil</code>, the application's icon will be used instead.
+ * @param priority The priority of the notification. The default value is 0; positive values are higher priority and negative values are lower priority. Not all Growl displays support priority.
+ * @param isSticky If YES, the notification will remain on screen until clicked. Not all Growl displays support sticky notifications.
+ * @param clickContext A context passed back to the Growl delegate if it implements -(void)growlNotificationWasClicked: and the notification is clicked. Not all display plugins support clicking. The clickContext must be plist-encodable (completely of <code>NSString</code>, <code>NSArray</code>, <code>NSNumber</code>, <code>NSDictionary</code>, and <code>NSData</code> types).
+ */
++ (void) notifyWithTitle:(NSString *)title
+ description:(NSString *)description
+ notificationName:(NSString *)notifName
+ iconData:(NSData *)iconData
+ priority:(signed int)priority
+ isSticky:(BOOL)isSticky
+ clickContext:(id)clickContext;
+
+/*!
+ * @method notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:identifier:
+ * @abstract Send a Growl notification.
+ * @discussion This is the preferred means for sending a Growl notification.
+ * The notification name and at least one of the title and description are
+ * required (all three are preferred). All other parameters may be
+ * <code>nil</code> (or 0 or NO as appropriate) to accept default values.
+ *
+ * If using the Growl-WithInstaller framework, if Growl is not installed the
+ * user will be prompted to install Growl. If the user cancels, this method
+ * will have no effect until the next application session, at which time when
+ * it is called the user will be prompted again. The user is also given the
+ * option to not be prompted again. If the user does choose to install Growl,
+ * the requested notification will be displayed once Growl is installed and
+ * running.
+ *
+ * @param title The title of the notification displayed to the user.
+ * @param description The full description of the notification displayed to the user.
+ * @param notifName The internal name of the notification. Should be human-readable, as it will be displayed in the Growl preference pane.
+ * @param iconData <code>NSData</code> object to show with the notification as its icon. If <code>nil</code>, the application's icon will be used instead.
+ * @param priority The priority of the notification. The default value is 0; positive values are higher priority and negative values are lower priority. Not all Growl displays support priority.
+ * @param isSticky If YES, the notification will remain on screen until clicked. Not all Growl displays support sticky notifications.
+ * @param clickContext A context passed back to the Growl delegate if it implements -(void)growlNotificationWasClicked: and the notification is clicked. Not all display plugins support clicking. The clickContext must be plist-encodable (completely of <code>NSString</code>, <code>NSArray</code>, <code>NSNumber</code>, <code>NSDictionary</code>, and <code>NSData</code> types).
+ * @param identifier An identifier for this notification. Notifications with equal identifiers are coalesced.
+ */
++ (void) notifyWithTitle:(NSString *)title
+ description:(NSString *)description
+ notificationName:(NSString *)notifName
+ iconData:(NSData *)iconData
+ priority:(signed int)priority
+ isSticky:(BOOL)isSticky
+ clickContext:(id)clickContext
+ identifier:(NSString *)identifier;
+
+/*! @method notifyWithDictionary:
+ * @abstract Notifies using a userInfo dictionary suitable for passing to
+ * <code>NSDistributedNotificationCenter</code>.
+ * @param userInfo The dictionary to notify with.
+ * @discussion Before Growl 0.6, your application would have posted
+ * notifications using <code>NSDistributedNotificationCenter</code> by
+ * creating a userInfo dictionary with the notification data. This had the
+ * advantage of allowing you to add other data to the dictionary for programs
+ * besides Growl that might be listening.
+ *
+ * This method allows you to use such dictionaries without being restricted
+ * to using <code>NSDistributedNotificationCenter</code>. The keys for this dictionary
+ * can be found in GrowlDefines.h.
+ */
++ (void) notifyWithDictionary:(NSDictionary *)userInfo;
+
+#pragma mark -
+
+/*! @method registerWithDictionary:
+ * @abstract Register your application with Growl without setting a delegate.
+ * @discussion When you call this method with a dictionary,
+ * GrowlApplicationBridge registers your application using that dictionary.
+ * If you pass <code>nil</code>, GrowlApplicationBridge will ask the delegate
+ * (if there is one) for a dictionary, and if that doesn't work, it will look
+ * in your application's bundle for an auto-discoverable plist.
+ * (XXX refer to more information on that)
+ *
+ * If you pass a dictionary to this method, it must include the
+ * <code>GROWL_APP_NAME</code> key, unless a delegate is set.
+ *
+ * This method is mainly an alternative to the delegate system introduced
+ * with Growl 0.6. Without a delegate, you cannot receive callbacks such as
+ * <code>-growlIsReady</code> (since they are sent to the delegate). You can,
+ * however, set a delegate after registering without one.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ */
++ (BOOL) registerWithDictionary:(NSDictionary *)regDict;
+
+/*! @method reregisterGrowlNotifications
+ * @abstract Reregister the notifications for this application.
+ * @discussion This method does not normally need to be called. If your
+ * application changes what notifications it is registering with Growl, call
+ * this method to have the Growl delegate's
+ * <code>-registrationDictionaryForGrowl</code> method called again and the
+ * Growl registration information updated.
+ *
+ * This method is now implemented using <code>-registerWithDictionary:</code>.
+ */
++ (void) reregisterGrowlNotifications;
+
+#pragma mark -
+
+/*! @method setWillRegisterWhenGrowlIsReady:
+ * @abstract Tells GrowlApplicationBridge to register with Growl when Growl
+ * launches (or not).
+ * @discussion When Growl has started listening for notifications, it posts a
+ * <code>GROWL_IS_READY</code> notification on the Distributed Notification
+ * Center. GrowlApplicationBridge listens for this notification, using it to
+ * perform various tasks (such as calling your delegate's
+ * <code>-growlIsReady</code> method, if it has one). If this method is
+ * called with <code>YES</code>, one of those tasks will be to reregister
+ * with Growl (in the manner of <code>-reregisterGrowlNotifications</code>).
+ *
+ * This attribute is automatically set back to <code>NO</code> (the default)
+ * after every <code>GROWL_IS_READY</code> notification.
+ * @param flag <code>YES</code> if you want GrowlApplicationBridge to register with
+ * Growl when next it is ready; <code>NO</code> if not.
+ */
++ (void) setWillRegisterWhenGrowlIsReady:(BOOL)flag;
+/*! @method willRegisterWhenGrowlIsReady
+ * @abstract Reports whether GrowlApplicationBridge will register with Growl
+ * when Growl next launches.
+ * @result <code>YES</code> if GrowlApplicationBridge will register with Growl
+ * when next it posts GROWL_IS_READY; <code>NO</code> if not.
+ */
++ (BOOL) willRegisterWhenGrowlIsReady;
+
+#pragma mark -
+
+/*! @method registrationDictionaryFromDelegate
+ * @abstract Asks the delegate for a registration dictionary.
+ * @discussion If no delegate is set, or if the delegate's
+ * <code>-registrationDictionaryForGrowl</code> method returns
+ * <code>nil</code>, this method returns <code>nil</code>.
+ *
+ * This method does not attempt to clean up the dictionary in any way - for
+ * example, if it is missing the <code>GROWL_APP_NAME</code> key, the result
+ * will be missing it too. Use <code>+[GrowlApplicationBridge
+ * registrationDictionaryByFillingInDictionary:]</code> or
+ * <code>+[GrowlApplicationBridge
+ * registrationDictionaryByFillingInDictionary:restrictToKeys:]</code> to try
+ * to fill in missing keys.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
++ (NSDictionary *) registrationDictionaryFromDelegate;
+
+/*! @method registrationDictionaryFromBundle:
+ * @abstract Looks in a bundle for a registration dictionary.
+ * @discussion This method looks in a bundle for an auto-discoverable
+ * registration dictionary file using <code>-[NSBundle
+ * pathForResource:ofType:]</code>. If it finds one, it loads the file using
+ * <code>+[NSDictionary dictionaryWithContentsOfFile:]</code> and returns the
+ * result.
+ *
+ * If you pass <code>nil</code> as the bundle, the main bundle is examined.
+ *
+ * This method does not attempt to clean up the dictionary in any way - for
+ * example, if it is missing the <code>GROWL_APP_NAME</code> key, the result
+ * will be missing it too. Use <code>+[GrowlApplicationBridge
+ * registrationDictionaryByFillingInDictionary:]</code> or
+ * <code>+[GrowlApplicationBridge
+ * registrationDictionaryByFillingInDictionary:restrictToKeys:]</code> to try
+ * to fill in missing keys.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
++ (NSDictionary *) registrationDictionaryFromBundle:(NSBundle *)bundle;
+
+/*! @method bestRegistrationDictionary
+ * @abstract Obtains a registration dictionary, filled out to the best of
+ * GrowlApplicationBridge's knowledge.
+ * @discussion This method creates a registration dictionary as best
+ * GrowlApplicationBridge knows how.
+ *
+ * First, GrowlApplicationBridge contacts the Growl delegate (if there is
+ * one) and gets the registration dictionary from that. If no such dictionary
+ * was obtained, GrowlApplicationBridge looks in your application's main
+ * bundle for an auto-discoverable registration dictionary file. If that
+ * doesn't exist either, this method returns <code>nil</code>.
+ *
+ * Second, GrowlApplicationBridge calls
+ * <code>+registrationDictionaryByFillingInDictionary:</code> with whatever
+ * dictionary was obtained. The result of that method is the result of this
+ * method.
+ *
+ * GrowlApplicationBridge uses this method when you call
+ * <code>+setGrowlDelegate:</code>, or when you call
+ * <code>+registerWithDictionary:</code> with <code>nil</code>.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ * @result A registration dictionary.
+ */
++ (NSDictionary *) bestRegistrationDictionary;
+
+#pragma mark -
+
+/*! @method registrationDictionaryByFillingInDictionary:
+ * @abstract Tries to fill in missing keys in a registration dictionary.
+ * @discussion This method examines the passed-in dictionary for missing keys,
+ * and tries to work out correct values for them. As of 0.7, it uses:
+ *
+ * Key Value
+ * --- -----
+ * <code>GROWL_APP_NAME</code> <code>CFBundleExecutableName</code>
+ * <code>GROWL_APP_ICON</code> 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>
+ *
+ * Keys are only filled in if missing; if a key is present in the dictionary,
+ * its value will not be changed.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ * @param regDict The dictionary to fill in.
+ * @result The dictionary with the keys filled in. This is an autoreleased
+ * copy of <code>regDict</code>.
+ */
++ (NSDictionary *) registrationDictionaryByFillingInDictionary:(NSDictionary *)regDict;
+/*! @method registrationDictionaryByFillingInDictionary:restrictToKeys:
+ * @abstract Tries to fill in missing keys in a registration dictionary.
+ * @discussion This method examines the passed-in dictionary for missing keys,
+ * and tries to work out correct values for them. As of 0.7, it uses:
+ *
+ * Key Value
+ * --- -----
+ * <code>GROWL_APP_NAME</code> <code>CFBundleExecutableName</code>
+ * <code>GROWL_APP_ICON</code> 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>
+ *
+ * Only those keys that are listed in <code>keys</code> will be filled in.
+ * Other missing keys are ignored. Also, keys are only filled in if missing;
+ * if a key is present in the dictionary, its value will not be changed.
+ *
+ * This method was introduced in Growl.framework 0.7.
+ * @param regDict The dictionary to fill in.
+ * @param keys The keys to fill in. If <code>nil</code>, any missing keys are filled in.
+ * @result The dictionary with the keys filled in. This is an autoreleased
+ * copy of <code>regDict</code>.
+ */
++ (NSDictionary *) registrationDictionaryByFillingInDictionary:(NSDictionary *)regDict restrictToKeys:(NSSet *)keys;
+
+/*! @brief Tries to fill in missing keys in a notification dictionary.
+ * @param notifDict The dictionary to fill in.
+ * @return The dictionary with the keys filled in. This will be a separate instance from \a notifDict.
+ * @discussion This function examines the \a notifDict for missing keys, and
+ * tries to get them from the last known registration dictionary. As of 1.1,
+ * the keys that it will look for are:
+ *
+ * \li <code>GROWL_APP_NAME</code>
+ * \li <code>GROWL_APP_ICON</code>
+ *
+ * @since Growl.framework 1.1
+ */
++ (NSDictionary *) notificationDictionaryByFillingInDictionary:(NSDictionary *)regDict;
+
++ (NSDictionary *) frameworkInfoDictionary;
+ at end
+
+//------------------------------------------------------------------------------
+#pragma mark -
+
+/*!
+ * @protocol GrowlApplicationBridgeDelegate
+ * @abstract Required protocol for the Growl delegate.
+ * @discussion The methods in this protocol are required and are called
+ * automatically as needed by GrowlApplicationBridge. See
+ * <code>+[GrowlApplicationBridge setGrowlDelegate:]</code>.
+ * See also <code>GrowlApplicationBridgeDelegate_InformalProtocol</code>.
+ */
+
+ at protocol GrowlApplicationBridgeDelegate
+
+// -registrationDictionaryForGrowl has moved to the informal protocol as of 0.7.
+
+ at end
+
+//------------------------------------------------------------------------------
+#pragma mark -
+
+/*!
+ * @category NSObject(GrowlApplicationBridgeDelegate_InformalProtocol)
+ * @abstract Methods which may be optionally implemented by the GrowlDelegate.
+ * @discussion The methods in this informal protocol will only be called if implemented by the delegate.
+ */
+ at interface NSObject (GrowlApplicationBridgeDelegate_InformalProtocol)
+
+/*!
+ * @method registrationDictionaryForGrowl
+ * @abstract Return the dictionary used to register this application with Growl.
+ * @discussion The returned dictionary gives Growl the complete list of
+ * notifications this application will ever send, and it also specifies which
+ * notifications should be enabled by default. Each is specified by an array
+ * of <code>NSString</code> objects.
+ *
+ * For most applications, these two arrays can be the same (if all sent
+ * notifications should be displayed by default).
+ *
+ * The <code>NSString</code> objects of these arrays will correspond to the
+ * <code>notificationName:</code> parameter passed in
+ * <code>+[GrowlApplicationBridge
+ * notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:]</code> calls.
+ *
+ * The dictionary should have the required key object pairs:
+ * key: GROWL_NOTIFICATIONS_ALL object: <code>NSArray</code> of <code>NSString</code> objects
+ * key: GROWL_NOTIFICATIONS_DEFAULT object: <code>NSArray</code> of <code>NSString</code> objects
+ *
+ * The dictionary may have the following key object pairs:
+ * key: GROWL_NOTIFICATIONS_HUMAN_READABLE_NAMES object: <code>NSDictionary</code> of key: notification name object: human-readable notification name
+ *
+ * You do not need to implement this method if you have an auto-discoverable
+ * plist file in your app bundle. (XXX refer to more information on that)
+ *
+ * @result The <code>NSDictionary</code> to use for registration.
+ */
+- (NSDictionary *) registrationDictionaryForGrowl;
+
+/*!
+ * @method applicationNameForGrowl
+ * @abstract Return the name of this application which will be used for Growl bookkeeping.
+ * @discussion This name is used both internally and in the Growl preferences.
+ *
+ * This should remain stable between different versions and incarnations of
+ * your application.
+ * For example, "SurfWriter" is a good app name, whereas "SurfWriter 2.0" and
+ * "SurfWriter Lite" are not.
+ *
+ * You do not need to implement this method if you are providing the
+ * application name elsewhere, meaning in an auto-discoverable plist file in
+ * your app bundle (XXX refer to more information on that) or in the result
+ * of -registrationDictionaryForGrowl.
+ *
+ * @result The name of the application using Growl.
+ */
+- (NSString *) applicationNameForGrowl;
+
+/*!
+ * @method applicationIconForGrowl
+ * @abstract Return the <code>NSImage</code> to treat as the application icon.
+ * @discussion The delegate may optionally return an <code>NSImage</code>
+ * object to use as the application icon. If this method is not implemented,
+ * {{{-applicationIconDataForGrowl}}} is tried. If that method is not
+ * implemented, the application's own icon is used. Neither method is
+ * generally needed.
+ * @result The <code>NSImage</code> to treat as the application icon.
+ */
+- (NSImage *) applicationIconForGrowl;
+
+/*!
+ * @method applicationIconDataForGrowl
+ * @abstract Return the <code>NSData</code> to treat as the application icon.
+ * @discussion The delegate may optionally return an <code>NSData</code>
+ * object to use as the application icon; if this is not implemented, the
+ * application's own icon is used. This is not generally needed.
+ * @result The <code>NSData</code> to treat as the application icon.
+ * @deprecated In version 1.1, in favor of {{{-applicationIconForGrowl}}}.
+ */
+- (NSData *) applicationIconDataForGrowl;
+
+/*!
+ * @method growlIsReady
+ * @abstract Informs the delegate that Growl has launched.
+ * @discussion Informs the delegate that Growl (specifically, the
+ * GrowlHelperApp) was launched successfully. The application can take actions
+ * with the knowledge that Growl is installed and functional.
+ */
+- (void) growlIsReady;
+
+/*!
+ * @method growlNotificationWasClicked:
+ * @abstract Informs the delegate that a Growl notification was clicked.
+ * @discussion Informs the delegate that a Growl notification was clicked. It
+ * is only sent for notifications sent with a non-<code>nil</code>
+ * clickContext, so if you want to receive a message when a notification is
+ * clicked, clickContext must not be <code>nil</code> when calling
+ * <code>+[GrowlApplicationBridge notifyWithTitle: description:notificationName:iconData:priority:isSticky:clickContext:]</code>.
+ * @param clickContext The clickContext passed when displaying the notification originally via +[GrowlApplicationBridge notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:].
+ */
+- (void) growlNotificationWasClicked:(id)clickContext;
+
+/*!
+ * @method growlNotificationTimedOut:
+ * @abstract Informs the delegate that a Growl notification timed out.
+ * @discussion Informs the delegate that a Growl notification timed out. It
+ * is only sent for notifications sent with a non-<code>nil</code>
+ * clickContext, so if you want to receive a message when a notification is
+ * clicked, clickContext must not be <code>nil</code> when calling
+ * <code>+[GrowlApplicationBridge notifyWithTitle: description:notificationName:iconData:priority:isSticky:clickContext:]</code>.
+ * @param clickContext The clickContext passed when displaying the notification originally via +[GrowlApplicationBridge notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:].
+ */
+- (void) growlNotificationTimedOut:(id)clickContext;
+
+ at 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.
+ */
+ at 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;
+
+ at end
+
+//private
+ at interface GrowlApplicationBridge (GrowlInstallationPrompt_private)
++ (void) _userChoseNotToInstallGrowl;
+ at end
+
+#endif /* __GrowlApplicationBridge_h__ */
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlDefines.h
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlDefines.h (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Headers/GrowlDefines.h 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,348 @@
+//
+// GrowlDefines.h
+//
+
+#ifndef _GROWLDEFINES_H
+#define _GROWLDEFINES_H
+
+#ifdef __OBJC__
+#define XSTR(x) (@x)
+#define STRING_TYPE NSString *
+#else
+#define XSTR CFSTR
+#define STRING_TYPE CFStringRef
+#endif
+
+/*! @header GrowlDefines.h
+ * @abstract Defines all the notification keys.
+ * @discussion Defines all the keys used for registration with Growl and for
+ * Growl notifications.
+ *
+ * Most applications should use the functions or methods of Growl.framework
+ * instead of posting notifications such as those described here.
+ * @updated 2004-01-25
+ */
+
+// UserInfo Keys for Registration
+#pragma mark UserInfo Keys for Registration
+
+/*! @group Registration userInfo keys */
+/* @abstract Keys for the userInfo dictionary of a GROWL_APP_REGISTRATION distributed notification.
+ * @discussion The values of these keys describe the application and the
+ * notifications it may post.
+ *
+ * Your application must register with Growl before it can post Growl
+ * notifications (and have them not be ignored). However, as of Growl 0.6,
+ * posting GROWL_APP_REGISTRATION notifications directly is no longer the
+ * preferred way to register your application. Your application should instead
+ * use Growl.framework's delegate system.
+ * See +[GrowlApplicationBridge setGrowlDelegate:] or Growl_SetDelegate for
+ * more information.
+ */
+
+/*! @defined GROWL_APP_NAME
+ * @abstract The name of your application.
+ * @discussion The name of your application. This should remain stable between
+ * different versions and incarnations of your application.
+ * For example, "SurfWriter" is a good app name, whereas "SurfWriter 2.0" and
+ * "SurfWriter Lite" are not.
+ */
+#define GROWL_APP_NAME XSTR("ApplicationName")
+/*! @defined GROWL_APP_ID
+ * @abstract The bundle identifier of your application.
+ * @discussion The bundle identifier of your application. This key should
+ * be unique for your application while there may be several applications
+ * with the same GROWL_APP_NAME.
+ * This key is optional.
+ */
+#define GROWL_APP_ID XSTR("ApplicationId")
+/*! @defined GROWL_APP_ICON
+ * @abstract The image data for your application's icon.
+ * @discussion Image data representing your application's icon. This may be
+ * superimposed on a notification icon as a badge, used as the notification
+ * icon when a notification-specific icon is not supplied, or ignored
+ * altogether, depending on the display. 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_APP_ICON XSTR("ApplicationIcon")
+/*! @defined GROWL_NOTIFICATIONS_DEFAULT
+ * @abstract The array of notifications to turn on by default.
+ * @discussion These are the names of the notifications that should be enabled
+ * by default when your application registers for the first time. If your
+ * application reregisters, Growl will look here for any new notification
+ * names found in GROWL_NOTIFICATIONS_ALL, but ignore any others.
+ */
+#define GROWL_NOTIFICATIONS_DEFAULT XSTR("DefaultNotifications")
+/*! @defined GROWL_NOTIFICATIONS_ALL
+ * @abstract The array of all notifications your application can send.
+ * @discussion These are the names of all of the notifications that your
+ * application may post. See GROWL_NOTIFICATION_NAME for a discussion of good
+ * notification names.
+ */
+#define GROWL_NOTIFICATIONS_ALL XSTR("AllNotifications")
+/*! @defined GROWL_NOTIFICATIONS_HUMAN_READABLE_DESCRIPTIONS
+ * @abstract A dictionary of human-readable names for your notifications.
+ * @discussion By default, the Growl UI will display notifications by the names given in GROWL_NOTIFICATIONS_ALL
+ * which correspond to the GROWL_NOTIFICATION_NAME. This dictionary specifies the human-readable name to display.
+ * The keys of the dictionary are GROWL_NOTIFICATION_NAME strings; the objects are the human-readable versions.
+ * For any GROWL_NOTIFICATION_NAME not specific in this dictionary, the GROWL_NOTIFICATION_NAME will be displayed.
+ *
+ * This key is optional.
+ */
+#define GROWL_NOTIFICATIONS_HUMAN_READABLE_NAMES XSTR("HumanReadableNames")
+/*! @defined GROWL_NOTIFICATIONS_DESCRIPTIONS
+* @abstract A dictionary of descriptions of _when_ each notification occurs
+* @discussion This is an NSDictionary whose keys are GROWL_NOTIFICATION_NAME strings and whose objects are
+* descriptions of _when_ each notification occurs, such as "You received a new mail message" or
+* "A file finished downloading".
+*
+* This key is optional.
+*/
+#define GROWL_NOTIFICATIONS_DESCRIPTIONS XSTR("NotificationDescriptions")
+
+/*! @defined GROWL_TICKET_VERSION
+ * @abstract The version of your registration ticket.
+ * @discussion Include this key in a ticket plist file that you put in your
+ * application bundle for auto-discovery. The current ticket version is 1.
+ */
+#define GROWL_TICKET_VERSION XSTR("TicketVersion")
+// UserInfo Keys for Notifications
+#pragma mark UserInfo Keys for Notifications
+
+/*! @group Notification userInfo keys */
+/* @abstract Keys for the userInfo dictionary of a GROWL_NOTIFICATION distributed notification.
+ * @discussion The values of these keys describe the content of a Growl
+ * notification.
+ *
+ * Not all of these keys are supported by all displays. Only the name, title,
+ * and description of a notification are universal. Most of the built-in
+ * displays do support all of these keys, and most other visual displays
+ * probably will also. But, as of 0.6, the Log, MailMe, and Speech displays
+ * support only textual data.
+ */
+
+/*! @defined GROWL_NOTIFICATION_NAME
+ * @abstract The name of the notification.
+ * @discussion The name of the notification. Note that if you do not define
+ * GROWL_NOTIFICATIONS_HUMAN_READABLE_NAMES when registering your ticket originally this name
+ * will the one displayed within the Growl preference pane and should be human-readable.
+ */
+#define GROWL_NOTIFICATION_NAME XSTR("NotificationName")
+/*! @defined GROWL_NOTIFICATION_TITLE
+ * @abstract The title to display in the notification.
+ * @discussion The title of the notification. Should be very brief.
+ * The title usually says what happened, e.g. "Download complete".
+ */
+#define GROWL_NOTIFICATION_TITLE XSTR("NotificationTitle")
+/*! @defined GROWL_NOTIFICATION_DESCRIPTION
+ * @abstract The description to display in the notification.
+ * @discussion The description should be longer and more verbose than the title.
+ * The description usually tells the subject of the action,
+ * e.g. "Growl-0.6.dmg downloaded in 5.02 minutes".
+ */
+#define GROWL_NOTIFICATION_DESCRIPTION XSTR("NotificationDescription")
+/*! @defined GROWL_NOTIFICATION_ICON
+ * @discussion Image data for the notification icon. 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")
+/*! @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
+ * as TIFF, PNG, GIF, JPEG, BMP, PICT, or PDF.
+ *
+ * Optional. Not supported by all display plugins.
+ */
+#define GROWL_NOTIFICATION_APP_ICON XSTR("NotificationAppIcon")
+/*! @defined GROWL_NOTIFICATION_PRIORITY
+ * @discussion The priority of the notification as an integer number from
+ * -2 to +2 (+2 being highest).
+ *
+ * Optional. Not supported by all display plugins.
+ */
+#define GROWL_NOTIFICATION_PRIORITY XSTR("NotificationPriority")
+/*! @defined GROWL_NOTIFICATION_STICKY
+ * @discussion A Boolean number controlling whether the notification is sticky.
+ *
+ * Optional. Not supported by all display plugins.
+ */
+#define GROWL_NOTIFICATION_STICKY XSTR("NotificationSticky")
+/*! @defined GROWL_NOTIFICATION_CLICK_CONTEXT
+ * @abstract Identifies which notification was clicked.
+ * @discussion An identifier for the notification for clicking purposes.
+ *
+ * This will be passed back to the application when the notification is
+ * clicked. It must be plist-encodable (a data, dictionary, array, number, or
+ * string object), and it should be unique for each notification you post.
+ * A good click context would be a UUID string returned by NSProcessInfo or
+ * CFUUID.
+ *
+ * Optional. Not supported by all display plugins.
+ */
+#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
+ * @abstract An identifier for the notification for coalescing purposes.
+ * Notifications with the same identifier fall into the same class; only
+ * the last notification of a class is displayed on the screen. If a
+ * notification of the same class is currently being displayed, it is
+ * replaced by this notification.
+ *
+ * Optional. Not supported by all display plugins.
+ */
+#define GROWL_NOTIFICATION_IDENTIFIER XSTR("GrowlNotificationIdentifier")
+
+/*! @defined GROWL_APP_PID
+ * @abstract The process identifier of the process which sends this
+ * notification. If this field is set, the application will only receive
+ * clicked and timed out notifications which originate from this process.
+ *
+ * Optional.
+ */
+#define GROWL_APP_PID XSTR("ApplicationPID")
+
+/*! @defined GROWL_NOTIFICATION_PROGRESS
+* @abstract If this key is set, it should contain a double value wrapped
+* in a NSNumber which describes some sort of progress (from 0.0 to 100.0).
+* If this is key is not set, no progress bar is shown.
+*
+* Optional. Not supported by all display plugins.
+*/
+#define GROWL_NOTIFICATION_PROGRESS XSTR("NotificationProgress")
+
+// Notifications
+#pragma mark Notifications
+
+/*! @group Notification names */
+/* @abstract Names of distributed notifications used by Growl.
+ * @discussion These are notifications used by applications (directly or
+ * indirectly) to interact with Growl, and by Growl for interaction between
+ * its components.
+ *
+ * Most of these should no longer be used in Growl 0.6 and later, in favor of
+ * Growl.framework's GrowlApplicationBridge APIs.
+ */
+
+/*! @defined GROWL_APP_REGISTRATION
+ * @abstract The distributed notification for registering your application.
+ * @discussion This is the name of the distributed notification that can be
+ * used to register applications with Growl.
+ *
+ * The userInfo dictionary for this notification can contain these keys:
+ * <ul>
+ * <li>GROWL_APP_NAME</li>
+ * <li>GROWL_APP_ICON</li>
+ * <li>GROWL_NOTIFICATIONS_ALL</li>
+ * <li>GROWL_NOTIFICATIONS_DEFAULT</li>
+ * </ul>
+ *
+ * No longer recommended as of Growl 0.6. An alternate method of registering
+ * is to use Growl.framework's delegate system.
+ * See +[GrowlApplicationBridge setGrowlDelegate:] or Growl_SetDelegate for
+ * more information.
+ */
+#define GROWL_APP_REGISTRATION XSTR("GrowlApplicationRegistrationNotification")
+/*! @defined GROWL_APP_REGISTRATION_CONF
+ * @abstract The distributed notification for confirming registration.
+ * @discussion The name of the distributed notification sent to confirm the
+ * registration. Used by the Growl preference pane. Your application probably
+ * does not need to use this notification.
+ */
+#define GROWL_APP_REGISTRATION_CONF XSTR("GrowlApplicationRegistrationConfirmationNotification")
+/*! @defined GROWL_NOTIFICATION
+ * @abstract The distributed notification for Growl notifications.
+ * @discussion This is what it all comes down to. This is the name of the
+ * distributed notification that your application posts to actually send a
+ * Growl notification.
+ *
+ * The userInfo dictionary for this notification can contain these keys:
+ * <ul>
+ * <li>GROWL_NOTIFICATION_NAME (required)</li>
+ * <li>GROWL_NOTIFICATION_TITLE (required)</li>
+ * <li>GROWL_NOTIFICATION_DESCRIPTION (required)</li>
+ * <li>GROWL_NOTIFICATION_ICON</li>
+ * <li>GROWL_NOTIFICATION_APP_ICON</li>
+ * <li>GROWL_NOTIFICATION_PRIORITY</li>
+ * <li>GROWL_NOTIFICATION_STICKY</li>
+ * <li>GROWL_NOTIFICATION_CLICK_CONTEXT</li>
+ * <li>GROWL_APP_NAME (required)</li>
+ * </ul>
+ *
+ * No longer recommended as of Growl 0.6. Three alternate methods of posting
+ * notifications are +[GrowlApplicationBridge notifyWithTitle:description:notificationName:iconData:priority:isSticky:clickContext:],
+ * Growl_NotifyWithTitleDescriptionNameIconPriorityStickyClickContext, and
+ * Growl_PostNotification.
+ */
+#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.
+ * @discussion This is used by the Growl preference pane. If it receives a
+ * GROWL_PONG, the preference pane takes this to mean that Growl is running.
+ */
+#define GROWL_PING XSTR("Honey, Mind Taking Out The Trash")
+/*! @defined GROWL_PONG
+ * @abstract The distributed notification sent in reply to GROWL_PING.
+ * @discussion GrowlHelperApp posts this in reply to GROWL_PING.
+ */
+#define GROWL_PONG XSTR("What Do You Want From Me, Woman")
+/*! @defined GROWL_IS_READY
+ * @abstract The distributed notification sent when Growl starts up.
+ * @discussion GrowlHelperApp posts this when it has begin listening on all of
+ * its sources for new notifications. GrowlApplicationBridge (in
+ * Growl.framework), upon receiving this notification, reregisters using the
+ * registration dictionary supplied by its delegate.
+ */
+#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.
+ * @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!")
+
+/*! @group Other symbols */
+/* Symbols which don't fit into any of the other categories. */
+
+/*! @defined GROWL_KEY_CLICKED_CONTEXT
+ * @abstract Used internally as the key for the clickedContext passed over DNC.
+ * @discussion This key is used in GROWL_NOTIFICATION_CLICKED, and contains the
+ * click context that was supplied in the original notification.
+ */
+#define GROWL_KEY_CLICKED_CONTEXT XSTR("ClickedContext")
+/*! @defined GROWL_REG_DICT_EXTENSION
+ * @abstract The filename extension for registration dictionaries.
+ * @discussion The GrowlApplicationBridge in Growl.framework registers with
+ * Growl by creating a file with the extension of .(GROWL_REG_DICT_EXTENSION)
+ * and opening it in the GrowlHelperApp. This happens whether or not Growl is
+ * running; if it was stopped, it quits immediately without listening for
+ * notifications.
+ */
+#define GROWL_REG_DICT_EXTENSION XSTR("growlRegDict")
+
+
+#define GROWL_POSITION_PREFERENCE_KEY @"GrowlSelectedPosition"
+
+#endif //ndef _GROWLDEFINES_H
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Resources/Info.plist
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Resources/Info.plist (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/A/Resources/Info.plist 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+ <key>CFBundleDevelopmentRegion</key>
+ <string>English</string>
+ <key>CFBundleExecutable</key>
+ <string>Growl</string>
+ <key>CFBundleIdentifier</key>
+ <string>com.growl.growlframework</string>
+ <key>CFBundleInfoDictionaryVersion</key>
+ <string>6.0</string>
+ <key>CFBundlePackageType</key>
+ <string>FMWK</string>
+ <key>CFBundleShortVersionString</key>
+ <string>1.2.1</string>
+ <key>CFBundleSignature</key>
+ <string>GRRR</string>
+ <key>CFBundleVersion</key>
+ <string>1.2.1</string>
+ <key>NSPrincipalClass</key>
+ <string>GrowlApplicationBridge</string>
+</dict>
+</plist>
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/Current
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/Current (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/Current 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1 @@
+link A
\ No newline at end of file
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework/Versions/Current
___________________________________________________________________
Added: svn:special
+ *
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Info.plist
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Info.plist (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Info.plist 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+ <dict>
+ <key>CFBundleDevelopmentRegion</key>
+ <string>English</string>
+ <key>CFBundleIdentifier</key>
+ <string>com.apple.xcode.dsym.com.growl.growlframework</string>
+ <key>CFBundleInfoDictionaryVersion</key>
+ <string>6.0</string>
+ <key>CFBundlePackageType</key>
+ <string>dSYM</string>
+ <key>CFBundleSignature</key>
+ <string>????</string>
+ <key>CFBundleShortVersionString</key>
+ <string>1.2.1</string>
+ <key>CFBundleVersion</key>
+ <string>1.2.1</string>
+ </dict>
+</plist>
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Resources/DWARF/Growl
===================================================================
(Binary files differ)
Property changes on: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/Growl.framework.dSYM/Contents/Resources/DWARF/Growl
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/License.txt
===================================================================
--- branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/License.txt (rev 0)
+++ branches/gsoc10-gui/Pallet/Growl-1.2.1-Framework/License.txt 2010-05-20 10:57:08 UTC (rev 67869)
@@ -0,0 +1,15 @@
+Copyright (c) The Growl Project, 2004-2009
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+3. Neither the name of Growl nor the names of its contributors
+ may be used to endorse or promote products derived from this software
+ without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Modified: branches/gsoc10-gui/Pallet/Pallet.xcodeproj/project.pbxproj
===================================================================
--- branches/gsoc10-gui/Pallet/Pallet.xcodeproj/project.pbxproj 2010-05-20 10:02:55 UTC (rev 67868)
+++ branches/gsoc10-gui/Pallet/Pallet.xcodeproj/project.pbxproj 2010-05-20 10:57:08 UTC (rev 67869)
@@ -21,6 +21,8 @@
/* End PBXAggregateTarget section */
/* Begin PBXBuildFile section */
+ 1D4B877F11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict in Resources */ = {isa = PBXBuildFile; fileRef = 1D4B877E11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict */; };
+ 1D4B878011A5498200AD9D33 /* Growl Registration Ticket.growlRegDict in Resources */ = {isa = PBXBuildFile; fileRef = 1D4B877E11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict */; };
1DDD58160DA1D0A300B32029 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 1DDD58140DA1D0A300B32029 /* MainMenu.xib */; };
2105F5091028ACBA00A28D1A /* ActivityController.m in Sources */ = {isa = PBXBuildFile; fileRef = 2105F5081028ACBA00A28D1A /* ActivityController.m */; };
21351FB30FEC67780074ACFE /* MPActionsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 21351FB20FEC67780074ACFE /* MPActionsController.m */; };
@@ -147,6 +149,7 @@
089C165DFE840E0CC02AAC07 /* English */ = {isa = PBXFileReference; fileEncoding = 10; lastKnownFileType = text.plist.strings; name = English; path = English.lproj/InfoPlist.strings; sourceTree = "<group>"; };
1058C7A1FEA54F0111CA2CBB /* Cocoa.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Cocoa.framework; path = /System/Library/Frameworks/Cocoa.framework; sourceTree = "<absolute>"; };
13E42FB307B3F0F600E4EEF1 /* CoreData.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreData.framework; path = /System/Library/Frameworks/CoreData.framework; sourceTree = "<absolute>"; };
+ 1D4B877E11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = "Growl Registration Ticket.growlRegDict"; sourceTree = "<group>"; };
1DDD58150DA1D0A300B32029 /* English */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = English; path = English.lproj/MainMenu.xib; sourceTree = "<group>"; };
2105F5071028ACBA00A28D1A /* ActivityController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ActivityController.h; sourceTree = "<group>"; };
2105F5081028ACBA00A28D1A /* ActivityController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ActivityController.m; sourceTree = "<group>"; };
@@ -326,6 +329,7 @@
089C165CFE840E0CC02AAC07 /* InfoPlist.strings */,
1DDD58140DA1D0A300B32029 /* MainMenu.xib */,
21E2ADAF1002E428003F8885 /* Preferences.xib */,
+ 1D4B877E11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict */,
);
name = Resources;
sourceTree = "<group>";
@@ -476,6 +480,7 @@
21900DD01095001700ED79CF /* TB_Cancel.icns in Resources */,
21900DD11095001700ED79CF /* TB_Selfupdate.icns in Resources */,
21900DD21095001700ED79CF /* Application.icns in Resources */,
+ 1D4B877F11A5496B00AD9D33 /* Growl Registration Ticket.growlRegDict in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
@@ -483,6 +488,7 @@
isa = PBXResourcesBuildPhase;
buildActionMask = 2147483647;
files = (
+ 1D4B878011A5498200AD9D33 /* Growl Registration Ticket.growlRegDict in Resources */,
8D11072B0486CEB800E47090 /* InfoPlist.strings in Resources */,
1DDD58160DA1D0A300B32029 /* MainMenu.xib in Resources */,
21FC226D0FE88A2A00B1E835 /* Installed.tiff in Resources */,
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20100520/db9d2196/attachment-0001.html>
More information about the macports-changes
mailing list