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