Enable -Wcast-qual for WebInspectorUI, WebKitLegacy, WebKit projects
[WebKit-https.git] / Source / WebKitLegacy / mac / WebView / WebFormDelegate.h
1 /*
2  * Copyright (C) 2003, 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
31 #if !TARGET_OS_IPHONE
32 #import <AppKit/AppKit.h>
33 #endif
34
35 @class DOMElement;
36 @class DOMHTMLFormElement;
37 @class DOMHTMLInputElement;
38 @class DOMHTMLTextAreaElement;
39 #if TARGET_OS_IPHONE
40 @class DOMNode;
41 #endif
42 @class WebFrame;
43
44 /*!
45     @protocol  WebFormSubmissionListener
46 */
47 @protocol WebFormSubmissionListener <NSObject>
48 - (void)continue;
49 @end
50
51 /*!
52     @protocol  WebFormDelegate
53 */
54 @protocol WebFormDelegate <NSObject>
55
56 // Various methods send by controls that edit text to their delegates, which are all
57 // analogous to similar methods in AppKit/NSControl.h.
58 // These methods are forwarded from widgets used in forms to the WebFormDelegate.
59
60 - (void)textFieldDidBeginEditing:(DOMHTMLInputElement *)element inFrame:(WebFrame *)frame;
61 - (void)textFieldDidEndEditing:(DOMHTMLInputElement *)element inFrame:(WebFrame *)frame;
62 - (void)textDidChangeInTextField:(DOMHTMLInputElement *)element inFrame:(WebFrame *)frame;
63 - (void)textDidChangeInTextArea:(DOMHTMLTextAreaElement *)element inFrame:(WebFrame *)frame;
64 - (void)didFocusTextField:(DOMHTMLInputElement *)element inFrame:(WebFrame *)frame;
65
66 - (BOOL)textField:(DOMHTMLInputElement *)element doCommandBySelector:(SEL)commandSelector inFrame:(WebFrame *)frame;
67 #if !TARGET_OS_IPHONE
68 - (BOOL)textField:(DOMHTMLInputElement *)element shouldHandleEvent:(NSEvent *)event inFrame:(WebFrame *)frame;
69 #endif
70 // Sent when a form is just about to be submitted (before the load is started)
71 // listener must be sent continue when the delegate is done.
72 - (void)frame:(WebFrame *)frame sourceFrame:(WebFrame *)sourceFrame willSubmitForm:(DOMElement *)form
73     withValues:(NSDictionary *)values submissionListener:(id <WebFormSubmissionListener>)listener;
74
75 - (void)willSendSubmitEventToForm:(DOMHTMLFormElement *)element inFrame:(WebFrame *)sourceFrame withValues:(NSDictionary *)values;
76
77 @end
78
79 /*!
80     @class WebFormDelegate
81     @discussion The WebFormDelegate class responds to all WebFormDelegate protocol
82     methods by doing nothing. It's provided for the convenience of clients who only want
83     to implement some of the above methods and ignore others.
84 */
85 @interface WebFormDelegate : NSObject <WebFormDelegate>
86 @end