third_party/apple_sample_code/ImageAndTextCell.m

   1 /*
   2  File: ImageAndTextCell.m
   3  Abstract: Subclass of NSTextFieldCell which can display text and an image simultaneously.
   4  Version: 1.0
   5
   6  Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
   7  Inc. ("Apple") in consideration of your agreement to the following
   8  terms, and your use, installation, modification or redistribution of
   9  this Apple software constitutes acceptance of these terms.  If you do
  10  not agree with these terms, please do not use, install, modify or
  11  redistribute this Apple software.
  12
  13  In consideration of your agreement to abide by the following terms, and
  14  subject to these terms, Apple grants you a personal, non-exclusive
  15  license, under Apple's copyrights in this original Apple software (the
  16  "Apple Software"), to use, reproduce, modify and redistribute the Apple
  17  Software, with or without modifications, in source and/or binary forms;
  18  provided that if you redistribute the Apple Software in its entirety and
  19  without modifications, you must retain this notice and the following
  20  text and disclaimers in all such redistributions of the Apple Software.
  21  Neither the name, trademarks, service marks or logos of Apple Inc. may
  22  be used to endorse or promote products derived from the Apple Software
  23  without specific prior written permission from Apple.  Except as
  24  expressly stated in this notice, no other rights or licenses, express or
  25  implied, are granted by Apple herein, including but not limited to any
  26  patent rights that may be infringed by your derivative works or by other
  27  works in which the Apple Software may be incorporated.
  28
  29  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
  30  MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
  31  THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
  32  FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
  33  OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
  34
  35  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
  36  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  37  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  38  INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
  39  MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
  40  AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
  41  STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
  42  POSSIBILITY OF SUCH DAMAGE.
  43
  44  Copyright (C) 2009 Apple Inc. All Rights Reserved.
  45
  46  */
  47
  48
  49 #import "ImageAndTextCell.h"
  50 #import <AppKit/NSCell.h>
  51
  52 @implementation ImageAndTextCell
  53
  54 @synthesize image;
  55
  56 - (id)init {
  57   if ((self = [super init])) {
  58     [self setLineBreakMode:NSLineBreakByTruncatingTail];
  59     [self setSelectable:YES];
  60   }
  61   return self;
  62 }
  63
  64 - (void)dealloc {
  65   [image release];
  66   [super dealloc];
  67 }
  68
  69 - (id)copyWithZone:(NSZone *)zone {
  70   ImageAndTextCell *cell = (ImageAndTextCell *)[super copyWithZone:zone];
  71   // The image ivar will be directly copied; we need to retain or copy it.
  72   cell->image = [image retain];
  73   return cell;
  74 }
  75
  76 - (NSRect)imageRectForBounds:(NSRect)cellFrame {
  77   NSRect result;
  78   if (image != nil) {
  79     result.size = [image size];
  80     result.origin = cellFrame.origin;
  81     result.origin.x += 3;
  82     result.origin.y += ceil((cellFrame.size.height - result.size.height) / 2);
  83   } else {
  84     result = NSZeroRect;
  85   }
  86   return result;
  87 }
  88
  89 // We could manually implement expansionFrameWithFrame:inView: and drawWithExpansionFrame:inView: or just properly implement titleRectForBounds to get expansion tooltips to automatically work for us
  90 - (NSRect)titleRectForBounds:(NSRect)cellFrame {
  91   NSRect result;
  92   if (image != nil) {
  93     CGFloat imageWidth = [image size].width;
  94     result = cellFrame;
  95     result.origin.x += (3 + imageWidth);
  96     result.size.width -= (3 + imageWidth);
  97   } else {
  98     result = [super titleRectForBounds:cellFrame];
  99   }
 100   return result;
 101 }
 102
 103 - (void)editWithFrame:(NSRect)aRect inView:(NSView *)controlView editor:(NSText *)textObj delegate:(id)anObject event:(NSEvent *)theEvent {
 104   NSRect textFrame, imageFrame;
 105   NSDivideRect (aRect, &imageFrame, &textFrame, 3 + [image size].width, NSMinXEdge);
 106   [super editWithFrame: textFrame inView: controlView editor:textObj delegate:anObject event: theEvent];
 107 }
 108
 109 - (void)selectWithFrame:(NSRect)aRect inView:(NSView *)controlView editor:(NSText *)textObj delegate:(id)anObject start:(NSInteger)selStart length:(NSInteger)selLength {
 110   NSRect textFrame, imageFrame;
 111   NSDivideRect (aRect, &imageFrame, &textFrame, 3 + [image size].width, NSMinXEdge);
 112   [super selectWithFrame: textFrame inView: controlView editor:textObj delegate:anObject start:selStart length:selLength];
 113 }
 114
 115 - (void)drawWithFrame:(NSRect)cellFrame inView:(NSView *)controlView {
 116   if (image != nil) {
 117     NSRect imageFrame;
 118     NSSize imageSize = [image size];
 119     NSDivideRect(cellFrame, &imageFrame, &cellFrame, 3 + imageSize.width, NSMinXEdge);
 120     if ([self drawsBackground]) {
 121       [[self backgroundColor] set];
 122       NSRectFill(imageFrame);
 123     }
 124     imageFrame.origin.x += 3;
 125     imageFrame.origin.y += ceil((cellFrame.size.height - imageSize.height) / 2);
 126     imageFrame.size = imageSize;
 127
 128     [image drawInRect:imageFrame
 129              fromRect:NSZeroRect
 130             operation:NSCompositeSourceOver
 131              fraction:1.0
 132        respectFlipped:YES
 133                 hints:nil];
 134   }
 135   [super drawWithFrame:cellFrame inView:controlView];
 136 }
 137
 138 - (NSSize)cellSize {
 139   NSSize cellSize = [super cellSize];
 140   if (image != nil) {
 141     cellSize.width += [image size].width;
 142   }
 143   cellSize.width += 3;
 144   return cellSize;
 145 }
 146
 147 - (NSUInteger)hitTestForEvent:(NSEvent *)event inRect:(NSRect)cellFrame ofView:(NSView *)controlView {
 148   NSPoint point = [controlView convertPoint:[event locationInWindow] fromView:nil];
 149   // If we have an image, we need to see if the user clicked on the image portion.
 150   if (image != nil) {
 151     // This code closely mimics drawWithFrame:inView:
 152     NSSize imageSize = [image size];
 153     NSRect imageFrame;
 154     NSDivideRect(cellFrame, &imageFrame, &cellFrame, 3 + imageSize.width, NSMinXEdge);
 155
 156     imageFrame.origin.x += 3;
 157     imageFrame.size = imageSize;
 158     // If the point is in the image rect, then it is a content hit
 159     if (NSMouseInRect(point, imageFrame, [controlView isFlipped])) {
 160       // We consider this just a content area. It is not trackable, nor it it editable text. If it was, we would or in the additional items.
 161       // By returning the correct parts, we allow NSTableView to correctly begin an edit when the text portion is clicked on.
 162       return NSCellHitContentArea;
 163     }
 164   }
 165   // At this point, the cellFrame has been modified to exclude the portion for the image. Let the superclass handle the hit testing at this point.
 166   return [super hitTestForEvent:event inRect:cellFrame ofView:controlView];
 167 }
 168
 169
 170 @end
 171