From ba310e8b58d686ee9897b26a7edab5b778a8d96f Mon Sep 17 00:00:00 2001 From: jnj Date: Thu, 13 Nov 2008 18:59:12 +0000 Subject: Add remaining plugins git-svn-id: https://blacktree-elements-public.googlecode.com/svn/trunk@41 57e2f9b5-c12c-0410-8e95-a1ee7272c91a --- .../Versions/A/PrivateHeaders/NDAlias+AliasFile.h | 77 ++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 QSFoundation.framework/Versions/A/PrivateHeaders/NDAlias+AliasFile.h (limited to 'QSFoundation.framework/Versions/A/PrivateHeaders/NDAlias+AliasFile.h') diff --git a/QSFoundation.framework/Versions/A/PrivateHeaders/NDAlias+AliasFile.h b/QSFoundation.framework/Versions/A/PrivateHeaders/NDAlias+AliasFile.h new file mode 100644 index 0000000..6f29958 --- /dev/null +++ b/QSFoundation.framework/Versions/A/PrivateHeaders/NDAlias+AliasFile.h @@ -0,0 +1,77 @@ +/* + * NDAlias+AliasFile.h category + * NDAliasProject + * + * Created by Nathan Day on Tue Dec 03 2002. + * Copyright (c) 2002 Nathan Day. All rights reserved. + */ +/*! + @header NDAlias+AliasFile + @abstract Defines a category of the class NDAlias + @discussion This category add additional functionality to NDAlias for reading and writing NDAlias instances to Finder alias files. Though this could be used for archiving purposed, the methods of the adopted protocol NSCoding are probable better suited. The method of NDAlias (AliasFile) are mainly for creating alias files that are visible in Finder to the user. +

As well as the class NDAlias and the classes and categories it uses, NDAlias (AliasFile) also requires the class NDResourceFork and it's category NDResourceFork (OtherSorces). If the additional functionality of NDAlias (AliasFile) is not required then the files for NDAlias (AliasFile), NDResourceFork and NDResourceFork (OtherSorces) can be excluded from your project.

+ */ + +#import +#import "NDAlias.h" + +/*! + @category NDAlias(AliasFile) + @abstract A category of the class NDAlias + @discussion This category add additional functionality to NDAlias for reading and writing NDAlias instances to Finder alias files. Though this could be used for archiving purposed, the methods of the adopted protocol NSCoding are probable better suited. The method of NDAlias (AliasFile) are mainly for creating alias files that are visible in Finder to the user. +

As well as the class NDAlias and the classes and categories it uses, NDAlias (AliasFile) also requires the class NDResourceFork and it's category NDResourceFork (OtherSorces). If the additional functionality of NDAlias (AliasFile) is not required then the files for NDAlias (AliasFile), NDResourceFork and NDResourceFork (OtherSorces) can be excluded from your project.

+ */ +@interface NDAlias (AliasFile) + +/*! + @method aliasWithContentsOfFile: + @abstract Creates and initalises a NDAlias. + @discussion The method aliasWithContentsOfFile: allocates and initalises an NDAlias with the alias record data within the Finder alias file pointed to by the NSString path aPath. + @param aPath the path to an alias file. + @result A NDAlias instance, returns nil if NDAlias creation fails. + */ ++ (id)aliasWithContentsOfFile:(NSString *)aPath; + /*! + @method aliasWithContentsOfURL: + @abstract Initalises a NDAlias. + @discussion The method aliasWithContentsOfURL: allocates and initalises an NDAlias with the alias record data within the Finder NSURL alias file pointed to pay the file url aURL + @param aURL the file url to the alias file. + @result A NDAlias instance, returns nil if NDAlias creation fails. + */ ++ (id)aliasWithContentsOfURL:(NSURL *)aURL; + +/*! + @method initWithContentsOfFile: + @abstract Initalises a NDAlias. + @discussion The method initWithContentsOfFile: initalises the receiver with the alias record data within the Finder alias file pointed to by the NSString path aPath + @param aPath the path to the alias file. + @result An initalises NDAlias, returns nil if initalises fails. + */ +- (id)initWithContentsOfFile:(NSString *)aPath; +/*! + @method initWithContentsOfURL: + @abstract Initalises a NDAlias. + @discussion The method initWithContentsOfURL: initalises the reciever with the alias record data within the Finder NSURL alias file pointed to pay the file url aURL. + @param aURL the file url to the alias file. + @result An initalises NDAlias, returns nil if initalises fails. + */ +- (id)initWithContentsOfURL:(NSURL *)aURL; + +/*! + @method writeToFile: + @abstract Writes an NDAlias to a Finder alias file. + @discussion The method writeToFile: writes the alias record data contained within the reciever to a Finder alias file at the path aPath. writeToFile: can be used to create alias files that the user can see in Finder and use. + @param aPath the path for the alias file. Not the path the alias record represents. + @result «result» + */ +- (BOOL)writeToFile:(NSString *)aPath; +/*! + @method writeToURL: + @abstract Writes an NDAlias to a Finder alias file. + @discussion The method writeToURL: writes the alias record data contained within the reciever to a Finder alias file at the file url aURL. writeToFile: can be used to create alias files that the user can see in Finder and use. + @param aURL the file url for the alias file. Not the file url the alias record represents. + @result «result» + */ +- (BOOL)writeToURL:(NSURL *)aURL; + +@end \ No newline at end of file -- cgit