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