Reviewed by Maciej.
[WebKit-https.git] / WebKit / WebView / WebFrameViewPrivate.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 #import <WebKit/WebFrameView.h>
30
31 @interface WebFrameView (WebPrivate)
32
33 /*!
34     @method canPrintHeadersAndFooters
35     @abstract Tells whether this frame can print headers and footers
36     @result YES if the frame can, no otherwise
37 */
38 - (BOOL)canPrintHeadersAndFooters;
39
40 /*!
41     @method printOperationWithPrintInfo
42     @abstract Creates a print operation set up to print this frame
43     @result A newly created print operation object
44 */
45 - (NSPrintOperation *)printOperationWithPrintInfo:(NSPrintInfo *)printInfo;
46
47 /*!
48     @method documentViewShouldHandlePrint
49     @abstract Called by the host application before it initializes and runs a print operation.
50     @result If NO is returned, the host application will abort its print operation and call -printDocumentView on the
51     WebFrameView.  The document view is then expected to run its own print operation.  If YES is returned, the host 
52     application's print operation will continue as normal.
53 */
54 - (BOOL)documentViewShouldHandlePrint;
55
56 /*!
57     @method printDocumentView
58     @abstract Called by the host application when the WebFrameView returns YES from -documentViewShouldHandlePrint.
59 */
60 - (void)printDocumentView;
61
62 /*!
63     @method _largestChildWithScrollBars
64     @abstract Of the child WebFrameViews that are displaying scroll bars, determines which has the largest area.
65     @result A child WebFrameView that is displaying scroll bars, or nil if none.
66 */
67 - (WebFrameView *)_largestChildWithScrollBars;
68
69 /*!
70     @method _hasScrollBars
71     @result YES if at least one scroll bar is currently displayed
72  */
73 - (BOOL)_hasScrollBars;
74
75 @end