blob: d245188e8c9a170aa19b705145e8669321fc3cb2 [file] [log] [blame]
// Copyright 2018 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.
#include <memory>
#include <string>
#include "base/callback_forward.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string16.h"
#include "components/autofill/core/browser/ui/accessory_sheet_data.h"
#include "components/autofill/core/common/mojom/autofill_types.mojom.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/gfx/image/image.h"
// Controller interface for the view that includes the keyboard accessory and
// the accessory sheet below it. Implementations of this interface create and
// own a ManualFillingViewInterface.
// The manual filling controller forwards requests from type-specific accessory
// controllers (Passwords and Autofill) to the view. The view notifies this
// controller about interactions (such as requesting to fill a password
// suggestion) and forwards the request to the corresponding type-specific
// accessory controller.
// This controller also implements the logic to show/hide the keyboard
// accessory.
// ManualFillingController::GetOrCreate() should be used
// by type-specific controllers to obtain an instance of this class for a given
// WebContents. There is only one instance per WebContents, which is created the
// first time |GetOrCreate()| is invoked.
// Usage example:
// auto controller = ManualFillingController::GetOrCreate(web_contents);
// DCHECK(controller);
// controller->RefreshSuggestionsForField(...);
class ManualFillingController {
// The controller checks if at least one of these sources needs the accessory
// to be displayed.
enum class FillingSource {
using IconCallback = base::OnceCallback<void(const gfx::Image&)>;
ManualFillingController() = default;
virtual ~ManualFillingController() = default;
// Returns a weak pointer to the unique ManualFillingController instance
// associated with a WebContents. The first invocation creates an instance
// and attaches it to the WebContents; the same instance is returned by all
// future invocations for the same WebContents.
static base::WeakPtr<ManualFillingController> GetOrCreate(
content::WebContents* contents);
// --------------------------------------------
// Methods called by type-specific controllers.
// --------------------------------------------
// Depending on the type of the given |accessory_sheet_data|, this updates a
// accessory sheet. Controllers to handle touch events are determined by the
// type of the sheet.
virtual void RefreshSuggestions(
const autofill::AccessorySheetData& accessory_sheet_data) = 0;
// Notifies that the focused field changed which allows the controller to
// update the UI visibility.
virtual void NotifyFocusedInputChanged(
autofill::mojom::FocusedFieldType focused_field_type) = 0;
// Reports for a source whether it provides suggestions or just default
// options. The controller then updates the UI visibility accordingly.
virtual void UpdateSourceAvailability(FillingSource source,
bool has_suggestions) = 0;
// Explicitly hides all manual filling UI without checking any filling source.
// E.g. after autofilling suggestions, or generating a password.
virtual void Hide() = 0;
// Notifies the view that automatic password generation status changed.
// TODO( This controller doesn't need to know about password
// generation. Generalize this to send to the UI the information that an
// action (given by an enum param) is available.
virtual void OnAutomaticGenerationStatusChanged(bool available) = 0;
// --------------------------
// Methods called by UI code:
// --------------------------
// Called by the UI code to request that |text_to_fill| is to be filled into
// the currently focused field. Forwards the request to a type-specific
// accessory controller.
virtual void OnFillingTriggered(
autofill::AccessoryTabType type,
const autofill::UserInfo::Field& selection) = 0;
// Called by the UI code because a user triggered the |selected_action|,
// such as "Manage passwords...".
virtual void OnOptionSelected(
autofill::AccessoryAction selected_action) const = 0;
// The given |credential_origin| can be empty if the UI doesn't display it. An
// empty |credential_origin| means, that requested favicon originates from the
// same origin that the currently focused points to.
// In either case, the callback is invoked with a favicon image or with an
// |IsEmpty()| image if a favicon could not be retrieved.
virtual void GetFavicon(int desired_size_in_pixel,
const std::string& credential_origin,
IconCallback icon_callback) = 0;
// -----------------
// Member accessors:
// -----------------
// The web page view containing the focused field.
virtual gfx::NativeView container_view() const = 0;