chrome/browser/ui/toasts/toast_view.h

// Copyright 2024 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_TOASTS_TOAST_VIEW_H_
#define CHROME_BROWSER_UI_TOASTS_TOAST_VIEW_H_

#include <string>

#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/widget/widget.h"

namespace views {
class ImageButton;
class ImageView;
class Label;
class MdTextButton;
}  // namespace views

namespace toasts {
enum class ToastCloseReason {
  kAutoDismissed = 0,
  kActionButton = 1,
  kCloseButton = 2,
  kPreempted = 3,
  kMenuItemClick = 4,
  kFeatureDismiss = 5,
  kAbort = 6,
  kMaxValue = kAbort
};

// The view for toasts.
class ToastView : public views::BubbleDialogDelegateView,
                  public views::AnimationDelegateViews {
  METADATA_HEADER(ToastView, views::BubbleDialogDelegateView)

 public:
  DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kToastViewId);
  ToastView(views::View* anchor_view,
            const std::u16string& toast_text,
            const gfx::VectorIcon& icon,
            bool has_close_button,
            bool should_hide_ui_for_fullscreen);
  ~ToastView() override;

  // Must be called prior to Init (which is called from
  // views::BubbleDialogDelegateView::CreateBubble).
  void AddActionButton(
      const std::u16string& action_button_text,
      base::RepeatingClosure action_button_callback = base::DoNothing());

  // views::BubbleDialogDelegateView:
  void Init() override;

  // AnimationDelegateViews:
  void AnimationProgressed(const gfx::Animation* animation) override;

  void AnimateIn();

  // Animates out the toast, then closes the toast widget.
  void Close(ToastCloseReason close_reason);

  void UpdateRenderToastOverWebContentsAndPaint(
      const bool render_toast_over_web_contents);

  views::Label* label_for_testing() { return label_; }
  views::MdTextButton* action_button_for_testing() { return action_button_; }
  views::ImageButton* close_button_for_testing() { return close_button_; }

 protected:
  // views::BubbleDialogDelegateView:
  gfx::Rect GetBubbleBounds() override;
  void OnThemeChanged() override;

 private:
  void AnimateOut(base::OnceClosure callback, bool show_height_animation);

  gfx::LinearAnimation height_animation_{this};
  gfx::Rect starting_widget_bounds_;
  gfx::Rect target_widget_bounds_;
  gfx::Tween::Type height_animation_tween_;

  const std::u16string toast_text_;
  const raw_ref<const gfx::VectorIcon> icon_;
  const bool has_close_button_;
  bool render_toast_over_web_contents_;
  bool has_action_button_ = false;
  std::u16string action_button_text_;
  base::RepeatingClosure action_button_callback_;

  // Raw pointers to child views.
  raw_ptr<views::Label> label_ = nullptr;
  raw_ptr<views::ImageView> icon_view_ = nullptr;
  raw_ptr<views::MdTextButton> action_button_ = nullptr;
  raw_ptr<views::ImageButton> close_button_ = nullptr;
};

}  // namespace toasts

#endif  // CHROME_BROWSER_UI_TOASTS_TOAST_VIEW_H_