A documentation tweak on ITStatusItem.
[ITKit.git] / ITStatusItem.h
1 /*
2  *      ITKit
3  *  ITStatusItem
4  *    NSStatusItem subclass which reduces suckage
5  *
6  *  Original Author : Joseph Spiros <joseph.spiros@ithinksw.com>
7  *   Responsibility : Matt Judy <mjudy@ithinksw.com>
8  *   Responsibility : Joseph Spiros <joseph.spiros@ithinksw.com>
9  *
10  *  Copyright (c) 2002 iThink Software.
11  *  All Rights Reserved
12  *
13  */
14
15 /*
16  *      This subclass does 3 things:
17  *
18  *  1. Makes the status item smarter about highlighting.
19  *  2. Allows you to set an inverted (alternate) image.
20  *  3. Eliminates the pre-Jaguar shadow behind a normal status item.
21  *
22  *  Note:  In order to have the shadow not overlap the bottom of the
23  *  menubar, Apple moves the image up one pixel.  Since that shadow is
24  *  no longer drawn, please adjust your images DOWN one pixel to compensate.
25  *
26  */
27
28 #import <Cocoa/Cocoa.h>
29
30
31 @interface ITStatusItem : NSStatusItem
32 {
33 }
34
35 // Use this to create a new retained status item.
36 // It will appear in the system status bar, and
37 // default to YES for its highlightMode.
38 - (id)initWithStatusBar:(NSStatusBar*)statusBar withLength:(float)length;
39
40 // These allow you to use an alternate (selected) image for your status item.
41 - (NSImage*) alternateImage;
42 - (void) setAlternateImage:(NSImage*)image;
43
44 @end