843dce5907ea77fd3c6905aadf1fb33c4b106284
[WebKit-https.git] / WebKit / WebView.subproj / WebUIDelegate.h
1 /*
2  * Copyright (C) 2003, 2004, 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 <Cocoa/Cocoa.h>
30 #import <Foundation/NSURLRequest.h>
31
32 /*!
33     @enum WebMenuItemTag
34     @discussion Each menu item in the default menu items array passed in
35     contextMenuItemsForElement:defaultMenuItems: has its tag set to one of the WebMenuItemTags.
36     When iterating through the default menu items array, use the tag to differentiate between them.
37 */
38
39 enum {
40     WebMenuItemTagOpenLinkInNewWindow=1,
41     WebMenuItemTagDownloadLinkToDisk,
42     WebMenuItemTagCopyLinkToClipboard,
43     WebMenuItemTagOpenImageInNewWindow,
44     WebMenuItemTagDownloadImageToDisk,
45     WebMenuItemTagCopyImageToClipboard,
46     WebMenuItemTagOpenFrameInNewWindow,
47     WebMenuItemTagCopy,
48     WebMenuItemTagGoBack,
49     WebMenuItemTagGoForward,
50     WebMenuItemTagStop,
51     WebMenuItemTagReload,
52     WebMenuItemTagCut,
53     WebMenuItemTagPaste,
54     WebMenuItemTagSpellingGuess,
55     WebMenuItemTagNoGuessesFound,
56     WebMenuItemTagIgnoreSpelling,
57     WebMenuItemTagLearnSpelling,
58     WebMenuItemTagOther
59 };
60
61 /*!
62     @enum WebDragDestinationAction
63     @abstract Actions that the destination of a drag can perform.
64     @constant WebDragDestinationActionNone No action
65     @constant WebDragDestinationActionDHTML Allows DHTML (such as JavaScript) to handle the drag
66     @constant WebDragDestinationActionEdit Allows editable documents to be edited from the drag
67     @constant WebDragDestinationActionLoad Allows a location change from the drag
68     @constant WebDragDestinationActionAny Allows any of the above to occur
69 */
70 typedef enum {
71     WebDragDestinationActionNone    = 0,
72     WebDragDestinationActionDHTML   = 1,
73     WebDragDestinationActionEdit    = 2,
74     WebDragDestinationActionLoad    = 4,
75     WebDragDestinationActionAny     = UINT_MAX
76 } WebDragDestinationAction;
77
78 /*!
79     @enum WebDragSourceAction
80     @abstract Actions that the source of a drag can perform.
81     @constant WebDragSourceActionNone No action
82     @constant WebDragSourceActionDHTML Allows DHTML (such as JavaScript) to start a drag
83     @constant WebDragSourceActionImage Allows an image drag to occur
84     @constant WebDragSourceActionLink Allows a link drag to occur
85     @constant WebDragSourceActionSelection Allows a selection drag to occur
86     @constant WebDragSourceActionAny Allows any of the above to occur
87 */
88 typedef enum {
89     WebDragSourceActionNone         = 0,
90     WebDragSourceActionDHTML        = 1,
91     WebDragSourceActionImage        = 2,
92     WebDragSourceActionLink         = 4,
93     WebDragSourceActionSelection    = 8,
94     WebDragSourceActionAny          = UINT_MAX
95 } WebDragSourceAction;
96
97 /*!
98     @protocol WebOpenPanelResultListener
99     @discussion This protocol is used to call back with the results of
100     the file open panel requested by runOpenPanelForFileButtonWithResultListener:
101 */
102 @protocol WebOpenPanelResultListener <NSObject>
103
104 /*!
105     @method chooseFilename:
106     @abstract Call this method to return a filename from the file open panel.
107     @param fileName
108 */
109 - (void)chooseFilename:(NSString *)fileName;
110
111 /*!
112     @method cancel
113     @abstract Call this method to indicate that the file open panel was cancelled.
114 */
115 - (void)cancel;
116
117 @end
118
119 @class WebView;
120
121 /*!
122     @category WebUIDelegate
123     @discussion A class that implements WebUIDelegate provides
124     window-related methods that may be used by Javascript, plugins and
125     other aspects of web pages. These methods are used to open new
126     windows and control aspects of existing windows.
127 */
128 @interface NSObject (WebUIDelegate)
129
130 /*!
131     @method webView:createWebViewWithRequest:
132     @abstract Create a new window and begin to load the specified request.
133     @discussion The newly created window is hidden, and the window operations delegate on the
134     new WebViews will get a webViewShow: call.
135     @param sender The WebView sending the delegate method.
136     @param request The request to load.
137     @result The WebView for the new window.
138 */
139 - (WebView *)webView:(WebView *)sender createWebViewWithRequest:(NSURLRequest *)request;
140
141 /*!
142     @method webViewShow:
143     @param sender The WebView sending the delegate method.
144     @abstract Show the window that contains the top level view of the WebView,
145     ordering it frontmost.
146     @discussion This will only be called just after createWindowWithRequest:
147     is used to create a new window.
148 */
149 - (void)webViewShow:(WebView *)sender;
150
151 /*!
152     @method webViewClose:
153     @abstract Close the current window. 
154     @param sender The WebView sending the delegate method.
155     @discussion Clients showing multiple views in one window may
156     choose to close only the one corresponding to this
157     WebView. Other clients may choose to ignore this method
158     entirely.
159 */
160 - (void)webViewClose:(WebView *)sender;
161
162 /*!
163     @method webViewFocus:
164     @abstract Focus the current window (i.e. makeKeyAndOrderFront:).
165     @param The WebView sending the delegate method.
166     @discussion Clients showing multiple views in one window may want to
167     also do something to focus the one corresponding to this WebView.
168 */
169 - (void)webViewFocus:(WebView *)sender;
170
171 /*!
172     @method webViewUnfocus:
173     @abstract Unfocus the current window.
174     @param sender The WebView sending the delegate method.
175     @discussion Clients showing multiple views in one window may want to
176     also do something to unfocus the one corresponding to this WebView.
177 */
178 - (void)webViewUnfocus:(WebView *)sender;
179
180 /*!
181     @method webViewFirstResponder:
182     @abstract Get the first responder for this window.
183     @param sender The WebView sending the delegate method.
184     @discussion This method should return the focused control in the
185     WebView's view, if any. If the view is out of the window
186     hierarchy, this might return something than calling firstResponder
187     on the real NSWindow would. It's OK to return either nil or the
188     real first responder if some control not in the window has focus.
189 */
190 - (NSResponder *)webViewFirstResponder:(WebView *)sender;
191
192 /*!
193     @method webView:makeFirstResponder:
194     @abstract Set the first responder for this window.
195     @param sender The WebView sending the delegate method.
196     @param responder The responder to make first (will always be a view)
197     @discussion responder will always be a view that is in the view
198     subhierarchy of the top-level web view for this WebView. If the
199     WebView's top level view is currently out of the view
200     hierarchy, it may be desirable to save the first responder
201     elsewhere, or possibly ignore this call.
202 */
203 - (void)webView:(WebView *)sender makeFirstResponder:(NSResponder *)responder;
204
205 /*!
206     @method webView:setStatusText:
207     @abstract Set the window's status display, if any, to the specified string.
208     @param sender The WebView sending the delegate method.
209     @param text The status text to set
210 */
211 - (void)webView:(WebView *)sender setStatusText:(NSString *)text;
212
213 /*!
214     @method webViewStatusText:
215     @abstract Get the currently displayed status text.
216     @param sender The WebView sending the delegate method.
217     @result The status text
218 */
219 - (NSString *)webViewStatusText:(WebView *)sender;
220
221 /*!
222     @method webViewAreToolbarsVisible:
223     @abstract Determine whether the window's toolbars are currently visible
224     @param sender The WebView sending the delegate method.
225     @discussion This method should return YES if the window has any
226     toolbars that are currently on, besides the status bar. If the app
227     has more than one toolbar per window, for example a regular
228     command toolbar and a favorites bar, it should return YES from
229     this method if at least one is on.
230     @result YES if at least one toolbar is visible, otherwise NO.
231 */
232 - (BOOL)webViewAreToolbarsVisible:(WebView *)sender;
233
234 /*!
235     @method webView:setToolbarsVisible:
236     @param sender The WebView sending the delegate method.
237     @abstract Set whether the window's toolbars are currently visible.
238     @param visible New value for toolbar visibility
239     @discussion Setting this to YES should turn on all toolbars
240     (except for a possible status bar). Setting it to NO should turn
241     off all toolbars (with the same exception).
242 */
243 - (void)webView:(WebView *)sender setToolbarsVisible:(BOOL)visible;
244
245 /*!
246     @method webViewIsStatusBarVisible:
247     @abstract Determine whether the status bar is visible.
248     @param sender The WebView sending the delegate method.
249     @result YES if the status bar is visible, otherwise NO.
250 */
251 - (BOOL)webViewIsStatusBarVisible:(WebView *)sender;
252
253 /*!
254     @method webView:setStatusBarVisible:
255     @abstract Set whether the status bar is currently visible.
256     @param visible The new visibility value
257     @discussion Setting this to YES should show the status bar,
258     setting it to NO should hide it.
259 */
260 - (void)webView:(WebView *)sender setStatusBarVisible:(BOOL)visible;
261
262 /*!
263     @method webViewIsResizable:
264     @abstract Determine whether the window is resizable or not.
265     @param sender The WebView sending the delegate method.
266     @result YES if resizable, NO if not.
267     @discussion If there are multiple views in the same window, they
268     have have their own separate resize controls and this may need to
269     be handled specially.
270 */
271 - (BOOL)webViewIsResizable:(WebView *)sender;
272
273 /*!
274     @method webView:setResizable:
275     @abstract Set the window to resizable or not
276     @param sender The WebView sending the delegate method.
277     @param resizable YES if the window should be made resizable, NO if not.
278     @discussion If there are multiple views in the same window, they
279     have have their own separate resize controls and this may need to
280     be handled specially.
281 */
282 - (void)webView:(WebView *)sender setResizable:(BOOL)resizable;
283
284 /*!
285     @method webView:setFrame:
286     @abstract Set the window's frame rect
287     @param sender The WebView sending the delegate method.
288     @param frame The new window frame size
289     @discussion Even though a caller could set the frame directly using the NSWindow,
290     this method is provided so implementors of this protocol can do special
291     things on programmatic move/resize, like avoiding autosaving of the size.
292 */
293 - (void)webView:(WebView *)sender setFrame:(NSRect)frame;
294
295 /*!
296     @method webViewFrame:
297     @param sender The WebView sending the delegate method.
298     @abstract REturn the window's frame rect
299     @discussion 
300 */
301 - (NSRect)webViewFrame:(WebView *)sender;
302
303 /*!
304     @method webView:setContentRect:
305     @abstract Set the window's content rect
306     @param sender The WebView sending the delegate method.
307     @param frame The new window content rect
308     @discussion Even though a caller could set the content rect
309     directly using the NSWindow, this method is provided so
310     implementors of this protocol can do special things on
311     programmatic move/resize, like avoiding autosaving of the size.
312 */
313 - (void)webView:(WebView *)sender setContentRect:(NSRect)contentRect;
314
315 /*!
316     @method webViewContentRect:
317     @abstract Return the window's content rect
318     @discussion 
319 */
320 - (NSRect)webViewContentRect:(WebView *)sender;
321
322 /*!
323     @method webView:runJavaScriptAlertPanelWithMessage:
324     @abstract Display a JavaScript alert panel
325     @param sender The WebView sending the delegate method.
326     @param message The message to display
327     @discussion Clients should visually indicate that this panel comes
328     from JavaScript. The panel should have a single OK button.
329 */
330 - (void)webView:(WebView *)sender runJavaScriptAlertPanelWithMessage:(NSString *)message;
331
332 /*!
333     @method webView:runJavaScriptConfirmPanelWithMessage:
334     @abstract Display a JavaScript confirm panel
335     @param sender The WebView sending the delegate method.
336     @param message The message to display
337     @result YES if the user hit OK, no if the user chose Cancel.
338     @discussion Clients should visually indicate that this panel comes
339     from JavaScript. The panel should have two buttons, e.g. "OK" and
340     "Cancel".
341 */
342 - (BOOL)webView:(WebView *)sender runJavaScriptConfirmPanelWithMessage:(NSString *)message;
343
344 /*!
345     @method webView:runJavaScriptTextInputPanelWithPrompt:defaultText:
346     @abstract Display a JavaScript text input panel
347     @param sender The WebView sending the delegate method.
348     @param message The message to display
349     @param defaultText The initial text for the text entry area.
350     @result The typed text if the user hit OK, otherwise nil.
351     @discussion Clients should visually indicate that this panel comes
352     from JavaScript. The panel should have two buttons, e.g. "OK" and
353     "Cancel", and an area to type text.
354 */
355 - (NSString *)webView:(WebView *)sender runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText;
356
357 /*!
358     @method webView:runOpenPanelForFileButtonWithResultListener:
359     @abstract Display a file open panel for a file input control.
360     @param sender The WebView sending the delegate method.
361     @param resultListener The object to call back with the results.
362     @discussion This method is passed a callback object instead of giving a return
363     value so that it can be handled with a sheet.
364 */
365 - (void)webView:(WebView *)sender runOpenPanelForFileButtonWithResultListener:(id<WebOpenPanelResultListener>)resultListener;
366
367 /*!
368     @method webView:mouseDidMoveOverElement:modifierFlags:
369     @abstract Update the window's feedback for mousing over links to reflect a new item the mouse is over
370     or new modifier flags.
371     @param sender The WebView sending the delegate method.
372     @param elementInformation Dictionary that describes the element that the mouse is over, or nil.
373     @param modifierFlags The modifier flags as in NSEvent.
374 */
375 - (void)webView:(WebView *)sender mouseDidMoveOverElement:(NSDictionary *)elementInformation modifierFlags:(unsigned int)modifierFlags;
376
377 /*!
378     @method webView:contextMenuItemsForElement:defaultMenuItems:
379     @abstract Returns the menu items to display in an element's contextual menu.
380     @param sender The WebView sending the delegate method.
381     @param element A dictionary representation of the clicked element.
382     @param defaultMenuItems An array of default NSMenuItems to include in all contextual menus.
383     @result An array of NSMenuItems to include in the contextual menu.
384 */
385 - (NSArray *)webView:(WebView *)sender contextMenuItemsForElement:(NSDictionary *)element defaultMenuItems:(NSArray *)defaultMenuItems;
386
387 /*!
388     @method webView:validateUserInterfaceItem:defaultValidation:
389     @abstract Controls UI validation
390     @param webView The WebView sending the delegate method
391     @param item The user interface item being validated
392     @pararm defaultValidation Whether or not the WebView thinks the item is valid
393     @discussion This method allows the UI delegate to control WebView's validation of user interface items.
394     See WebView.h to see the methods to that WebView can currently validate. See NSUserInterfaceValidations and
395     NSValidatedUserInterfaceItem for information about UI validation.
396 */
397 - (BOOL)webView:(WebView *)webView validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)item defaultValidation:(BOOL)defaultValidation;
398
399 /*!
400     @method webView:shouldPerformAction:fromSender:
401     @abstract Controls actions
402     @param webView The WebView sending the delegate method
403     @param action The action being sent
404     @param sender The sender of the action
405     @discussion This method allows the UI delegate to control WebView's behavior when an action is being sent.
406     For example, if the action is copy:, the delegate can return YES to allow WebView to perform its default
407     copy behavior or return NO and perform copy: in some other way. See WebView.h to see the actions that
408     WebView can perform.
409 */
410 - (BOOL)webView:(WebView *)webView shouldPerformAction:(SEL)action fromSender:(id)sender;
411
412 /*!
413     @method webView:dragDestinationActionMaskForDraggingInfo:
414     @abstract Controls behavior when dragging to a WebView
415     @param webView The WebView sending the delegate method
416     @param draggingInfo The dragging info of the drag
417     @discussion This method is called periodically as something is dragged over a WebView. The UI delegate can return a mask
418     indicating which drag destination actions can occur, WebDragDestinationActionAny to allow any kind of action or
419     WebDragDestinationActionNone to not accept the drag.
420 */
421 - (unsigned)webView:(WebView *)webView dragDestinationActionMaskForDraggingInfo:(id <NSDraggingInfo>)draggingInfo;
422
423 /*!
424     @method webView:willPerformDragDestinationAction:forDraggingInfo:
425     @abstract Informs that WebView will perform a drag destination action
426     @param webView The WebView sending the delegate method
427     @param action The drag destination action
428     @param draggingInfo The dragging info of the drag
429     @discussion This method is called after the last call to webView:dragDestinationActionMaskForDraggingInfo: after something is dropped on a WebView.
430     This method informs the UI delegate of the drag destination action that WebView will perform.
431 */
432 - (void)webView:(WebView *)webView willPerformDragDestinationAction:(WebDragDestinationAction)action forDraggingInfo:(id <NSDraggingInfo>)draggingInfo;
433
434 /*!
435     @method webView:dragSourceActionMaskForPoint:
436     @abstract Controls behavior when dragging from a WebView
437     @param webView The WebView sending the delegate method
438     @param point The point where the drag started in the coordinates of the WebView
439     @discussion This method is called after the user has begun a drag from a WebView. The UI delegate can return a mask indicating
440     which drag source actions can occur, WebDragSourceActionAny to allow any kind of action or WebDragSourceActionNone to not begin a drag.
441 */
442 - (unsigned)webView:(WebView *)webView dragSourceActionMaskForPoint:(NSPoint)point;
443
444 /*!
445     @method webView:willPerformDragSourceAction:fromPoint:withPasteboard:
446     @abstract Informs that a drag a has begun from a WebView
447     @param webView The WebView sending the delegate method
448     @param action The drag source action
449     @param point The point where the drag started in the coordinates of the WebView
450     @param pasteboard The drag pasteboard
451     @discussion This method is called after webView:dragSourceActionMaskForPoint: is called after the user has begun a drag from a WebView.
452     This method informs the UI delegate of the drag source action that will be performed and gives the delegate an opportunity to modify
453     the contents of the dragging pasteboard.
454 */
455 - (void)webView:(WebView *)webView willPerformDragSourceAction:(WebDragSourceAction)action fromPoint:(NSPoint)point withPasteboard:(NSPasteboard *)pasteboard;
456
457 @end