autofill_dialog_controller.h revision 2385ea399aae016c0806a4f9ef3c9cfe3d2a39df 
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
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 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  // Returns the image that should be shown on the left of the button strip
78  // or an empty image if none should be shown.
79  virtual gfx::Image ButtonStripImage() const = 0;
80
81  // Which dialog buttons should be visible.
82  virtual int GetDialogButtons() const = 0;
83
84  // Whether or not the |button| should be enabled.
85  virtual bool IsDialogButtonEnabled(ui::DialogButton button) const = 0;
86
87  // Returns a struct full of data concerning what overlay, if any, should be
88  // displayed on top of the dialog.
89  virtual DialogOverlayState GetDialogOverlay() const = 0;
90
91  // Returns ranges to linkify in the text returned by |LegalDocumentsText()|.
92  virtual const std::vector<ui::Range>& LegalDocumentLinks() = 0;
93
94  // Detail inputs -------------------------------------------------------------
95
96  // Whether the section is currently active (i.e. should be shown).
97  virtual bool SectionIsActive(DialogSection section) const = 0;
98
99  // Returns the set of inputs the page has requested which fall under
100  // |section|.
101  virtual const DetailInputs& RequestedFieldsForSection(DialogSection section)
102      const = 0;
103
104  // Returns the combobox model for inputs of type |type|, or NULL if the input
105  // should be a text field.
106  virtual ui::ComboboxModel* ComboboxModelForAutofillType(
107      AutofillFieldType type) = 0;
108
109  // Returns the model for suggestions for fields that fall under |section|.
110  // This may return NULL, in which case no menu should be shown for that
111  // section.
112  virtual ui::MenuModel* MenuModelForSection(DialogSection section) = 0;
113
114#if defined(OS_ANDROID)
115  // As the above, but will never return NULL. TODO(estade): android should
116  // stop relying on this and it should be removed.
117  virtual ui::MenuModel* MenuModelForSectionHack(DialogSection section) = 0;
118#endif
119
120  // Returns the label text used to describe the section (i.e. Billing).
121  virtual string16 LabelForSection(DialogSection section) const = 0;
122
123  // Returns the current state of suggestions for |section|.
124  virtual SuggestionState SuggestionStateForSection(DialogSection section) = 0;
125
126  // Should be called when the user starts editing of the section.
127  virtual void EditClickedForSection(DialogSection section) = 0;
128
129  // Should be called when the user cancels editing of the section.
130  virtual void EditCancelledForSection(DialogSection section) = 0;
131
132  // Returns an icon to be displayed along with the input for the given type.
133  // |user_input| is the current text in the textfield.
134  virtual gfx::Image IconForField(AutofillFieldType type,
135                                  const string16& user_input) const = 0;
136
137  // Decides whether input of |value| is valid for a field of type |type|. If
138  // valid, the returned string will be empty. Otherwise it will contain an
139  // error message.
140  virtual string16 InputValidityMessage(DialogSection section,
141                                        AutofillFieldType type,
142                                        const string16& value) = 0;
143
144
145  // Decides whether the combination of all |inputs| is valid, returns a
146  // map of field types to error strings.
147  virtual ValidityData InputsAreValid(
148      DialogSection section,
149      const DetailOutputMap& inputs,
150      ValidationType validation_type) = 0;
151
152  // Called when the user changes the contents of a text field or activates it
153  // (by focusing and then clicking it). |was_edit| is true when the function
154  // was called in response to the user editing the text field.
155  virtual void UserEditedOrActivatedInput(DialogSection section,
156                                          const DetailInput* input,
157                                          gfx::NativeView parent_view,
158                                          const gfx::Rect& content_bounds,
159                                          const string16& field_contents,
160                                          bool was_edit) = 0;
161
162  // The view forwards keypresses in text inputs. Returns true if there should
163  // be no further processing of the event.
164  virtual bool HandleKeyPressEventInInput(
165      const content::NativeWebKeyboardEvent& event) = 0;
166
167  // Called when focus has changed position within the view.
168  virtual void FocusMoved() = 0;
169
170  // Miscellany ----------------------------------------------------------------
171
172  // The image to show in the splash screen when the dialog is first shown. If
173  // no splash screen should be shown, this image will be empty.
174  virtual gfx::Image SplashPageImage() const = 0;
175
176  // Called when the view has been closed.
177  virtual void ViewClosed() = 0;
178
179  // Returns dialog notifications that the view should currently be showing in
180  // order from top to bottom.
181  virtual std::vector<DialogNotification> CurrentNotifications() = 0;
182
183  // Returns Autocheckout steps that the view should currently be showing in
184  // order from first to last.
185  virtual std::vector<DialogAutocheckoutStep> CurrentAutocheckoutSteps()
186      const = 0;
187
188  // Begins or aborts the flow to sign into Wallet.
189  virtual void SignInLinkClicked() = 0;
190
191  // Called when a checkbox in the notification area has changed its state.
192  virtual void NotificationCheckboxStateChanged(DialogNotification::Type type,
193                                                bool checked) = 0;
194
195  // A legal document link has been clicked.
196  virtual void LegalDocumentLinkClicked(const ui::Range& range) = 0;
197
198  // A button in the dialog's overlay has been pressed.
199  virtual void OverlayButtonPressed() = 0;
200
201  // Called when the view has been cancelled. Returns true if the dialog should
202  // now close, or false to keep it open.
203  virtual bool OnCancel() = 0;
204
205  // Called when the view has been accepted. This could be to submit the payment
206  // info or to handle a required action. Returns true if the dialog should now
207  // close, or false to keep it open.
208  virtual bool OnAccept() = 0;
209
210  // Returns the profile for this dialog.
211  virtual Profile* profile() = 0;
212
213  // The web contents that prompted the dialog.
214  virtual content::WebContents* web_contents() = 0;
215
216 protected:
217  virtual ~AutofillDialogController();
218};
219
220}  // namespace autofill
221
222#endif  // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_
223