text: // Copyright (c) 2012 The Chromium Authors. All rights reserved.
  // Use of this source code is governed by a BSD-style license that can be
  // found in the LICENSE file.
  
  #ifndef CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_
  #define CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_
  
  #include <vector>
  
  #include "base/string16.h"
  #include "chrome/browser/ui/autofill/autofill_dialog_types.h"
  #include "components/autofill/browser/field_types.h"
  #include "components/autofill/browser/wallet/required_action.h"
  #include "ui/base/range/range.h"
  #include "ui/base/ui_base_types.h"
  #include "ui/gfx/image/image.h"
  #include "ui/gfx/native_widget_types.h"
  
  class Profile;
  
  namespace content {
  class WebContents;
  struct NativeWebKeyboardEvent;
  }
  
  namespace gfx {
  class Rect;
  }
  
  namespace ui {
  class ComboboxModel;
  class MenuModel;
  }
  
  namespace autofill {
  
  // This class defines the interface to the controller that the dialog view sees.
  class AutofillDialogController {
   public:
    enum ValidationType {
      VALIDATE_EDIT,   // validate user edits. Allow for empty fields.
      VALIDATE_FINAL,  // Full form validation. Mandatory fields can't be empty.
    };
  
    // Strings -------------------------------------------------------------------
  
    virtual string16 DialogTitle() const = 0;
    virtual string16 AccountChooserText() const = 0;
    virtual string16 SignInLinkText() const = 0;
    virtual string16 EditSuggestionText() const = 0;
    virtual string16 CancelButtonText() const = 0;
    virtual string16 ConfirmButtonText() const = 0;
    virtual string16 SaveLocallyText() const = 0;
    virtual string16 ProgressBarText() const = 0;
    virtual string16 LegalDocumentsText() = 0;
  
    // State ---------------------------------------------------------------------
  
    // Whether the user is known to be signed in.
    virtual DialogSignedInState SignedInState() const = 0;
  
    // Whether the dialog is in a not exactly well-defined state
    // (while attempting to sign-in or retrieving the wallet data etc).
    virtual bool ShouldShowSpinner() const = 0;
  
    // Whether to show the checkbox to save data locally (in Autofill).
    virtual bool ShouldOfferToSaveInChrome() const = 0;
  
    // Returns the model for the account chooser. It will return NULL if the
    // account chooser should not show a menu. In this case, clicking on the
    // account chooser should initiate sign-in.
    virtual ui::MenuModel* MenuModelForAccountChooser() = 0;
  
    // Returns the icon that should be shown in the account chooser.
    virtual gfx::Image AccountChooserImage() = 0;
  
    // Whether or not the details container should be showing currently.
    virtual bool ShouldShowDetailArea() const = 0;
  
    // Whether or not the progress bar in the button strip should be showing.
    virtual bool ShouldShowProgressBar() const = 0;
  
    // Whether or not the |button| should be enabled.
    virtual bool IsDialogButtonEnabled(ui::DialogButton button) const = 0;
  
    // Returns ranges to linkify in the text returned by |LegalDocumentsText()|.
    virtual const std::vector<ui::Range>& LegalDocumentLinks() = 0;
  
    // Detail inputs -------------------------------------------------------------
  
    // Whether the section is currently active (i.e. should be shown).
    virtual bool SectionIsActive(DialogSection section) const = 0;
  
    // Returns the set of inputs the page has requested which fall under
    // |section|.
    virtual const DetailInputs& RequestedFieldsForSection(DialogSection section)
        const = 0;
  
    // Returns the combobox model for inputs of type |type|, or NULL if the input
    // should be a text field.
    virtual ui::ComboboxModel* ComboboxModelForAutofillType(
        AutofillFieldType type) = 0;
  
    // Returns the model for suggestions for fields that fall under |section|.
    // This may return NULL, in which case no menu should be shown for that
    // section.
    virtual ui::MenuModel* MenuModelForSection(DialogSection section) = 0;
  
  #if defined(OS_ANDROID)
    // As the above, but will never return NULL. TODO(estade): android should
    // stop relying on this and it should be removed.
    virtual ui::MenuModel* MenuModelForSectionHack(DialogSection section) = 0;
  #endif
  
    // Returns the label text used to describe the section (i.e. Billing).
    virtual string16 LabelForSection(DialogSection section) const = 0;
  
    // Returns the current state of suggestions for |section|.
    virtual SuggestionState SuggestionStateForSection(DialogSection section) = 0;
  
    // Should be called when the user starts editing of the section.
    virtual void EditClickedForSection(DialogSection section) = 0;
  
    // Should be called when the user cancels editing of the section.
    virtual void EditCancelledForSection(DialogSection section) = 0;
  
    // Returns an icon to be displayed along with the input for the given type.
    // |user_input| is the current text in the textfield.
    virtual gfx::Image IconForField(AutofillFieldType type,
                                    const string16& user_input) const = 0;
  
    // Decides whether input of |value| is valid for a field of type |type|. If
    // valid, the returned string will be empty. Otherwise it will contain an
    // error message.
    virtual string16 InputValidityMessage(AutofillFieldType type,
                                          const string16& value) const = 0;
  
  
    // Decides whether the combination of all |inputs| is valid, returns a
    // map of field types to error strings.
    virtual ValidityData InputsAreValid(
        const DetailOutputMap& inputs, ValidationType validation_type) const = 0;
  
    // Called when the user changes the contents of a text field or activates it
    // (by focusing and then clicking it). |was_edit| is true when the function
    // was called in response to the user editing the text field.
    virtual void UserEditedOrActivatedInput(const DetailInput* input,
                                            gfx::NativeView parent_view,
                                            const gfx::Rect& content_bounds,
                                            const string16& field_contents,
                                            bool was_edit) = 0;
  
    // The view forwards keypresses in text inputs. Returns true if there should
    // be no further processing of the event.
    virtual bool HandleKeyPressEventInInput(
        const content::NativeWebKeyboardEvent& event) = 0;
  
    // Called when focus has changed position within the view.
    virtual void FocusMoved() = 0;
  
    // Miscellany ----------------------------------------------------------------
  
    // Called when the view has been closed.
    virtual void ViewClosed() = 0;
  
    // Returns dialog notifications that the view should currently be showing in
    // order from top to bottom.
    virtual std::vector<DialogNotification> CurrentNotifications() const = 0;
  
    // Begins or aborts the flow to sign into Wallet.
    virtual void SignInLinkClicked() = 0;
  
    // Called when a checkbox in the notification area has changed its state.
    virtual void NotificationCheckboxStateChanged(DialogNotification::Type type,
                                                  bool checked) = 0;
  
    // A legal document link has been clicked.
    virtual void LegalDocumentLinkClicked(const ui::Range& range) = 0;
  
    // Called when the view has been cancelled.
    virtual void OnCancel() = 0;
  
    // Called when the view has been accepted. This could be to submit the payment
    // info or to handle a required action.
    virtual void OnAccept() = 0;
  
    // Returns the profile for this dialog.
    virtual Profile* profile() = 0;
  
    // The web contents that prompted the dialog.
    virtual content::WebContents* web_contents() = 0;
  
   protected:
    virtual ~AutofillDialogController();
  };
  
  }  // namespace autofill
  
  #endif  // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_DIALOG_CONTROLLER_H_
  