Enable -Wcast-qual for WebInspectorUI, WebKitLegacy, WebKit projects
[WebKit-https.git] / Source / WebKitLegacy / mac / WebView / WebDocumentInternal.h
1 /*
2  * Copyright (C) 2005 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 #import <WebKitLegacy/WebDocumentPrivate.h>
30 #import <WebKitLegacy/WebHTMLView.h>
31 #import <WebKitLegacy/WebViewPrivate.h>
32
33 #if PLATFORM(IOS)
34 #if !defined(IBAction)
35 #define IBAction void
36 #endif
37 #endif
38
39 /*!
40 @protocol _WebDocumentZooming
41 @discussion Optional protocol for a view that wants to handle its own zoom.
42 */
43 @protocol _WebDocumentZooming <NSObject>
44
45 // Methods to perform the actual commands
46 - (IBAction)_zoomOut:(id)sender;
47 - (IBAction)_zoomIn:(id)sender;
48 - (IBAction)_resetZoom:(id)sender;
49
50 // Whether or not the commands can be executed.
51 - (BOOL)_canZoomOut;
52 - (BOOL)_canZoomIn;
53 - (BOOL)_canResetZoom;
54
55 @end
56
57 @protocol WebDocumentElement <NSObject>
58 - (NSDictionary *)elementAtPoint:(NSPoint)point;
59 - (NSDictionary *)elementAtPoint:(NSPoint)point allowShadowContent:(BOOL)allow;
60 @end
61
62 @protocol WebMultipleTextMatches <NSObject>
63 - (void)setMarkedTextMatchesAreHighlighted:(BOOL)newValue;
64 - (BOOL)markedTextMatchesAreHighlighted;
65 - (NSUInteger)countMatchesForText:(NSString *)string inDOMRange:(DOMRange *)range options:(WebFindOptions)options limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
66 - (void)unmarkAllTextMatches;
67 - (NSArray *)rectsForTextMatches;
68 @end
69
70 @protocol WebDocumentOptionsSearching <NSObject>
71 // Prefixed with an underscore to avoid conflict with Mail's -[WebHTMLView(MailExtras) findString:options:].
72 - (BOOL)_findString:(NSString *)string options:(WebFindOptions)options;
73 @end
74
75 /* Used to save and restore state in the view, typically when going back/forward */
76 @protocol _WebDocumentViewState <NSObject>
77 - (NSPoint)scrollPoint;
78 - (void)setScrollPoint:(NSPoint)p;
79 - (id)viewState;
80 - (void)setViewState:(id)statePList;
81 @end
82
83 @interface WebHTMLView (WebDocumentInternalProtocols) <WebDocumentElement, WebMultipleTextMatches, WebDocumentOptionsSearching>
84 @end