home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1995 August / NEBULA.bin / SourceCode / MiscKit1.2.6 / Examples / DragViewTest / MiscIconWell.m < prev    next >
Encoding:
Text File  |  1994-06-17  |  8.2 KB  |  328 lines
  1. /***************************************************************************
  2.  * CLASS:        MiscIconWell
  3.  *
  4.  *    See the header file for more information.
  5.  *
  6.  * This object is included in the MiscKit by permission from the author
  7.  * and its use is governed by the MiscKit license, found in the file
  8.  * "LICENSE.rtf" in the MiscKit distribution.  Please refer to that file
  9.  * for a list of all applicable permissions and restrictions.
  10.  ***************************************************************************/
  11.  
  12. #import <misckit/MiscString.h>
  13. #import <misckit/MiscIconWell.h>
  14.  
  15. /*
  16.  * A proper implementation of versioning. If you add ivars to the class (or
  17.  * just want to dork with the reading/writing) check out the comments tagged
  18.  * "Archiving: READ ME". BJM 5/24/94
  19.  */
  20.  
  21. /*
  22.  * **** Archiving: READ ME **** This is the current and defined version of the
  23.  * class. It is used to identify what data will be written and how that will
  24.  * happen. If the read/write stuff is modified AT ALL, this must be bumped up
  25.  * (I always bump by one) and the other comments must be followed. Failure to
  26.  * do so will result in palettes and nibs that cannot be read. BJM 5/24/94
  27.  */
  28. #define MISC_ICON_WELL_VERSION 0
  29.  
  30. @implementation MiscIconWell
  31.  
  32. + initialize
  33. {
  34.     if (self == [MiscIconWell class]) 
  35.     {
  36.         /*
  37.          * **** Archiving: READ ME **** After bumping the _VERSION, it is
  38.          * considered common practice to add a comment line indicating the new
  39.          * version number, date, and modifier. Optionally, the reason for the
  40.          * change. There is no need to modify the setVersion message. BJM
  41.          * 5/24/94 
  42.          */
  43.         // version 0: initial.  (bjm)
  44.            [[MiscIconWell class] setVersion:MISC_ICON_WELL_VERSION];
  45.     }
  46.     
  47.     return self;
  48. }
  49.  
  50. - initFrame: (const NXRect *)frameRect
  51. {
  52.   const char *const types[] = {NXFilenamePboardType};
  53.   
  54.       [super initFrame: frameRect];
  55.     [self registerForDraggedTypes: (const char *const *)&types count: 1];
  56.     
  57.     filename = [ [MiscString alloc] init];
  58.     [self setAllowDoubleClickLaunch: YES];
  59.     
  60.     return self;
  61. }
  62.  
  63.  
  64.  
  65. - awake
  66. { 
  67.   const char *const types[] = {NXFilenamePboardType};
  68.   
  69.     [super awake];    
  70.     [self registerForDraggedTypes: (const char *const *)&types count: 1];
  71.     
  72.     return self;
  73. }
  74.  
  75.  
  76.  
  77. - free
  78. {
  79.     [filename free];
  80.     return [super free];
  81. }
  82.  
  83.  
  84. // Return the filename associated with the image. Kind of a hack to return
  85. // nil if no filename set, I suppose.
  86.  
  87. - (const char *)filename
  88. {   
  89.     /*
  90.      * convert an empty string (because the filename ivar is always valid) to a
  91.      * return value of NULL. BJM 5/24/94
  92.      */
  93.      if ( [filename length] == 0)
  94.         return NULL;
  95.     else
  96.           return [filename stringValue];
  97. }
  98.  
  99.  
  100.  
  101. // Overridden from MiscDragView so the icon representation of the file
  102. // is fetched instead of the image itself (likely the filename is not
  103. // an image). It also has a small hack that if there are more than one
  104. // filename that it steals that multiple.tiff from Librarian.app. 
  105.  
  106. - setImageByFilename: (const char *)aFilename
  107. {
  108.     [filename setStringValue: aFilename];
  109.     
  110.     /*
  111.      * Multiple filenames are separated by tabs. We can't use -numWords because
  112.      * numWords checks for any NXIsSpace which includes spaces. Result: if we
  113.      * use numWords, it treats any filename with spaces as "multiple". BJM
  114.      * 5/24/94    
  115.      */
  116.     if ([filename index:'\t'] != NULL)
  117.         [super setImageByFilename: "/NextApps/Librarian.app/multiple.tiff"];
  118.     else    
  119.         [self setImage: [ [Application workspace] getIconForFile: aFilename] ];
  120.     
  121.     return self;
  122. }
  123.  
  124.  
  125.  
  126. // Add additional options that only apply to MiscIconWell.
  127.  
  128. - setAllowDoubleClickLaunch: (BOOL)aBool
  129. {
  130.     allowDoubleClickLaunch = aBool;
  131.     return self;
  132. }
  133.  
  134.  
  135.  
  136. - (BOOL)allowDoubleClickLaunch
  137. {
  138.     return allowDoubleClickLaunch;
  139. }
  140.  
  141.  
  142. /*
  143.  * Launch/open file in WS: BJM 5/24/94
  144.  */
  145. - launch:sender
  146. {
  147.     if ([filename length])
  148.         [[Application workspace] openFile:[filename stringValue]];
  149.     return self;
  150. }
  151.  
  152. // Override mouseDown to check if the icon was double clicked. If so, then
  153. // launch it from workspace, else let super handle it.
  154.  
  155. - mouseDown: (NXEvent *)theEvent
  156. {
  157.     /*
  158.      * Only attempt to open file if there (1) DC is allowed, (2) this is a DC
  159.      * event, and (3) there is a file to open. BJM 5/24/94
  160.      */
  161.     if ([self allowDoubleClickLaunch] && theEvent->data.mouse.click == 2)
  162.         [self launch:self];
  163.         
  164.     else
  165.         [super mouseDown: theEvent];
  166.     return self;
  167. }
  168.  
  169.  
  170.  
  171. // Make the dragPoint be the middle of the image, so it looks nice.
  172.  
  173. - calculateDragPoint: (NXPoint *)dragPoint andOffset: (NXPoint *)offset
  174. {
  175.     dragPoint->x -= imageSize.width/2.0;
  176.     dragPoint->y -= imageSize.width/2.0;
  177.  
  178.     return self;
  179. }
  180.  
  181.  
  182.     
  183. // Put the data on the pasteboard when a source drag takes place, and
  184. // also choose the image to drag. 
  185.  
  186. - (BOOL)setupForSourceDrag
  187. {
  188.     /*
  189.      * only if there is something to drag... BJM 5/24/94
  190.      */
  191.     if ([filename length] > 0)
  192.     {
  193.         id dragPB = [Pasteboard newName: NXDragPboard];
  194.         
  195.         [dragPB declareTypes:&NXFilenamePboardType num:1 owner:self];
  196.         
  197.         [dragPB writeType:NXFilenamePboard 
  198.             data:[filename stringValue]
  199.             length:[filename length] ];
  200.             
  201.         dragImage = theImage;
  202.         
  203.         return YES;
  204.     }
  205.     
  206.     return NO;
  207. }
  208.  
  209.  
  210.  
  211.  
  212. // Check if an incoming dragged icon is using the NXFilenamePboardType. If
  213. // not, then don't accept the drag.
  214.  
  215. - (BOOL)performDragOperation: sender
  216. {
  217.   id  dragPB = [Pasteboard newName: NXDragPboard];
  218.   char  *pbData;
  219.   int  pbLength;
  220.  
  221.     if ([dragPB readType: NXFilenamePboardType data: &pbData 
  222.             length: &pbLength] == nil)
  223.         return NO;    
  224.      
  225.     return YES;
  226. }
  227.  
  228.  
  229. // Take the data from the pasteboard and set the new image.
  230.  
  231. - concludeDragOperation: sender
  232. {
  233.   id  dragPB = [Pasteboard newName: NXDragPboard];
  234.   char  *pbData;
  235.   int  pbLength;
  236.   
  237.     [dragPB readType: NXFilenamePboardType data: &pbData 
  238.             length: &pbLength];
  239.  
  240.     [self setImageByFilename: pbData];
  241.             
  242.     [dragPB deallocatePasteboardData: pbData length: pbLength];
  243.     
  244.     [super concludeDragOperation: sender];
  245.     
  246.     return self;
  247. }
  248.  
  249.  
  250.  
  251. /*********** Archiving *************/
  252.  
  253. - read:(NXTypedStream *)stream
  254. {
  255.     int version;
  256.  
  257.     [super read:stream];
  258.     
  259.     version = NXTypedStreamClassVersion(stream, "MiscIconWell");
  260.         
  261.     /*
  262.      * **** Archiving: READ ME **** This code (and its analogue in write:) is
  263.      * critical. When you bump MISC_ICON_WELL_VERSION, copy the whole _current_
  264.      * case ("case MISC_ICON_WELL_VERSION: ... break;"), and duplicate it.
  265.      * Change the "MISC_ICON_WELL_VERSION" in the old case to the OLD
  266.      * (pre-bump) version number. Now, dork the "new current" version into
  267.      * whatever you want. See how this code can now read EITHER version out of
  268.      * the typed stream?
  269.      *
  270.      * If you are adding yet another version, leave the previous versionS in
  271.      * place. That way you can still read archived objects that are more than
  272.      * one version old. Don't forget to take whatever actions are necessary to
  273.      * harmonize those old values. For example, if you converted an "int" ivar
  274.      * to "double", you'd need to (in the old version) to read the int version
  275.      * into a temp variable, and convert it in to the double var. BJM 5/24/94
  276.      */
  277.     switch (version)
  278.     {
  279.     case MISC_ICON_WELL_VERSION:
  280.         filename = NXReadObject (stream);
  281.         NXReadTypes (stream, "c", 
  282.             &allowDoubleClickLaunch
  283.         );
  284.         break;
  285.  
  286.     default:
  287.         NXLogError("[%s %s] - unknown version of %s in typed stream",
  288.             [[self class] name], sel_getName(_cmd), [[self class] name]);
  289.         break;
  290.     }
  291.  
  292.     return self;
  293. }
  294.  
  295. - write:(NXTypedStream *)stream
  296. {
  297.     [super write:stream];
  298.     
  299.     /*
  300.      * **** Archiving: READ ME **** Home stretch. Now (just like read:)
  301.      * duplicate the current case ("case MISC_ICON_WELL_VERSION: ... break;").
  302.      * Once again, change the "MISC_ICON_WELL_VERSION" of the first one to the
  303.      * OLD version number. Now adjust the new/current MISC_ICON_WELL_VERSION
  304.      * (remember, you've bumped it) to the new way of writing vars. See how
  305.      * this code (because the constant is in the switch statement) always
  306.      * writes out ONLY the current version, but leaves the old version(s)
  307.      * around to posterity. DO NOT DELETE THE OLD VERSIONS. Leave them to
  308.      * clutter up the world. BJM 5/24/94  
  309.      */
  310.     switch (MISC_ICON_WELL_VERSION)
  311.     {
  312.     case MISC_ICON_WELL_VERSION:
  313.         NXWriteObject(stream, filename);
  314.         NXWriteTypes (stream, "c", 
  315.             &allowDoubleClickLaunch
  316.         );
  317.         break;
  318.  
  319.     default:
  320.         NXLogError("[%s %s] - unknown version of %s in typed stream",
  321.             [[self class] name], sel_getName(_cmd), [[self class] name]);
  322.         break;
  323.     }
  324.  
  325.     return self;
  326. }
  327.  
  328. @end