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