Minor UI change.
[pithos-macos] / pithos-macos / ImageAndTextCell.m
1 /*
2      File: ImageAndTextCell.m 
3  Abstract: Subclass of NSTextFieldCell which can display text and an image simultaneously.
4   
5   Version: 1.1 
6   
7  Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple 
8  Inc. ("Apple") in consideration of your agreement to the following 
9  terms, and your use, installation, modification or redistribution of 
10  this Apple software constitutes acceptance of these terms.  If you do 
11  not agree with these terms, please do not use, install, modify or 
12  redistribute this Apple software. 
13   
14  In consideration of your agreement to abide by the following terms, and 
15  subject to these terms, Apple grants you a personal, non-exclusive 
16  license, under Apple's copyrights in this original Apple software (the 
17  "Apple Software"), to use, reproduce, modify and redistribute the Apple 
18  Software, with or without modifications, in source and/or binary forms; 
19  provided that if you redistribute the Apple Software in its entirety and 
20  without modifications, you must retain this notice and the following 
21  text and disclaimers in all such redistributions of the Apple Software. 
22  Neither the name, trademarks, service marks or logos of Apple Inc. may 
23  be used to endorse or promote products derived from the Apple Software 
24  without specific prior written permission from Apple.  Except as 
25  expressly stated in this notice, no other rights or licenses, express or 
26  implied, are granted by Apple herein, including but not limited to any 
27  patent rights that may be infringed by your derivative works or by other 
28  works in which the Apple Software may be incorporated. 
29   
30  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE 
31  MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION 
32  THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS 
33  FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND 
34  OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. 
35   
36  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL 
37  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
38  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
39  INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, 
40  MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED 
41  AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), 
42  STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE 
43  POSSIBILITY OF SUCH DAMAGE. 
44   
45  Copyright (C) 2010 Apple Inc. All Rights Reserved. 
46   
47  */
48
49 #import "ImageAndTextCell.h"
50 //#import "BaseNode.h"
51
52 @implementation ImageAndTextCell
53
54 #define kIconImageSize          16.0
55
56 #define kImageOriginXOffset 3
57 #define kImageOriginYOffset 1
58
59 #define kTextOriginXOffset      2
60 #define kTextOriginYOffset      2
61 #define kTextHeightAdjust       4
62
63 // -------------------------------------------------------------------------------
64 //      init:
65 // -------------------------------------------------------------------------------
66 - (id)init
67 {
68         self = [super init];
69         
70         // we want a smaller font
71         [self setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
72
73         return self;
74 }
75
76 // -------------------------------------------------------------------------------
77 //      dealloc:
78 // -------------------------------------------------------------------------------
79 - (void)dealloc
80 {
81     [image release];
82     image = nil;
83     [super dealloc];
84 }
85
86 // -------------------------------------------------------------------------------
87 //      copyWithZone:zone
88 // -------------------------------------------------------------------------------
89 - (id)copyWithZone:(NSZone*)zone
90 {
91     ImageAndTextCell *cell = (ImageAndTextCell*)[super copyWithZone:zone];
92     cell->image = [image retain];
93     return cell;
94 }
95
96 // -------------------------------------------------------------------------------
97 //      setImage:anImage
98 // -------------------------------------------------------------------------------
99 - (void)setImage:(NSImage*)anImage
100 {
101     if (anImage != image)
102         {
103         [image release];
104         image = [anImage retain];
105                 [image setSize:NSMakeSize(kIconImageSize, kIconImageSize)];
106     }
107 }
108
109 // -------------------------------------------------------------------------------
110 //      image:
111 // -------------------------------------------------------------------------------
112 - (NSImage*)image
113 {
114     return image;
115 }
116
117 // -------------------------------------------------------------------------------
118 //      isGroupCell:
119 // -------------------------------------------------------------------------------
120 - (BOOL)isGroupCell
121 {
122     return ([self image] == nil && [[self title] length] > 0);
123 }
124
125 // -------------------------------------------------------------------------------
126 //      titleRectForBounds:cellRect
127 //
128 //      Returns the proper bound for the cell's title while being edited
129 // -------------------------------------------------------------------------------
130 - (NSRect)titleRectForBounds:(NSRect)cellRect
131 {       
132         // the cell has an image: draw the normal item cell
133         NSSize imageSize;
134         NSRect imageFrame;
135
136         imageSize = [image size];
137         NSDivideRect(cellRect, &imageFrame, &cellRect, 3 + imageSize.width, NSMinXEdge);
138
139         imageFrame.origin.x += kImageOriginXOffset;
140         imageFrame.origin.y -= kImageOriginYOffset;
141         imageFrame.size = imageSize;
142         
143         imageFrame.origin.y += ceil((cellRect.size.height - imageFrame.size.height) / 2);
144         
145         NSRect newFrame = cellRect;
146         newFrame.origin.x += kTextOriginXOffset;
147         newFrame.origin.y += kTextOriginYOffset;
148         newFrame.size.height -= kTextHeightAdjust;
149
150         return newFrame;
151 }
152
153 // -------------------------------------------------------------------------------
154 //      editWithFrame:inView:editor:delegate:event
155 // -------------------------------------------------------------------------------
156 - (void)editWithFrame:(NSRect)aRect inView:(NSView*)controlView editor:(NSText*)textObj delegate:(id)anObject event:(NSEvent*)theEvent
157 {
158         NSRect textFrame = [self titleRectForBounds:aRect];
159         [super editWithFrame:textFrame inView:controlView editor:textObj delegate:anObject event:theEvent];
160 }
161
162 // -------------------------------------------------------------------------------
163 //      selectWithFrame:inView:editor:delegate:event:start:length
164 // -------------------------------------------------------------------------------
165 - (void)selectWithFrame:(NSRect)aRect inView:(NSView *)controlView editor:(NSText *)textObj delegate:(id)anObject start:(NSInteger)selStart length:(NSInteger)selLength
166 {
167         NSRect textFrame = [self titleRectForBounds:aRect];
168         [super selectWithFrame:textFrame inView:controlView editor:textObj delegate:anObject start:selStart length:selLength];
169 }
170
171 // -------------------------------------------------------------------------------
172 //      drawWithFrame:cellFrame:controlView:
173 // -------------------------------------------------------------------------------
174 - (void)drawWithFrame:(NSRect)cellFrame inView:(NSView*)controlView
175 {
176         if (image != nil)
177         {
178                 // the cell has an image: draw the normal item cell
179                 NSSize imageSize;
180         NSRect imageFrame;
181
182         imageSize = [image size];
183         NSDivideRect(cellFrame, &imageFrame, &cellFrame, 3 + imageSize.width, NSMinXEdge);
184  
185         imageFrame.origin.x += kImageOriginXOffset;
186                 imageFrame.origin.y -= kImageOriginYOffset;
187         imageFrame.size = imageSize;
188                 
189         if ([controlView isFlipped])
190             imageFrame.origin.y += ceil((cellFrame.size.height + imageFrame.size.height) / 2);
191         else
192             imageFrame.origin.y += ceil((cellFrame.size.height - imageFrame.size.height) / 2);
193                 [image compositeToPoint:imageFrame.origin operation:NSCompositeSourceOver];
194
195                 NSRect newFrame = cellFrame;
196                 newFrame.origin.x += kTextOriginXOffset;
197                 newFrame.origin.y += kTextOriginYOffset;
198                 newFrame.size.height -= kTextHeightAdjust;
199                 [super drawWithFrame:newFrame inView:controlView];
200     }
201         else
202         {
203                 if ([self isGroupCell])
204                 {
205                         // Center the text in the cellFrame, and call super to do thew ork of actually drawing. 
206                         CGFloat yOffset = floor((NSHeight(cellFrame) - [[self attributedStringValue] size].height) / 2.0);
207                         cellFrame.origin.y += yOffset;
208                         cellFrame.size.height -= (kTextOriginYOffset*yOffset);
209                         [super drawWithFrame:cellFrame inView:controlView];
210                 }
211         }
212 }
213
214 // -------------------------------------------------------------------------------
215 //      cellSize:
216 // -------------------------------------------------------------------------------
217 - (NSSize)cellSize
218 {
219     NSSize cellSize = [super cellSize];
220     cellSize.width += (image ? [image size].width : 0) + 3;
221     return cellSize;
222 }
223
224 // -------------------------------------------------------------------------------
225 //      hitTestForEvent:
226 //
227 //      In 10.5, we need you to implement this method for blocking drag and drop of a given cell.
228 //      So NSCell hit testing will determine if a row can be dragged or not.
229 //
230 //      NSTableView calls this cell method when starting a drag, if the hit cell returns
231 //      NSCellHitTrackableArea, the particular row will be tracked instead of dragged.
232 //
233 // -------------------------------------------------------------------------------
234 //- (NSUInteger)hitTestForEvent:(NSEvent *)event inRect:(NSRect)cellFrame ofView:(NSView *)controlView
235 //{
236 //      NSInteger result = NSCellHitContentArea;
237 //      
238 //      NSOutlineView* hostingOutlineView = (NSOutlineView*)[self controlView];
239 //      if (hostingOutlineView)
240 //      {
241 //              NSInteger selectedRow = [hostingOutlineView selectedRow];
242 //              BaseNode* node = [[hostingOutlineView itemAtRow:selectedRow] representedObject];
243 //
244 //              if (![node isDraggable])        // is the node isDraggable (i.e. non-file system based objects)
245 //                      result = NSCellHitTrackableArea;
246 //      }
247 //              
248 //      return result;
249 //}
250
251 @end
252