Home | History | Annotate | Download | only in History
      1 /*
      2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
     14  *     its contributors may be used to endorse or promote products derived
     15  *     from this software without specific prior written permission.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #import <Cocoa/Cocoa.h>
     30 
     31 #define WebURLsWithTitlesPboardType     @"WebURLsWithTitlesPboardType"
     32 
     33 // Convenience class for getting URLs and associated titles on and off an NSPasteboard
     34 
     35 @interface WebURLsWithTitles : NSObject
     36 
     37 // Writes parallel arrays of URLs and titles to the pasteboard. These items can be retrieved by
     38 // calling URLsFromPasteboard and titlesFromPasteboard. URLs must consist of NSURL objects.
     39 // titles must consist of NSStrings, or be nil. If titles is nil, or if titles is a different
     40 // length than URLs, empty strings will be used for all titles. If URLs is nil, this method
     41 // returns without doing anything. You must declare an WebURLsWithTitlesPboardType data type
     42 // for pasteboard before invoking this method, or it will return without doing anything.
     43 + (void)writeURLs:(NSArray *)URLs andTitles:(NSArray *)titles toPasteboard:(NSPasteboard *)pasteboard;
     44 
     45 // Reads an array of NSURLs off the pasteboard. Returns nil if pasteboard does not contain
     46 // data of type WebURLsWithTitlesPboardType. This array consists of the URLs that correspond to
     47 // the titles returned from titlesFromPasteboard.
     48 + (NSArray *)URLsFromPasteboard:(NSPasteboard *)pasteboard;
     49 
     50 // Reads an array of NSStrings off the pasteboard. Returns nil if pasteboard does not contain
     51 // data of type WebURLsWithTitlesPboardType. This array consists of the titles that correspond to
     52 // the URLs returned from URLsFromPasteboard.
     53 + (NSArray *)titlesFromPasteboard:(NSPasteboard *)pasteboard;
     54 
     55 @end
     56