Make it easy to test enabling formal delegate protocols
[WebKit-https.git] / Source / WebKit / mac / WebView / WebUIDelegate.h
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006 Apple 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 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 <Foundation/Foundation.h>
30 #import <Foundation/NSURLRequest.h>
31 #import <WebKitLegacy/WebKitAvailability.h>
32
33 #if !TARGET_OS_IPHONE
34 #import <AppKit/AppKit.h>
35 #else
36 #import <WebKitLegacy/WAKAppKitStubs.h>
37 #import <WebKitLegacy/WAKView.h>
38 #endif
39
40 /*!
41     @enum WebMenuItemTag
42     @discussion Each menu item in the default menu items array passed in
43     contextMenuItemsForElement:defaultMenuItems: has its tag set to one of the WebMenuItemTags.
44     When iterating through the default menu items array, use the tag to differentiate between them.
45 */
46
47 enum {
48     WebMenuItemTagOpenLinkInNewWindow=1,
49     WebMenuItemTagDownloadLinkToDisk,
50     WebMenuItemTagCopyLinkToClipboard,
51     WebMenuItemTagOpenImageInNewWindow,
52     WebMenuItemTagDownloadImageToDisk,
53     WebMenuItemTagCopyImageToClipboard,
54     WebMenuItemTagOpenFrameInNewWindow,
55     WebMenuItemTagCopy,
56     WebMenuItemTagGoBack,
57     WebMenuItemTagGoForward,
58     WebMenuItemTagStop,
59     WebMenuItemTagReload,
60     WebMenuItemTagCut,
61     WebMenuItemTagPaste,
62     WebMenuItemTagSpellingGuess,
63     WebMenuItemTagNoGuessesFound,
64     WebMenuItemTagIgnoreSpelling,
65     WebMenuItemTagLearnSpelling,
66     WebMenuItemTagOther,
67     WebMenuItemTagSearchInSpotlight,
68     WebMenuItemTagSearchWeb,
69     WebMenuItemTagLookUpInDictionary,
70     WebMenuItemTagOpenWithDefaultApplication,
71     WebMenuItemPDFActualSize,
72     WebMenuItemPDFZoomIn,
73     WebMenuItemPDFZoomOut,
74     WebMenuItemPDFAutoSize,
75     WebMenuItemPDFSinglePage,
76     WebMenuItemPDFFacingPages,
77     WebMenuItemPDFContinuous,
78     WebMenuItemPDFNextPage,
79     WebMenuItemPDFPreviousPage,
80 };
81
82 /*!
83     @enum WebDragDestinationAction
84     @abstract Actions that the destination of a drag can perform.
85     @constant WebDragDestinationActionNone No action
86     @constant WebDragDestinationActionDHTML Allows DHTML (such as JavaScript) to handle the drag
87     @constant WebDragDestinationActionEdit Allows editable documents to be edited from the drag
88     @constant WebDragDestinationActionLoad Allows a location change from the drag
89     @constant WebDragDestinationActionAny Allows any of the above to occur
90 */
91 typedef NS_OPTIONS(NSUInteger, WebDragDestinationAction) {
92     WebDragDestinationActionNone    = 0,
93     WebDragDestinationActionDHTML   = 1,
94     WebDragDestinationActionEdit    = 2,
95     WebDragDestinationActionLoad    = 4,
96     WebDragDestinationActionAny     = UINT_MAX
97 };
98
99 /*!
100     @enum WebDragSourceAction
101     @abstract Actions that the source of a drag can perform.
102     @constant WebDragSourceActionNone No action
103     @constant WebDragSourceActionDHTML Allows DHTML (such as JavaScript) to start a drag
104     @constant WebDragSourceActionImage Allows an image drag to occur
105     @constant WebDragSourceActionLink Allows a link drag to occur
106     @constant WebDragSourceActionSelection Allows a selection drag to occur
107     @constant WebDragSourceActionAny Allows any of the above to occur
108 */
109 typedef NS_OPTIONS(NSUInteger, WebDragSourceAction) {
110     WebDragSourceActionNone         = 0,
111     WebDragSourceActionDHTML        = 1,
112     WebDragSourceActionImage        = 2,
113     WebDragSourceActionLink         = 4,
114     WebDragSourceActionSelection    = 8,
115     WebDragSourceActionAny          = UINT_MAX
116 };
117
118 /*!
119     @protocol WebOpenPanelResultListener
120     @discussion This protocol is used to call back with the results of
121     the file open panel requested by runOpenPanelForFileButtonWithResultListener:
122 */
123 @protocol WebOpenPanelResultListener <NSObject>
124
125 /*!
126     @method chooseFilename:
127     @abstract Call this method to return a filename from the file open panel.
128     @param fileName
129 */
130 - (void)chooseFilename:(NSString *)fileName;
131
132 /*!
133     @method chooseFilenames:
134     @abstract Call this method to return an array of filenames from the file open panel.
135     @param fileNames
136 */
137 - (void)chooseFilenames:(NSArray *)fileNames WEBKIT_AVAILABLE_MAC(10_6);
138
139 /*!
140     @method cancel
141     @abstract Call this method to indicate that the file open panel was cancelled.
142 */
143 - (void)cancel;
144
145 #if TARGET_OS_IPHONE
146 - (void)chooseFilename:(NSString *)filename displayString:(NSString *)displayString iconImage:(CGImageRef)imageRef;
147 - (void)chooseFilenames:(NSArray *)filenames displayString:(NSString *)displayString iconImage:(CGImageRef)imageRef;
148 #endif
149
150 @end
151
152 @class WebFrame;
153 @class WebFrameView;
154 @class WebView;
155
156 /*!
157     @category WebUIDelegate
158     @discussion A class that implements WebUIDelegate provides
159     window-related methods that may be used by Javascript, plugins and
160     other aspects of web pages. These methods are used to open new
161     windows and control aspects of existing windows.
162 */
163 @protocol WebUIDelegate <NSObject>
164
165 @optional
166
167 #ifndef WK_ENABLE_FORMAL_DELEGATE_PROTOCOLS
168 @end
169
170 @interface NSObject (WebUIDelegate)
171 #endif
172
173 /*!
174     @method webView:createWebViewWithRequest:
175     @abstract Create a new window and begin to load the specified request.
176     @discussion The newly created window is hidden, and the window operations delegate on the
177     new WebViews will get a webViewShow: call.
178     @param sender The WebView sending the delegate method.
179     @param request The request to load.
180     @result The WebView for the new window.
181 */
182 - (WebView *)webView:(WebView *)sender createWebViewWithRequest:(NSURLRequest *)request;
183
184 /*!
185     @method webViewShow:
186     @param sender The WebView sending the delegate method.
187     @abstract Show the window that contains the top level view of the WebView,
188     ordering it frontmost.
189     @discussion This will only be called just after createWindowWithRequest:
190     is used to create a new window.
191 */
192 - (void)webViewShow:(WebView *)sender;
193
194 /*!
195     @method webView:createWebViewModalDialogWithRequest:
196     @abstract Create a new window and begin to load the specified request.
197     @discussion The newly created window is hidden, and the window operations delegate on the
198     new WebViews will get a webViewShow: call.
199     @param sender The WebView sending the delegate method.
200     @param request The request to load.
201     @result The WebView for the new window.
202 */
203 - (WebView *)webView:(WebView *)sender createWebViewModalDialogWithRequest:(NSURLRequest *)request;
204
205 /*!
206     @method webViewRunModal:
207     @param sender The WebView sending the delegate method.
208     @abstract Show the window that contains the top level view of the WebView,
209     ordering it frontmost. The window should be run modal in the application.
210     @discussion This will only be called just after createWebViewModalDialogWithRequest:
211     is used to create a new window.
212 */
213 - (void)webViewRunModal:(WebView *)sender;
214
215 /*!
216     @method webViewClose:
217     @abstract Close the current window. 
218     @param sender The WebView sending the delegate method.
219     @discussion Clients showing multiple views in one window may
220     choose to close only the one corresponding to this
221     WebView. Other clients may choose to ignore this method
222     entirely.
223 */
224 - (void)webViewClose:(WebView *)sender;
225
226 /*!
227     @method webViewFocus:
228     @abstract Focus the current window (i.e. makeKeyAndOrderFront:).
229     @param The WebView sending the delegate method.
230     @discussion Clients showing multiple views in one window may want to
231     also do something to focus the one corresponding to this WebView.
232 */
233 - (void)webViewFocus:(WebView *)sender;
234
235 /*!
236     @method webViewUnfocus:
237     @abstract Unfocus the current window.
238     @param sender The WebView sending the delegate method.
239     @discussion Clients showing multiple views in one window may want to
240     also do something to unfocus the one corresponding to this WebView.
241 */
242 - (void)webViewUnfocus:(WebView *)sender;
243
244 /*!
245     @method webViewFirstResponder:
246     @abstract Get the first responder for this window.
247     @param sender The WebView sending the delegate method.
248     @discussion This method should return the focused control in the
249     WebView's view, if any. If the view is out of the window
250     hierarchy, this might return something than calling firstResponder
251     on the real NSWindow would. It's OK to return either nil or the
252     real first responder if some control not in the window has focus.
253 */
254 - (NSResponder *)webViewFirstResponder:(WebView *)sender;
255
256 /*!
257     @method webView:makeFirstResponder:
258     @abstract Set the first responder for this window.
259     @param sender The WebView sending the delegate method.
260     @param responder The responder to make first (will always be a view)
261     @discussion responder will always be a view that is in the view
262     subhierarchy of the top-level web view for this WebView. If the
263     WebView's top level view is currently out of the view
264     hierarchy, it may be desirable to save the first responder
265     elsewhere, or possibly ignore this call.
266 */
267 - (void)webView:(WebView *)sender makeFirstResponder:(NSResponder *)responder;
268
269 /*!
270     @method webView:setStatusText:
271     @abstract Set the window's status display, if any, to the specified string.
272     @param sender The WebView sending the delegate method.
273     @param text The status text to set
274 */
275 - (void)webView:(WebView *)sender setStatusText:(NSString *)text;
276
277 /*!
278     @method webViewStatusText:
279     @abstract Get the currently displayed status text.
280     @param sender The WebView sending the delegate method.
281     @result The status text
282 */
283 - (NSString *)webViewStatusText:(WebView *)sender;
284
285 /*!
286     @method webViewAreToolbarsVisible:
287     @abstract Determine whether the window's toolbars are currently visible
288     @param sender The WebView sending the delegate method.
289     @discussion This method should return YES if the window has any
290     toolbars that are currently on, besides the status bar. If the app
291     has more than one toolbar per window, for example a regular
292     command toolbar and a favorites bar, it should return YES from
293     this method if at least one is on.
294     @result YES if at least one toolbar is visible, otherwise NO.
295 */
296 - (BOOL)webViewAreToolbarsVisible:(WebView *)sender;
297
298 /*!
299     @method webView:setToolbarsVisible:
300     @param sender The WebView sending the delegate method.
301     @abstract Set whether the window's toolbars are currently visible.
302     @param visible New value for toolbar visibility
303     @discussion Setting this to YES should turn on all toolbars
304     (except for a possible status bar). Setting it to NO should turn
305     off all toolbars (with the same exception).
306 */
307 - (void)webView:(WebView *)sender setToolbarsVisible:(BOOL)visible;
308
309 /*!
310     @method webViewIsStatusBarVisible:
311     @abstract Determine whether the status bar is visible.
312     @param sender The WebView sending the delegate method.
313     @result YES if the status bar is visible, otherwise NO.
314 */
315 - (BOOL)webViewIsStatusBarVisible:(WebView *)sender;
316
317 /*!
318     @method webView:setStatusBarVisible:
319     @abstract Set whether the status bar is currently visible.
320     @param visible The new visibility value
321     @discussion Setting this to YES should show the status bar,
322     setting it to NO should hide it.
323 */
324 - (void)webView:(WebView *)sender setStatusBarVisible:(BOOL)visible;
325
326 /*!
327     @method webViewIsResizable:
328     @abstract Determine whether the window is resizable or not.
329     @param sender The WebView sending the delegate method.
330     @result YES if resizable, NO if not.
331     @discussion If there are multiple views in the same window, they
332     have have their own separate resize controls and this may need to
333     be handled specially.
334 */
335 - (BOOL)webViewIsResizable:(WebView *)sender;
336
337 /*!
338     @method webView:setResizable:
339     @abstract Set the window to resizable or not
340     @param sender The WebView sending the delegate method.
341     @param resizable YES if the window should be made resizable, NO if not.
342     @discussion If there are multiple views in the same window, they
343     have have their own separate resize controls and this may need to
344     be handled specially.
345 */
346 - (void)webView:(WebView *)sender setResizable:(BOOL)resizable;
347
348 /*!
349     @method webView:setFrame:
350     @abstract Set the window's frame rect
351     @param sender The WebView sending the delegate method.
352     @param frame The new window frame size
353     @discussion Even though a caller could set the frame directly using the NSWindow,
354     this method is provided so implementors of this protocol can do special
355     things on programmatic move/resize, like avoiding autosaving of the size.
356 */
357 - (void)webView:(WebView *)sender setFrame:(NSRect)frame;
358
359 /*!
360     @method webViewFrame:
361     @param sender The WebView sending the delegate method.
362     @abstract REturn the window's frame rect
363     @discussion 
364 */
365 - (NSRect)webViewFrame:(WebView *)sender;
366
367 /*!
368     @method webView:runJavaScriptAlertPanelWithMessage:initiatedByFrame:
369     @abstract Display a JavaScript alert panel.
370     @param sender The WebView sending the delegate method.
371     @param message The message to display.
372     @param frame The WebFrame whose JavaScript initiated this call.
373     @discussion Clients should visually indicate that this panel comes
374     from JavaScript initiated by the specified frame. The panel should have 
375     a single OK button.
376 */
377 - (void)webView:(WebView *)sender runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WebFrame *)frame;
378
379 /*!
380     @method webView:runJavaScriptConfirmPanelWithMessage:initiatedByFrame:
381     @abstract Display a JavaScript confirm panel.
382     @param sender The WebView sending the delegate method.
383     @param message The message to display.
384     @param frame The WebFrame whose JavaScript initiated this call.
385     @result YES if the user hit OK, NO if the user chose Cancel.
386     @discussion Clients should visually indicate that this panel comes
387     from JavaScript initiated by the specified frame. The panel should have 
388     two buttons, e.g. "OK" and "Cancel".
389 */
390 - (BOOL)webView:(WebView *)sender runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WebFrame *)frame;
391
392 /*!
393     @method webView:runJavaScriptTextInputPanelWithPrompt:defaultText:initiatedByFrame:
394     @abstract Display a JavaScript text input panel.
395     @param sender The WebView sending the delegate method.
396     @param message The message to display.
397     @param defaultText The initial text for the text entry area.
398     @param frame The WebFrame whose JavaScript initiated this call.
399     @result The typed text if the user hit OK, otherwise nil.
400     @discussion Clients should visually indicate that this panel comes
401     from JavaScript initiated by the specified frame. The panel should have 
402     two buttons, e.g. "OK" and "Cancel", and an area to type text.
403 */
404 - (NSString *)webView:(WebView *)sender runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText initiatedByFrame:(WebFrame *)frame;
405
406 /*!
407     @method webView:runBeforeUnloadConfirmPanelWithMessage:initiatedByFrame:
408     @abstract Display a confirm panel by an "before unload" event handler.
409     @param sender The WebView sending the delegate method.
410     @param message The message to display.
411     @param frame The WebFrame whose JavaScript initiated this call.
412     @result YES if the user hit OK, NO if the user chose Cancel.
413     @discussion Clients should include a message in addition to the one
414     supplied by the web page that indicates. The panel should have 
415     two buttons, e.g. "OK" and "Cancel".
416 */
417 - (BOOL)webView:(WebView *)sender runBeforeUnloadConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WebFrame *)frame;
418
419 /*!
420     @method webView:runOpenPanelForFileButtonWithResultListener:
421     @abstract Display a file open panel for a file input control.
422     @param sender The WebView sending the delegate method.
423     @param resultListener The object to call back with the results.
424     @discussion This method is passed a callback object instead of giving a return
425     value so that it can be handled with a sheet.
426 */
427 - (void)webView:(WebView *)sender runOpenPanelForFileButtonWithResultListener:(id<WebOpenPanelResultListener>)resultListener;
428
429 /*!
430     @method webView:runOpenPanelForFileButtonWithResultListener:allowMultipleFiles
431     @abstract Display a file open panel for a file input control that may allow multiple files to be selected.
432     @param sender The WebView sending the delegate method.
433     @param resultListener The object to call back with the results.
434     @param allowMultipleFiles YES if the open panel should allow myltiple files to be selected, NO if not.
435     @discussion This method is passed a callback object instead of giving a return
436     value so that it can be handled with a sheet.
437 */
438 - (void)webView:(WebView *)sender runOpenPanelForFileButtonWithResultListener:(id<WebOpenPanelResultListener>)resultListener allowMultipleFiles:(BOOL)allowMultipleFiles WEBKIT_AVAILABLE_MAC(10_6);
439
440 /*!
441     @method webView:mouseDidMoveOverElement:modifierFlags:
442     @abstract Update the window's feedback for mousing over links to reflect a new item the mouse is over
443     or new modifier flags.
444     @param sender The WebView sending the delegate method.
445     @param elementInformation Dictionary that describes the element that the mouse is over, or nil.
446     @param modifierFlags The modifier flags as in NSEvent.
447 */
448 - (void)webView:(WebView *)sender mouseDidMoveOverElement:(NSDictionary *)elementInformation modifierFlags:(NSUInteger)modifierFlags;
449
450 /*!
451     @method webView:contextMenuItemsForElement:defaultMenuItems:
452     @abstract Returns the menu items to display in an element's contextual menu.
453     @param sender The WebView sending the delegate method.
454     @param element A dictionary representation of the clicked element.
455     @param defaultMenuItems An array of default NSMenuItems to include in all contextual menus.
456     @result An array of NSMenuItems to include in the contextual menu.
457 */
458 - (NSArray *)webView:(WebView *)sender contextMenuItemsForElement:(NSDictionary *)element defaultMenuItems:(NSArray *)defaultMenuItems;
459
460 #if !TARGET_OS_IPHONE
461 /*!
462     @method webView:validateUserInterfaceItem:defaultValidation:
463     @abstract Controls UI validation
464     @param webView The WebView sending the delegate method
465     @param item The user interface item being validated
466     @pararm defaultValidation Whether or not the WebView thinks the item is valid
467     @discussion This method allows the UI delegate to control WebView's validation of user interface items.
468     See WebView.h to see the methods to that WebView can currently validate. See NSUserInterfaceValidations and
469     NSValidatedUserInterfaceItem for information about UI validation.
470 */
471 - (BOOL)webView:(WebView *)webView validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)item defaultValidation:(BOOL)defaultValidation;
472 #endif
473
474 /*!
475     @method webView:shouldPerformAction:fromSender:
476     @abstract Controls actions
477     @param webView The WebView sending the delegate method
478     @param action The action being sent
479     @param sender The sender of the action
480     @discussion This method allows the UI delegate to control WebView's behavior when an action is being sent.
481     For example, if the action is copy:, the delegate can return YES to allow WebView to perform its default
482     copy behavior or return NO and perform copy: in some other way. See WebView.h to see the actions that
483     WebView can perform.
484 */
485 - (BOOL)webView:(WebView *)webView shouldPerformAction:(SEL)action fromSender:(id)sender;
486
487 #if !TARGET_OS_IPHONE
488 /*!
489     @method webView:dragDestinationActionMaskForDraggingInfo:
490     @abstract Controls behavior when dragging to a WebView
491     @param webView The WebView sending the delegate method
492     @param draggingInfo The dragging info of the drag
493     @discussion This method is called periodically as something is dragged over a WebView. The UI delegate can return a mask
494     indicating which drag destination actions can occur, WebDragDestinationActionAny to allow any kind of action or
495     WebDragDestinationActionNone to not accept the drag.
496 */
497 - (NSUInteger)webView:(WebView *)webView dragDestinationActionMaskForDraggingInfo:(id <NSDraggingInfo>)draggingInfo;
498
499 /*!
500     @method webView:willPerformDragDestinationAction:forDraggingInfo:
501     @abstract Informs that WebView will perform a drag destination action
502     @param webView The WebView sending the delegate method
503     @param action The drag destination action
504     @param draggingInfo The dragging info of the drag
505     @discussion This method is called after the last call to webView:dragDestinationActionMaskForDraggingInfo: after something is dropped on a WebView.
506     This method informs the UI delegate of the drag destination action that WebView will perform.
507 */
508 - (void)webView:(WebView *)webView willPerformDragDestinationAction:(WebDragDestinationAction)action forDraggingInfo:(id <NSDraggingInfo>)draggingInfo;
509
510 /*!
511     @method webView:dragSourceActionMaskForPoint:
512     @abstract Controls behavior when dragging from a WebView
513     @param webView The WebView sending the delegate method
514     @param point The point where the drag started in the coordinates of the WebView
515     @discussion This method is called after the user has begun a drag from a WebView. The UI delegate can return a mask indicating
516     which drag source actions can occur, WebDragSourceActionAny to allow any kind of action or WebDragSourceActionNone to not begin a drag.
517 */
518 - (NSUInteger)webView:(WebView *)webView dragSourceActionMaskForPoint:(NSPoint)point;
519
520 /*!
521     @method webView:willPerformDragSourceAction:fromPoint:withPasteboard:
522     @abstract Informs that a drag a has begun from a WebView
523     @param webView The WebView sending the delegate method
524     @param action The drag source action
525     @param point The point where the drag started in the coordinates of the WebView
526     @param pasteboard The drag pasteboard
527     @discussion This method is called after webView:dragSourceActionMaskForPoint: is called after the user has begun a drag from a WebView.
528     This method informs the UI delegate of the drag source action that will be performed and gives the delegate an opportunity to modify
529     the contents of the dragging pasteboard.
530 */
531 - (void)webView:(WebView *)webView willPerformDragSourceAction:(WebDragSourceAction)action fromPoint:(NSPoint)point withPasteboard:(NSPasteboard *)pasteboard;
532 #endif /* !TARGET_OS_IPHONE */
533
534 /*!
535     @method webView:printFrameView:
536     @abstract Informs that a WebFrameView needs to be printed
537     @param webView The WebView sending the delegate method
538     @param frameView The WebFrameView needing to be printed
539     @discussion This method is called when a script or user requests the page to be printed.
540     In this method the delegate can prepare the WebFrameView to be printed. Some content that WebKit
541     displays can be printed directly by the WebFrameView, other content will need to be handled by
542     the delegate. To determine if the WebFrameView can handle printing the delegate should check
543     WebFrameView's documentViewShouldHandlePrint, if YES then the delegate can call printDocumentView
544     on the WebFrameView. Otherwise the delegate will need to request a NSPrintOperation from
545     the WebFrameView's printOperationWithPrintInfo to handle the printing.
546 */
547 - (void)webView:(WebView *)sender printFrameView:(WebFrameView *)frameView;
548
549 /*!
550     @method webViewHeaderHeight:
551     @param webView The WebView sending the delegate method
552     @abstract Reserve a height for the printed page header.
553     @result The height to reserve for the printed page header, return 0.0 to not reserve any space for a header.
554     @discussion The height returned will be used to calculate the rect passed to webView:drawHeaderInRect:.
555 */
556 - (float)webViewHeaderHeight:(WebView *)sender;
557
558 /*!
559     @method webViewFooterHeight:
560     @param webView The WebView sending the delegate method
561     @abstract Reserve a height for the printed page footer.
562     @result The height to reserve for the printed page footer, return 0.0 to not reserve any space for a footer.
563     @discussion The height returned will be used to calculate the rect passed to webView:drawFooterInRect:.
564 */
565 - (float)webViewFooterHeight:(WebView *)sender;
566
567 /*!
568     @method webView:drawHeaderInRect:
569     @param webView The WebView sending the delegate method
570     @param rect The NSRect reserved for the header of the page
571     @abstract The delegate should draw a header for the sender in the supplied rect.
572 */
573 - (void)webView:(WebView *)sender drawHeaderInRect:(NSRect)rect;
574
575 /*!
576     @method webView:drawFooterInRect:
577     @param webView The WebView sending the delegate method
578     @param rect The NSRect reserved for the footer of the page
579     @abstract The delegate should draw a footer for the sender in the supplied rect.
580 */
581 - (void)webView:(WebView *)sender drawFooterInRect:(NSRect)rect;
582
583 // The following delegate methods are deprecated in favor of the ones above that specify
584 // the WebFrame whose JavaScript initiated this call.
585 - (void)webView:(WebView *)sender runJavaScriptAlertPanelWithMessage:(NSString *)message WEBKIT_DEPRECATED_MAC(10_3, 10_5);
586 - (BOOL)webView:(WebView *)sender runJavaScriptConfirmPanelWithMessage:(NSString *)message WEBKIT_DEPRECATED_MAC(10_3, 10_5);
587 - (NSString *)webView:(WebView *)sender runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText WEBKIT_DEPRECATED_MAC(10_3, 10_5);
588
589 // The following delegate methods are deprecated. Content rect calculations are now done automatically.
590 - (void)webView:(WebView *)sender setContentRect:(NSRect)frame WEBKIT_DEPRECATED_MAC(10_3, 10_5);
591 - (NSRect)webViewContentRect:(WebView *)sender WEBKIT_DEPRECATED_MAC(10_3, 10_5);
592
593 @end