diff options
Diffstat (limited to 'WebKit/mac/WebView/WebFrameView.h')
-rw-r--r-- | WebKit/mac/WebView/WebFrameView.h | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/WebKit/mac/WebView/WebFrameView.h b/WebKit/mac/WebView/WebFrameView.h new file mode 100644 index 0000000..e170403 --- /dev/null +++ b/WebKit/mac/WebView/WebFrameView.h @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of + * its contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#import <Cocoa/Cocoa.h> + +@class WebDataSource; +@class WebFrame; +@class WebFrameViewPrivate; + +@protocol WebDocumentView; + +/*! + @class WebFrameView +*/ +@interface WebFrameView : NSView +{ +@private + WebFrameViewPrivate *_private; +} + +/*! + @method webFrame + @abstract Returns the WebFrame associated with this WebFrameView + @result The WebFrameView's frame. +*/ +- (WebFrame *)webFrame; + +/*! + @method documentView + @abstract Returns the WebFrameView's document subview + @result The subview that renders the WebFrameView's contents +*/ +- (NSView <WebDocumentView> *)documentView; + +/*! + @method setAllowsScrolling: + @abstract Sets whether the WebFrameView allows its document to be scrolled + @param flag YES to allow the document to be scrolled, NO to disallow scrolling +*/ +- (void)setAllowsScrolling:(BOOL)flag; + +/*! + @method allowsScrolling + @abstract Returns whether the WebFrameView allows its document to be scrolled + @result YES if the document is allowed to scroll, otherwise NO +*/ +- (BOOL)allowsScrolling; + +/*! + @method canPrintHeadersAndFooters + @abstract Tells whether this frame can print headers and footers + @result YES if the frame can, no otherwise +*/ +- (BOOL)canPrintHeadersAndFooters; + +/*! + @method printOperationWithPrintInfo + @abstract Creates a print operation set up to print this frame + @result A newly created print operation object +*/ +- (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo; + +/*! + @method documentViewShouldHandlePrint + @abstract Called by the host application before it initializes and runs a print operation. + @result If NO is returned, the host application will abort its print operation and call -printDocumentView on the + WebFrameView. The document view is then expected to run its own print operation. If YES is returned, the host + application's print operation will continue as normal. +*/ +- (BOOL)documentViewShouldHandlePrint; + +/*! + @method printDocumentView + @abstract Called by the host application when the WebFrameView returns YES from -documentViewShouldHandlePrint. +*/ +- (void)printDocumentView; + +@end |