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/WebDocument.h>
30#import <WebKit/WebHTMLView.h>
31
32@class DOMDocument;
33
34@protocol WebDocumentImage <NSObject>
35- (NSImage *)image;
36@end
37
38// This method is deprecated as it now lives on WebFrame.
39@protocol WebDocumentDOM <NSObject>
40- (DOMDocument *)DOMDocument;
41- (BOOL)canSaveAsWebArchive;
42@end
43
44@protocol WebDocumentSelection <WebDocumentText>
45- (NSArray *)pasteboardTypesForSelection;
46- (void)writeSelectionWithPasteboardTypes:(NSArray *)types toPasteboard:(NSPasteboard *)pasteboard;
47
48// Array of rects that tightly enclose the selected text, in coordinates of selectinView.
49- (NSArray *)selectionTextRects;
50
51// Rect tightly enclosing the entire selected area, in coordinates of selectionView.
52- (NSRect)selectionRect;
53
54// NSImage of the portion of the selection that's in view. This does not draw backgrounds.
55// The text is all black according to the parameter.
56- (NSImage *)selectionImageForcingBlackText:(BOOL)forceBlackText;
57
58// Rect tightly enclosing the entire selected area, in coordinates of selectionView.
59// NOTE: This method is equivalent to selectionRect and shouldn't be used; use selectionRect instead.
60- (NSRect)selectionImageRect;
61
62// View that draws the selection and can be made first responder. Often this is self but it could be
63// a nested view, as for example in the case of WebPDFView.
64- (NSView *)selectionView;
65@end
66
67@protocol WebDocumentIncrementalSearching
68/*!
69@method searchFor:direction:caseSensitive:wrap:startInSelection:
70 @abstract Searches a document view for a string and highlights the string if it is found.
71 @param string The string to search for.
72 @param forward YES to search forward, NO to seach backwards.
73 @param caseFlag YES to for case-sensitive search, NO for case-insensitive search.
74 @param wrapFlag YES to wrap around, NO to avoid wrapping.
75 @param startInSelection YES to begin search in the selected text (useful for incremental searching), NO to begin search after the selected text.
76 @result YES if found, NO if not found.
77 */
78- (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag startInSelection:(BOOL)startInSelection;
79@end
80
81@interface WebHTMLView (WebDocumentPrivateProtocols) <WebDocumentSelection, WebDocumentIncrementalSearching>
82@end
83