From: Matthew Judy <mjudy@ithinksw.com>
Date: Sat, 7 Dec 2002 16:12:27 +0000 (+0000)
Subject: One last tweak on ITStatusItem.
X-Git-Tag: v0.1~87
X-Git-Url: http://git.ithinksw.org/ITKit.git/commitdiff_plain/49f87ce455a122b803c4c30a17b94d61868551bf

One last tweak on ITStatusItem.
---

diff --git a/ITStatusItem.h b/ITStatusItem.h
index 2824f9b..d8dcf51 100755
--- a/ITStatusItem.h
+++ b/ITStatusItem.h
@@ -12,6 +12,20 @@
  *
  */
 
+/*
+ *	This subclass does 3 things:
+ *
+ *  1. Makes the status item smarter about highlighting.
+ *  2. Allows you to set an inverted (alternate) image.
+ *  3. Eliminates the ugly shadow behind a normal status item.
+ *
+ *  Note:  In order to have the shadow not suck, Apple moves the
+ *         image up one pixel.  We have chosen not to address this
+ *         here, so please adjust your images DOWN one pixel to
+ *         compensate for this.
+ *
+ */
+
 #import <Cocoa/Cocoa.h>
 
 
@@ -19,8 +33,12 @@
 {
 }
 
+// Use this to create a new retained status item.
+// It will appear in the system status bar, and
+// default to YES for its highlightMode.
 - (id)initWithStatusBar:(NSStatusBar*)statusBar withLength:(float)length;
 
+// These allow you to use an alternate (selected) image for your status item.
 - (NSImage*) alternateImage;
 - (void) setAlternateImage:(NSImage*)image;