e11f5e5c13657cf3842d7daf7f5a46265f54a969
[WebKit-https.git] / WebCore / bridge / mac / WebCorePageBridge.h
1 /*
2  * Copyright (C) 2006 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import <Cocoa/Cocoa.h>
27
28 // WebCorePageBridge is used to bridge between Page in WebCore and
29 // WebView in WebKit. It is a two-way bridge, with subclasses expected
30 // to implement a protocol of bridging methods.
31
32 // The WebCorePageBridge interface contains methods for use by the
33 // non-WebCore side of the bridge.
34
35 #ifdef __cplusplus
36 namespace WebCore { class Page; }
37 typedef WebCore::Page WebCorePage;
38 #else
39 @class WebCorePage;
40 #endif
41
42 #ifdef __OBJC__
43 @class WebCoreFrameBridge;
44 #else
45 class WebCoreFrameBridge;
46 #endif
47
48 @interface WebCorePageBridge : NSObject
49 {
50     WebCorePage* _page;
51 }
52
53 - (void)setMainFrame:(WebCoreFrameBridge*)mainFrame;
54
55 - (WebCoreFrameBridge*)mainFrame;
56
57 @end
58
59 // The WebCorePageBridge protocol contains methods for use by the WebCore side of the bridge.
60
61 @protocol WebCorePageBridge
62 @end
63
64 // This interface definition allows those who hold a WebCorePageBridge * to call all the methods
65 // in the WebCorePageBridge protocol without requiring the base implementation to supply the methods.
66 // This idiom is appropriate because WebCorePageBridge is an abstract class.
67
68 @interface WebCorePageBridge (SubclassResponsibility) <WebCorePageBridge>
69 @end
70
71 // One method for internal use within WebCore itself.
72 // Could move this to another header, but would be a pity to create an entire header just for that.
73
74 @interface WebCorePageBridge (WebCoreInternalUse)
75 - (WebCorePage*)impl;
76 @end