Framework/NDAlias/NDResourceFork+OtherSorces.h

   1 /*!
   2         @header NDResourceFork+OtherSorces
   3         @abstract Defines the interface for a category of the class <tt>NDResourceFork</tt>.
   4         @discussion Defines method for <tt>NDResourceFork</tt> for retrieving resource type data from non resource fork sources, at lest not directly. The category <tt>OtherSorces</tt> can be omitted from your project if the additonal functionalty is not desired.
   5  */
   6
   7 #import <Cocoa/Cocoa.h>
   8 #import "NDResourceFork.h"
   9
  10 /*!
  11         @category NDResourceFork(OtherSorces)
  12         @abstract A category of the class <tt>NDResourceFork</tt>.
  13         @discussion The category <tt>OtherSorces</tt> adds method to <tt>NDResourceFork</tt> for retrieving resource type data from non resource fork sources, at lest not directly. This category can be omitted from your project if the additonal functionalty is not desired.
  14  */
  15 @interface NDResourceFork (OtherSorces)
  16
  17 /*!
  18         @method iconFamilyDataForURL:
  19         @abstract Gets a files or directories Icon Family Data.
  20         @discussion <tt>iconFamilyDataForURL:</tt> returns the Icon Family Data for any file or directory. The file does not have to have an actual resource fork with the Icon Family Data in it, neither does a directory have to have an Icon/r file with the Icon Family Data.
  21         @param URL The file url for which the Icon Family Data is required.
  22         @result A <tt>NSData</tt> contain the Icon Family Data, returns <tt>nil</tt> if <tt>iconFamilyDataForURL:</tt> failed.
  23   */
  24 + (NSData *)iconFamilyDataForURL:(NSURL *)URL;
  25 /*!
  26         @method iconFamilyDataForFile:
  27         @abstract Gets a files or directories Icon Family Data.
  28         @discussion <tt>iconFamilyDataForURL:</tt> returns the Icon Family Data for any file or directory. The file does not have to have an actual resource fork with the Icon Family Data in it, neither does a directory have to have an Icon/r file with the Icon Family Data.
  29         @param path The path for which the Icon Family Data is required.
  30         @result A <tt>NSData</tt> contain the Icon Family Data, returns <tt>nil</tt> if <tt>iconFamilyDataForURL:</tt> failed.
  31  */
  32 + (NSData *)iconFamilyDataForFile:(NSString *)path;
  33
  34 @end