Introduce MenuItemID to autofill popup
[WebKit-https.git] / Source / WebKit / chromium / public / WebAutofillClient.h
1 /*
2  * Copyright (C) 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebAutofillClient_h
32 #define WebAutofillClient_h
33
34 namespace WebKit {
35
36 class WebInputElement;
37 class WebKeyboardEvent;
38 class WebNode;
39 class WebString;
40
41 class WebAutofillClient {
42 public:
43     enum {
44         MenuItemIDAutocompleteEntry = 0,
45         MenuItemIDWarningMessage = -1,
46         MenuItemIDPasswordEntry = -2,
47         MenuItemIDSeparator = -3,
48         MenuItemIDClearForm = -4,
49         MenuItemIDAutofillOptions = -5,
50         MenuItemIDDataListEntry = -6
51     };
52
53     // Informs the browser that the user has accepted an Autofill suggestion for
54     // a WebNode. A positive |itemID| is a unique id used to identify the set
55     // of Autofill profiles. If it is AutocompleteEntryMenuItemID, then the
56     // suggestion is an Autocomplete suggestion; and |value| stores the
57     // suggested text. |index| is an index of the selected suggestion in the
58     // list of suggestions provided by the client.
59     virtual void didAcceptAutofillSuggestion(const WebNode&,
60                                              const WebString& value,
61                                              const WebString& label,
62                                              int itemID,
63                                              unsigned index) { }
64
65     // Informs the browser that the user has selected an Autofill suggestion for
66     // a WebNode.  This happens when the user hovers over a suggestion or uses
67     // the arrow keys to navigate to a suggestion.
68     virtual void didSelectAutofillSuggestion(const WebNode&,
69                                              const WebString& name,
70                                              const WebString& label,
71                                              int itemID) { }
72
73     // Informs the browser that the user has cleared the selection from the
74     // Autofill suggestions popup. This happens when a user uses the arrow
75     // keys to navigate outside the range of possible selections.
76     virtual void didClearAutofillSelection(const WebNode&) { }
77
78     // Instructs the browser to remove the Autocomplete entry specified from
79     // its DB.
80     virtual void removeAutocompleteSuggestion(const WebString& name,
81                                               const WebString& value) { }
82
83     // These methods are called when the users edits a text-field.
84     virtual void textFieldDidEndEditing(const WebInputElement&) { }
85     virtual void textFieldDidChange(const WebInputElement&) { }
86     virtual void textFieldDidReceiveKeyDown(const WebInputElement&, const WebKeyboardEvent&) { }
87
88 protected:
89     ~WebAutofillClient() { }
90 };
91
92 } // namespace WebKit
93
94 #endif