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
34namespace WebKit {
35
36class WebFormElement;
37class WebFrame;
38class WebInputElement;
39class WebKeyboardEvent;
40class WebNode;
41class WebString;
42
43template <typename T> class WebVector;
44
45class WebAutofillClient {
46public:
47    enum {
48        MenuItemIDAutocompleteEntry = 0,
49        MenuItemIDWarningMessage = -1,
50        MenuItemIDPasswordEntry = -2,
51        MenuItemIDSeparator = -3,
52        MenuItemIDClearForm = -4,
53        MenuItemIDAutofillOptions = -5,
54        MenuItemIDDataListEntry = -6
55    };
56
57    // Informs the browser that the user has accepted an Autofill suggestion for
58    // a WebNode. A positive |itemID| is a unique id used to identify the set
59    // of Autofill profiles. If it is AutocompleteEntryMenuItemID, then the
60    // suggestion is an Autocomplete suggestion; and |value| stores the
61    // suggested text. |index| is an index of the selected suggestion in the
62    // list of suggestions provided by the client.
63    virtual void didAcceptAutofillSuggestion(const WebNode&,
64                                             const WebString& value,
65                                             const WebString& label,
66                                             int itemID,
67                                             unsigned index) { }
68
69    // Informs the browser that the user has selected an Autofill suggestion for
70    // a WebNode.  This happens when the user hovers over a suggestion or uses
71    // the arrow keys to navigate to a suggestion.
72    virtual void didSelectAutofillSuggestion(const WebNode&,
73                                             const WebString& name,
74                                             const WebString& label,
75                                             int itemID) { }
76
77    // Informs the browser that the user has cleared the selection from the
78    // Autofill suggestions popup. This happens when a user uses the arrow
79    // keys to navigate outside the range of possible selections.
80    virtual void didClearAutofillSelection(const WebNode&) { }
81
82    // Informs the browser an interactive autocomplete has been requested.
83    virtual void didRequestAutocomplete(WebFrame*, const WebFormElement&) { }
84
85    // Instructs the browser to remove the Autocomplete entry specified from
86    // its DB.
87    virtual void removeAutocompleteSuggestion(const WebString& name,
88                                              const WebString& value) { }
89
90    // These methods are called when the users edits a text-field.
91    virtual void textFieldDidEndEditing(const WebInputElement&) { }
92    virtual void textFieldDidChange(const WebInputElement&) { }
93    virtual void textFieldDidReceiveKeyDown(const WebInputElement&, const WebKeyboardEvent&) { }
94
95    // Informs the client whether or not any subsequent text changes should be ignored.
96    virtual void setIgnoreTextChanges(bool ignore) { }
97
98    virtual void didAssociateFormControls(const WebVector<WebNode>&) { }
99
100protected:
101    virtual ~WebAutofillClient() { }
102};
103
104} // namespace WebKit
105
106#endif
107