chrome/browser/ui/autofill/payments/offer_notification_bubble_controller.h

// Copyright 2021 The Chromium Authors
// 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_PAYMENTS_OFFER_NOTIFICATION_BUBBLE_CONTROLLER_H_
#define CHROME_BROWSER_UI_AUTOFILL_PAYMENTS_OFFER_NOTIFICATION_BUBBLE_CONTROLLER_H_

#include <string>
#include <vector>

#include "components/autofill/core/browser/ui/payments/payments_bubble_closed_reasons.h"
#include "content/public/browser/web_contents.h"

namespace autofill {

class AutofillBubbleBase;
class AutofillOfferData;
class CreditCard;

// Interface that exposes controller functionality to offer notification related
// UIs.
class OfferNotificationBubbleController {
 public:
  OfferNotificationBubbleController() = default;
  virtual ~OfferNotificationBubbleController() = default;
  OfferNotificationBubbleController(const OfferNotificationBubbleController&) =
      delete;
  OfferNotificationBubbleController& operator=(
      const OfferNotificationBubbleController&) = delete;

  // Returns a reference to the OfferNotificationBubbleController associated
  // with the given |web_contents|. If controller does not exist, this will
  // create the controller from the |web_contents| then return the reference.
  static OfferNotificationBubbleController* GetOrCreate(
      content::WebContents* web_contents);

  // Returns a reference to the OfferNotificationBubbleController associated
  // with the given |web_contents|. If controller does not exist, this will
  // return nullptr.
  static OfferNotificationBubbleController* Get(
      content::WebContents* web_contents);

  // Returns the title that should be displayed in the bubble.
  virtual std::u16string GetWindowTitle() const = 0;

  // Returns the label text for the Ok button.
  virtual std::u16string GetOkButtonLabel() const = 0;

  // Returns the tooltip text for the promo code offer button, which can differ
  // depending on whether it has been clicked yet or not.
  virtual std::u16string GetPromoCodeButtonTooltip() const = 0;

  // Returns the reference to the offer notification bubble view.
  virtual AutofillBubbleBase* GetOfferNotificationBubbleView() const = 0;

  // Returns the related card if the offer is a card linked offer.
  virtual const CreditCard* GetLinkedCard() const = 0;

  // Returns the related offer, from which the UI can extract display strings.
  virtual const AutofillOfferData* GetOffer() const = 0;

  // Returns whether the omnibox icon should be visible.
  virtual bool IsIconVisible() const = 0;

  // Removes the reference the controller has to the bubble.
  virtual void OnBubbleClosed(PaymentsBubbleClosedReason closed_reason) = 0;

  // Handles the event of clicking the promo code offer button, including
  // logging metrics for the successful copy-to-clipboard event.
  virtual void OnPromoCodeButtonClicked() = 0;
};

}  // namespace autofill

#endif  // CHROME_BROWSER_UI_AUTOFILL_PAYMENTS_OFFER_NOTIFICATION_BUBBLE_CONTROLLER_H_