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