autofill_dialog_controller.h revision 868fa2fe829687343ffae624259930155e16dbd8
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_ 6#define CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_ 7 8#include <vector> 9 10#include "base/string16.h" 11#include "chrome/browser/ui/autofill/autofill_dialog_types.h" 12#include "components/autofill/browser/field_types.h" 13#include "components/autofill/content/browser/wallet/required_action.h" 14#include "ui/base/range/range.h" 15#include "ui/base/ui_base_types.h" 16#include "ui/gfx/image/image.h" 17#include "ui/gfx/native_widget_types.h" 18 19class Profile; 20 21namespace content { 22class WebContents; 23struct NativeWebKeyboardEvent; 24} 25 26namespace gfx { 27class Rect; 28} 29 30namespace ui { 31class ComboboxModel; 32class MenuModel; 33} 34 35namespace autofill { 36 37// This class defines the interface to the controller that the dialog view sees. 38class AutofillDialogController { 39 public: 40 // Strings ------------------------------------------------------------------- 41 42 virtual string16 DialogTitle() const = 0; 43 virtual string16 AccountChooserText() const = 0; 44 virtual string16 SignInLinkText() const = 0; 45 virtual string16 EditSuggestionText() const = 0; 46 virtual string16 CancelButtonText() const = 0; 47 virtual string16 ConfirmButtonText() const = 0; 48 virtual string16 SaveLocallyText() const = 0; 49 virtual string16 ProgressBarText() const = 0; 50 virtual string16 LegalDocumentsText() = 0; 51 52 // State --------------------------------------------------------------------- 53 54 // Whether the user is known to be signed in. 55 virtual DialogSignedInState SignedInState() const = 0; 56 57 // Whether the dialog is in a not exactly well-defined state 58 // (while attempting to sign-in or retrieving the wallet data etc). 59 virtual bool ShouldShowSpinner() const = 0; 60 61 // Whether to show the checkbox to save data locally (in Autofill). 62 virtual bool ShouldOfferToSaveInChrome() const = 0; 63 64 // Returns the model for the account chooser. It will return NULL if the 65 // account chooser should not show a menu. In this case, clicking on the 66 // account chooser should initiate sign-in. 67 virtual ui::MenuModel* MenuModelForAccountChooser() = 0; 68 69 // Returns the icon that should be shown in the account chooser. 70 virtual gfx::Image AccountChooserImage() = 0; 71 72 // Whether or not the details container should be showing currently. 73 virtual bool ShouldShowDetailArea() const = 0; 74 75 // Whether or not the progress bar in the button strip should be showing. 76 virtual bool ShouldShowProgressBar() const = 0; 77 78 // Which dialog buttons should be visible. 79 virtual int GetDialogButtons() const = 0; 80 81 // Whether or not the |button| should be enabled. 82 virtual bool IsDialogButtonEnabled(ui::DialogButton button) const = 0; 83 84 // Returns ranges to linkify in the text returned by |LegalDocumentsText()|. 85 virtual const std::vector<ui::Range>& LegalDocumentLinks() = 0; 86 87 // Detail inputs ------------------------------------------------------------- 88 89 // Whether the section is currently active (i.e. should be shown). 90 virtual bool SectionIsActive(DialogSection section) const = 0; 91 92 // Returns the set of inputs the page has requested which fall under 93 // |section|. 94 virtual const DetailInputs& RequestedFieldsForSection(DialogSection section) 95 const = 0; 96 97 // Returns the combobox model for inputs of type |type|, or NULL if the input 98 // should be a text field. 99 virtual ui::ComboboxModel* ComboboxModelForAutofillType( 100 AutofillFieldType type) = 0; 101 102 // Returns the model for suggestions for fields that fall under |section|. 103 // This may return NULL, in which case no menu should be shown for that 104 // section. 105 virtual ui::MenuModel* MenuModelForSection(DialogSection section) = 0; 106 107#if defined(OS_ANDROID) 108 // As the above, but will never return NULL. TODO(estade): android should 109 // stop relying on this and it should be removed. 110 virtual ui::MenuModel* MenuModelForSectionHack(DialogSection section) = 0; 111#endif 112 113 // Returns the label text used to describe the section (i.e. Billing). 114 virtual string16 LabelForSection(DialogSection section) const = 0; 115 116 // Returns the current state of suggestions for |section|. 117 virtual SuggestionState SuggestionStateForSection(DialogSection section) = 0; 118 119 // Should be called when the user starts editing of the section. 120 virtual void EditClickedForSection(DialogSection section) = 0; 121 122 // Should be called when the user cancels editing of the section. 123 virtual void EditCancelledForSection(DialogSection section) = 0; 124 125 // Returns an icon to be displayed along with the input for the given type. 126 // |user_input| is the current text in the textfield. 127 virtual gfx::Image IconForField(AutofillFieldType type, 128 const string16& user_input) const = 0; 129 130 // Decides whether input of |value| is valid for a field of type |type|. If 131 // valid, the returned string will be empty. Otherwise it will contain an 132 // error message. 133 virtual string16 InputValidityMessage(AutofillFieldType type, 134 const string16& value) const = 0; 135 136 137 // Decides whether the combination of all |inputs| is valid, returns a 138 // map of field types to error strings. 139 virtual ValidityData InputsAreValid( 140 const DetailOutputMap& inputs, ValidationType validation_type) const = 0; 141 142 // Called when the user changes the contents of a text field or activates it 143 // (by focusing and then clicking it). |was_edit| is true when the function 144 // was called in response to the user editing the text field. 145 virtual void UserEditedOrActivatedInput(const DetailInput* input, 146 gfx::NativeView parent_view, 147 const gfx::Rect& content_bounds, 148 const string16& field_contents, 149 bool was_edit) = 0; 150 151 // The view forwards keypresses in text inputs. Returns true if there should 152 // be no further processing of the event. 153 virtual bool HandleKeyPressEventInInput( 154 const content::NativeWebKeyboardEvent& event) = 0; 155 156 // Called when focus has changed position within the view. 157 virtual void FocusMoved() = 0; 158 159 // Miscellany ---------------------------------------------------------------- 160 161 // Called when the view has been closed. 162 virtual void ViewClosed() = 0; 163 164 // Returns dialog notifications that the view should currently be showing in 165 // order from top to bottom. 166 virtual std::vector<DialogNotification> CurrentNotifications() = 0; 167 168 // Begins or aborts the flow to sign into Wallet. 169 virtual void SignInLinkClicked() = 0; 170 171 // Called when a checkbox in the notification area has changed its state. 172 virtual void NotificationCheckboxStateChanged(DialogNotification::Type type, 173 bool checked) = 0; 174 175 // A legal document link has been clicked. 176 virtual void LegalDocumentLinkClicked(const ui::Range& range) = 0; 177 178 // Called when the view has been cancelled. 179 virtual void OnCancel() = 0; 180 181 // Called when the view has been accepted. This could be to submit the payment 182 // info or to handle a required action. 183 virtual void OnAccept() = 0; 184 185 // Returns the profile for this dialog. 186 virtual Profile* profile() = 0; 187 188 // The web contents that prompted the dialog. 189 virtual content::WebContents* web_contents() = 0; 190 191 protected: 192 virtual ~AutofillDialogController(); 193}; 194 195} // namespace autofill 196 197#endif // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_ 198