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 // This header contains the WebFrame SPI.

    30 

    31 #import <WebKit/WebFrame.h>

    32 #import <JavaScriptCore/JSBase.h>

    33 

    34 @class WebScriptObject;

    35 

    36 // Keys for accessing the values in the page cache dictionary.

    37 extern NSString *WebPageCacheEntryDateKey;

    38 extern NSString *WebPageCacheDataSourceKey;

    39 extern NSString *WebPageCacheDocumentViewKey;

    40 

    41 typedef enum {

    42     WebFrameLoadTypeStandard,

    43     WebFrameLoadTypeBack,

    44     WebFrameLoadTypeForward,

    45     WebFrameLoadTypeIndexedBackForward, // a multi-item hop in the backforward list

    46     WebFrameLoadTypeReload,

    47     WebFrameLoadTypeReloadAllowingStaleData,

    48     WebFrameLoadTypeSame,               // user loads same URL again (but not reload button)

    49     WebFrameLoadTypeInternal,           // maps to WebCore::FrameLoadTypeRedirectWithLockedHistory

    50     WebFrameLoadTypeReplace

    51 } WebFrameLoadType;

    52 

    53 @interface WebFrame (WebPrivate)

    54 - (BOOL)_isDescendantOfFrame:(WebFrame *)frame;

    55 - (void)_setShouldCreateRenderers:(BOOL)f;

    56 - (NSColor *)_bodyBackgroundColor;

    57 - (BOOL)_isFrameSet;

    58 - (BOOL)_firstLayoutDone;

    59 - (WebFrameLoadType)_loadType;

    60 #ifndef __LP64__

    61 - (void)_recursive_resumeNullEventsForAllNetscapePlugins;

    62 - (void)_recursive_pauseNullEventsForAllNetscapePlugins;

    63 #endif

    64 

    65 // These methods take and return NSRanges based on the root editable element as the positional base.

    66 // This fits with AppKit's idea of an input context. These methods are slow compared to their DOMRange equivalents.

    67 // You should use WebView's selectedDOMRange and setSelectedDOMRange whenever possible.

    68 - (NSRange)_selectedNSRange;

    69 - (void)_selectNSRange:(NSRange)range;

    70 

    71 - (BOOL)_isDisplayingStandaloneImage;

    72 

    73 @end