Growler

Setup

To set Growler up for use in your project, you need to configure it to build with the Growl framework, then just add the following files to your project:

• Growler.h
• Growler.m
• GrowlerGrowl.h
• GrowlerGrowl.m

Then define BUNDLE_IDENTIFIER in your precompiled header to be your CFBundleIdentifier (e.g. no.devsoft.GrowlerTests). For an example, check out Tests/GrowlerTests-Prefix.pch.

Growler has only been tested with Growl 1.2.x and above.

For instructions on setting up Growl in your project, see the official page on Implementing Growl, under the "Including and linking against the Growl framework" header.

Using

To Growl from any source file, you need the following at the start of the file:

#import "Growler.h"

When you want to notify the user, you need to define what the Growl should contain, with one of the following four constructors:

myGrowl = [GrowlerGrowl growl];
myGrowl = [GrowlerGrowl growlWithName:@"Operation completed"];
myGrowl = [GrowlerGrowl growlWithName:@"Operation completed"
                                title:@"Operation completed!"
                          description:@"The upload operation completed successfully"];
myGrowl = [GrowlerGrowl growlErrorWithTitle:@"Operation failed"
                                description:@"Could not complete the upload"];

You can customize the growl with the following attributes:

[myGrowl setTitle:@"Operation completed"];
[myGrowl setDescription:@"The upload operation completed successfully"];
[myGrowl setNotificationName:@"Operation completed"]; // Default: @"Default"

/* This is the default for growlErrorWithTitle:description:
 * For the other constructors, it's nil.
 */
[myGrowl setIcon:[NSImage imageNamed:NSImageNameCaution]];

/* Valid values are:
 *   GrowlVeryLowPriority
 *   GrowlModeratePriority
 *   GrowlNormalPriority (Default)
 *   GrowlHighPriority
 *   GrowlEmergencyPriority (Default for growlErrorWithTitle:description:)
 */
[myGrowl setPriority:GrowlNormalPriority];

[myGrowl setSticky:NO]; // Default: NO

Then you can display your Growl using one of two ways, depending on if you care about user input or not:

/* Either fire and forget with no user callback. */
[Growler growl:myGrowl];

/* Or call the given block when the Growl disappears or is clicked. */
[Growler growl:myGrowl
     withBlock:^(GrowlerGrowlAction action) {
         if (action == GrowlerGrowlClicked) {
             [myObject doSomethingInResponseToClick];
         } else if (action == GrowlerGrowlIgnored) {
             [myObject cancelOperation];
         }
     }];

Use one of those two approaches, not both.