WebKit/WebView/WebFrameInternal.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 // This header contains WebFrame declarations that can be used anywhere in WebKit, but are neither SPI nor API.
  30
  31 #import <WebKit/WebFramePrivate.h>
  32
  33 @class WebDocumentLoadState;
  34 @class WebInspector;
  35 @class WebFrameLoader;
  36
  37 // One day we might want to expand the use of this kind of class such that we'd receive one
  38 // over the bridge, and possibly hand it on through to the FormsDelegate.
  39 // Today it is just used internally to keep some state as we make our way through a bunch
  40 // layers while doing a load.
  41 @interface WebFormState : NSObject
  42 {
  43     DOMElement *_form;
  44     NSDictionary *_values;
  45     WebFrame *_sourceFrame;
  46 }
  47 - (id)initWithForm:(DOMElement *)form values:(NSDictionary *)values sourceFrame:(WebFrame *)sourceFrame;
  48 - (DOMElement *)form;
  49 - (NSDictionary *)values;
  50 - (WebFrame *)sourceFrame;
  51 @end
  52
  53 @interface WebFrame (WebInternal)
  54
  55 - (void)_updateBackground;
  56 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate;
  57 - (id)_internalLoadDelegate;
  58 - (void)_unmarkAllMisspellings;
  59 - (void)_didFirstLayout;
  60 // Note that callers should not perform any ops on these views that could change the set of frames
  61 - (NSArray *)_documentViews;
  62
  63 - (NSURLRequest *)_requestFromDelegateForRequest:(NSURLRequest *)request identifier:(id *)identifier error:(NSError **)error;
  64 - (void)_sendRemainingDelegateMessagesWithIdentifier:(id)identifier response:(NSURLResponse *)response length:(unsigned)length error:(NSError *)error;
  65 - (void)_safeLoadURL:(NSURL *)URL;
  66
  67 - (BOOL)_hasSelection;
  68 - (void)_clearSelection;
  69 - (WebFrame *)_findFrameWithSelection;
  70 - (void)_clearSelectionInOtherFrames;
  71 - (BOOL)_subframeIsLoading;
  72 - (id)_initWithWebFrameView:(WebFrameView *)fv webView:(WebView *)v bridge:(WebFrameBridge *)bridge;
  73
  74 - (void)_addPlugInView:(NSView *)plugInView;
  75 - (void)_removeAllPlugInViews;
  76
  77 // This should be called when leaving a page or closing the WebView
  78 - (void)_willCloseURL;
  79
  80 - (void)_addExtraFieldsToRequest:(NSMutableURLRequest *)request mainResource:(BOOL)mainResource alwaysFromRequest:(BOOL)f;
  81 - (BOOL)_isMainFrame;
  82
  83 - (void)_addInspector:(WebInspector *)inspector;
  84 - (void)_removeInspector:(WebInspector *)inspector;
  85
  86 - (WebFrameLoader *)_frameLoader;
  87 - (void)_provisionalLoadStarted;
  88 - (void)_prepareForDataSourceReplacement;
  89 - (void)_frameLoadCompleted;
  90 - (WebDataSource *)_dataSourceForDocumentLoadState:(WebDocumentLoadState *)loadState;
  91 - (WebDocumentLoadState *)_createDocumentLoadStateWithRequest:(NSURLRequest *)request;
  92 - (void)_didReceiveServerRedirectForProvisionalLoadForFrame;
  93
  94 @end
  95
  96 @interface NSObject (WebInternalFrameLoadDelegate)
  97 - (void)webFrame:(WebFrame *)webFrame didFinishLoadWithError:(NSError *)error;
  98 @end