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