Declared these methods in the @interface and documented them. Silences several warnings, and hopefully averts future confusion about the name of one of them.
authorPeter Hosey <hg@boredzo.org>
Fri Oct 02 20:11:40 2009 -0700 (11 months ago)
changeset 44692bbcdf4afbcd
parent 4468407bc8b2faf3
child 447037889e96cb40
Declared these methods in the @interface and documented them. Silences several warnings, and hopefully averts future confusion about the name of one of them.
Extras/GrowlMail/GrowlMailNotifier.h
     1.1 --- a/Extras/GrowlMail/GrowlMailNotifier.h	Fri Oct 02 20:02:34 2009 -0700
     1.2 +++ b/Extras/GrowlMail/GrowlMailNotifier.h	Fri Oct 02 20:11:40 2009 -0700
     1.3 @@ -87,6 +87,21 @@
     1.4   */
     1.5  - (void) setAccount:(MailAccount *)account enabled:(BOOL)yesOrNo;
     1.6  
     1.7 +/*!	@brief	Determine whether the notifier only notifies while the app is in the background.
     1.8 + *
     1.9 + *	This getter is backed by a user default. <code>configureForBackgroundOnly:</code> is <em>not</em> its inverse, as it does not set the user default.
    1.10 + *
    1.11 + *	@return	\c YES if this object will only notify while the application is in the background; \c NO if it will notify whether the app is in the background or not.
    1.12 + */
    1.13 +- (BOOL) isBackgroundOnlyEnabled;
    1.14 +/*!	@brief	Tell the notifier to update its notification registrations for suspend/resume events.
    1.15 + *
    1.16 + *	This method does not set the user default that backs \c isBackgroundOnlyEnabled, so it is not that method's inverse.
    1.17 + *
    1.18 + *	@param	enabled	\c YES if this object should only notify while the application is in the background; \c NO if it should notify whether the app is in the background or not.
    1.19 + */
    1.20 +- (void) configureForBackgroundOnly:(BOOL)enabled;
    1.21 +
    1.22  - (NSString *) applicationNameForGrowl;
    1.23  - (NSImage *) applicationIconForGrowl;
    1.24  - (void) growlNotificationWasClicked:(NSString *)clickContext;