Make it easy to test enabling formal delegate protocols
[WebKit-https.git] / Source / WebKit / mac / Misc / WebDownload.h
1 /*
2  * Copyright (C) 2003 Apple 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 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 // We explicitly use __has_include() instead of the macro define WTF_USE_APPLE_INTERNAL_SDK as
30 // the condition for including the header Foundation/NSURLDownload.h to support internal Apple
31 // clients that build without header wtf/Platform.h. See <rdar://problem/19034131>.
32 #if __has_include(<Foundation/NSURLDownload.h>)
33 #import <Foundation/NSURLDownload.h>
34 #else
35 @interface NSURLDownload : NSObject
36 @end
37
38 @protocol NSURLDownloadDelegate;
39 #endif
40
41 #if TARGET_OS_IPHONE
42 #import <WebKitLegacy/WAKAppKitStubs.h>
43 #endif
44
45 @class WebDownloadInternal;
46
47 /*!
48     @class WebDownload
49     @discussion A WebDownload works just like an NSURLDownload, with
50     one extra feature: if you do not implement the
51     authentication-related delegate methods, it will automatically
52     prompt for authentication using the standard WebKit authentication
53     panel, as either a sheet or window. It provides no extra methods,
54     but does have one additional delegate method.
55 */
56
57
58 @interface WebDownload : NSURLDownload
59 {
60 @package
61     WebDownloadInternal *_webInternal;
62 }
63
64 @end
65
66 /*!
67     @protocol WebDownloadDelegate
68     @discussion The WebDownloadDelegate delegate has one extra method used to choose
69     the right window when automatically prompting with a sheet.
70 */
71 @protocol WebDownloadDelegate <NSURLDownloadDelegate>
72
73 @optional
74
75 #ifndef WK_ENABLE_FORMAL_DELEGATE_PROTOCOLS
76 @end
77
78 @interface NSObject (WebDownloadDelegate)
79 #endif
80
81 /*!
82     @method downloadWindowForAuthenticationSheet:
83     @abstract
84     @param
85     @result
86 */
87 - (NSWindow *)downloadWindowForAuthenticationSheet:(WebDownload *)download;
88
89 @end