chrome/browser/ui/autofill/autofill_dialog_view_delegate.h

   1 // Copyright 2013 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_VIEW_DELEGATE_H_
   6 #define CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_VIEW_DELEGATE_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/ui_base_types.h"
  15 #include "ui/gfx/image/image.h"
  16 #include "ui/gfx/native_widget_types.h"
  17 #include "ui/gfx/range/range.h"
  18
  19 class FieldValueMap;
  20 class GURL;
  21 class Profile;
  22
  23 namespace content {
  24 class WebContents;
  25 struct NativeWebKeyboardEvent;
  26 }
  27
  28 namespace gfx {
  29 class Rect;
  30 }
  31
  32 namespace ui {
  33 class ComboboxModel;
  34 class MenuModel;
  35 }
  36
  37 namespace autofill {
  38
  39 typedef std::map<ServerFieldType, gfx::Image> FieldIconMap;
  40
  41 // This class defines the interface to the controller that the dialog view sees.
  42 class AutofillDialogViewDelegate {
  43  public:
  44   // Strings -------------------------------------------------------------------
  45
  46   virtual base::string16 DialogTitle() const = 0;
  47   virtual base::string16 AccountChooserText() const = 0;
  48   virtual base::string16 SignInLinkText() const = 0;
  49   virtual base::string16 SpinnerText() const = 0;
  50   virtual base::string16 EditSuggestionText() const = 0;
  51   virtual base::string16 CancelButtonText() const = 0;
  52   virtual base::string16 ConfirmButtonText() const = 0;
  53   virtual base::string16 SaveLocallyText() const = 0;
  54   virtual base::string16 SaveLocallyTooltip() const = 0;
  55   virtual base::string16 LegalDocumentsText() = 0;
  56
  57   // State ---------------------------------------------------------------------
  58
  59   // Whether a loading animation should be shown (e.g. while signing in,
  60   // retreiving Wallet data, etc.).
  61   virtual bool ShouldShowSpinner() const = 0;
  62
  63   // Whether the account chooser/sign in link control should be visible.
  64   virtual bool ShouldShowAccountChooser() const = 0;
  65
  66   // Whether the sign in web view should be displayed.
  67   virtual bool ShouldShowSignInWebView() const = 0;
  68
  69   // Whether to show the checkbox to save data locally (in Autofill).
  70   virtual bool ShouldOfferToSaveInChrome() const = 0;
  71
  72   // Whether the checkbox to save data locally should be checked initially.
  73   virtual bool ShouldSaveInChrome() const = 0;
  74
  75   // Returns the model for the account chooser. It will return NULL if the
  76   // account chooser should not show a menu. In this case, clicking on the
  77   // account chooser should initiate sign-in.
  78   virtual ui::MenuModel* MenuModelForAccountChooser() = 0;
  79
  80   // Returns the icon that should be shown in the account chooser.
  81   virtual gfx::Image AccountChooserImage() = 0;
  82
  83   // Returns the image that should be shown on the left of the button strip
  84   // or an empty image if none should be shown.
  85   virtual gfx::Image ButtonStripImage() const = 0;
  86
  87   // Which dialog buttons should be visible.
  88   virtual int GetDialogButtons() const = 0;
  89
  90   // Whether or not the |button| should be enabled.
  91   virtual bool IsDialogButtonEnabled(ui::DialogButton button) const = 0;
  92
  93   // Returns a struct full of data concerning what overlay, if any, should be
  94   // displayed on top of the dialog.
  95   virtual DialogOverlayState GetDialogOverlay() = 0;
  96
  97   // Returns ranges to linkify in the text returned by |LegalDocumentsText()|.
  98   virtual const std::vector<gfx::Range>& LegalDocumentLinks() = 0;
  99
 100   // Detail inputs -------------------------------------------------------------
 101
 102   // Whether the section is currently active (i.e. should be shown).
 103   virtual bool SectionIsActive(DialogSection section) const = 0;
 104
 105   // Returns the set of inputs the page has requested which fall under
 106   // |section|.
 107   virtual const DetailInputs& RequestedFieldsForSection(DialogSection section)
 108       const = 0;
 109
 110   // Returns the combobox model for inputs of type |type|, or NULL if the input
 111   // should be a text field.
 112   virtual ui::ComboboxModel* ComboboxModelForAutofillType(
 113       ServerFieldType type) = 0;
 114
 115   // Returns the model for suggestions for fields that fall under |section|.
 116   // This may return NULL, in which case no menu should be shown for that
 117   // section.
 118   virtual ui::MenuModel* MenuModelForSection(DialogSection section) = 0;
 119
 120   // Returns the label text used to describe the section (i.e. Billing).
 121   virtual base::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   // Returns the icons to be displayed along with the given |user_inputs| in a
 127   // section.
 128   virtual FieldIconMap IconsForFields(
 129       const FieldValueMap& user_inputs) const = 0;
 130
 131   // Returns true if the value of this field |type| controls the icons for the
 132   // rest of the fields in a section.
 133   virtual bool FieldControlsIcons(ServerFieldType type) const = 0;
 134
 135   // Returns a tooltip for the given field, or an empty string if none exists.
 136   virtual base::string16 TooltipForField(ServerFieldType type) const = 0;
 137
 138   // Whether a particular DetailInput in |section| should be edited or not.
 139   virtual bool InputIsEditable(const DetailInput& input,
 140                                DialogSection section) = 0;
 141
 142   // Decides whether input of |value| is valid for a field of type |type|. If
 143   // valid, the returned string will be empty. Otherwise it will contain an
 144   // error message.
 145   virtual base::string16 InputValidityMessage(DialogSection section,
 146                                         ServerFieldType type,
 147                                         const base::string16& value) = 0;
 148
 149   // Decides whether the combination of all |inputs| is valid, returns a
 150   // map of field types to validity messages.
 151   virtual ValidityMessages InputsAreValid(DialogSection section,
 152                                           const FieldValueMap& inputs) = 0;
 153
 154   // Called when the user edits or activates a textfield or combobox.
 155   // |was_edit| is true when the function was called in response to the user
 156   // editing the input.
 157   virtual void UserEditedOrActivatedInput(DialogSection section,
 158                                           ServerFieldType type,
 159                                           gfx::NativeView parent_view,
 160                                           const gfx::Rect& content_bounds,
 161                                           const base::string16& field_contents,
 162                                           bool was_edit) = 0;
 163
 164   // The view forwards keypresses in text inputs. Returns true if there should
 165   // be no further processing of the event.
 166   virtual bool HandleKeyPressEventInInput(
 167       const content::NativeWebKeyboardEvent& event) = 0;
 168
 169   // Called when focus has changed position within the view.
 170   virtual void FocusMoved() = 0;
 171
 172   // Whether the view is allowed to show a validation error bubble.
 173   virtual bool ShouldShowErrorBubble() const = 0;
 174
 175   // Miscellany ----------------------------------------------------------------
 176
 177   // Called when the view has been closed.
 178   virtual void ViewClosed() = 0;
 179
 180   // Returns dialog notifications that the view should currently be showing in
 181   // order from top to bottom.
 182   virtual std::vector<DialogNotification> CurrentNotifications() = 0;
 183
 184   // Called when a generic link has been clicked in the dialog. Opens the URL
 185   // out-of-line.
 186   virtual void LinkClicked(const GURL& url) = 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 gfx::Range& range) = 0;
 197
 198   // Called when the view has been cancelled. Returns true if the dialog should
 199   // now close, or false to keep it open.
 200   virtual bool OnCancel() = 0;
 201
 202   // Called when the view has been accepted. This could be to submit the payment
 203   // info or to handle a required action. Returns true if the dialog should now
 204   // close, or false to keep it open.
 205   virtual bool OnAccept() = 0;
 206
 207   // Returns the profile for this dialog.
 208   virtual Profile* profile() = 0;
 209
 210   // The web contents that prompted the dialog.
 211   virtual content::WebContents* GetWebContents() = 0;
 212
 213  protected:
 214   virtual ~AutofillDialogViewDelegate();
 215 };
 216
 217 }  // namespace autofill
 218
 219 #endif  // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_VIEW_DELEGATE_H_