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 

    32 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4

    33 #define WebNSUInteger unsigned int

    34 #else

    35 #define WebNSUInteger NSUInteger

    36 #endif

    37 

    38 /*!

    39 @protocol _WebDocumentTextSizing

    40 @discussion Optional protocol for making text larger and smaller.

    41 */

    42 @protocol _WebDocumentTextSizing <NSObject>

    43 

    44 // Methods to perform the actual commands

    45 - (IBAction)_makeTextSmaller:(id)sender;

    46 - (IBAction)_makeTextLarger:(id)sender;

    47 - (IBAction)_makeTextStandardSize:(id)sender;

    48 

    49 // Views that do text sizing come in two flavors.  Some will track the common textSizeMultiplier factor stored

    50 // in the WebView.  Others (see PDFView) keep their own scaling factor, but still want to play along loosely

    51 // with the smaller/larger commands, which in the user model operate across all frames of the WebView.

    52 - (BOOL)_tracksCommonSizeFactor;

    53 

    54 // Views that track the common size factor need to be told when the WebView itself changed the value.

    55 - (void)_textSizeMultiplierChanged;

    56 

    57 // Views that do not track the common size factor must answer for themselves if they are able to zoom in

    58 // or out.  Views that do track it are not sent these messages.

    59 - (BOOL)_canMakeTextSmaller;

    60 - (BOOL)_canMakeTextLarger;

    61 - (BOOL)_canMakeTextStandardSize;

    62 

    63 @end

    64 

    65 @protocol WebDocumentElement <NSObject>

    66 - (NSDictionary *)elementAtPoint:(NSPoint)point;

    67 - (NSDictionary *)elementAtPoint:(NSPoint)point allowShadowContent:(BOOL)allow;

    68 @end

    69 

    70 @protocol WebMultipleTextMatches <NSObject>

    71 - (void)setMarkedTextMatchesAreHighlighted:(BOOL)newValue;

    72 - (BOOL)markedTextMatchesAreHighlighted;

    73 - (WebNSUInteger)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag limit:(WebNSUInteger)limit;

    74 - (void)unmarkAllTextMatches;

    75 - (NSArray *)rectsForTextMatches;

    76 @end

    77 

    78 

    79 /* Used to save and restore state in the view, typically when going back/forward */

    80 @protocol _WebDocumentViewState <NSObject>

    81 - (NSPoint)scrollPoint;

    82 - (void)setScrollPoint:(NSPoint)p;

    83 - (id)viewState;

    84 - (void)setViewState:(id)statePList;

    85 @end

    86 

    87 @interface WebHTMLView (WebDocumentInternalProtocols) <WebDocumentElement, WebMultipleTextMatches>

    88 @end

    89 

    90 #undef WebNSUInteger