initial import
[vuplus_webkit] / Source / WebKit / mac / Misc / WebDownload.h
1 /*
2  * Copyright (C) 2003 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 <Foundation/NSURLDownload.h>
30
31 @class WebDownloadInternal;
32
33 /*!
34     @class WebDownload
35     @discussion A WebDownload works just like an NSURLDownload, with
36     one extra feature: if you do not implement the
37     authentication-related delegate methods, it will automatically
38     prompt for authentication using the standard WebKit authentication
39     panel, as either a sheet or window. It provides no extra methods,
40     but does have one additional delegate method.
41 */
42
43
44 @interface WebDownload : NSURLDownload
45 {
46 @private
47     WebDownloadInternal *_webInternal;
48 }
49
50 @end
51
52 /*!
53     @protocol WebDownloadDelegate
54     @discussion The WebDownloadDelegate delegate has one extra method used to choose
55     the right window when automatically prompting with a sheet.
56 */
57 @interface NSObject (WebDownloadDelegate)
58
59 /*!
60     @method downloadWindowForAuthenticationSheet:
61     @abstract
62     @param
63     @result
64 */
65 - (NSWindow *)downloadWindowForAuthenticationSheet:(WebDownload *)download;
66
67 @end