1
    2
    3
    4
    5
    6
    7
    8
    9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
  100
  101
  102


ash / system / notification_center / notification_center_controller.h [blame]

// 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 ASH_SYSTEM_NOTIFICATION_CENTER_NOTIFICATION_CENTER_CONTROLLER_H_
#define ASH_SYSTEM_NOTIFICATION_CENTER_NOTIFICATION_CENTER_CONTROLLER_H_

#include "ash/ash_export.h"
#include "base/memory/raw_ptr.h"
#include "ui/message_center/message_center_observer.h"
#include "ui/views/view_tracker.h"

namespace message_center {
class MessageView;
class Notification;
}  // namespace message_center

namespace views {
class View;
}  // namespace views

namespace ash {

class MessageViewContainer;
class NotificationCenterView;

// Manages and updates `NotificationCenterView`. Currently only manages pinned
// system notifications when the feature `OngoingProcesses` is enabled. All
// other types of notifications will be forwarded to `NotificationListView` so
// they're processed there.
// TODO(b/322835713): Also create and manage other notification views from this
// controller instead of from `NotificationListView`.
class ASH_EXPORT NotificationCenterController
    : public message_center::MessageCenterObserver {
 public:
  NotificationCenterController();
  NotificationCenterController(const NotificationCenterController&) = delete;
  NotificationCenterController& operator=(const NotificationCenterController&) =
      delete;
  ~NotificationCenterController() override;

  // Creates a `NotificationCenterView` object and returns it so it can be added
  // to the parent bubble view.
  std::unique_ptr<views::View> CreateNotificationCenterView();

  // Inits the `NotificationCenterView` so it can be populated with views for
  // the existing notifications.
  // When `OngoingProcesses` are disabled, notification views are created inside
  // of the `NotificationListView` class. When `OngoingProcesses` are enabled,
  // pinned system notification views are created in this controller.
  // TODO(b/322835713): Also create and manage other notification views from
  // this controller instead of from `NotificationListView`.
  void InitNotificationCenterView();

  // Returns the `MessageViewContainer` object with the provided `id` that
  // exists inside of `ongoing_process_list_view_`.
  // TODO(b/322835713): Also search for other notification views from this
  // controller instead of from `NotificationListView`.
  MessageViewContainer* GetOngoingProcessMessageViewContainerById(
      const std::string& id);

  // message_center::MessageCenterObserver:
  void OnNotificationAdded(const std::string& id) override;
  void OnNotificationRemoved(const std::string& id, bool by_user) override;
  void OnNotificationUpdated(const std::string& id) override;

  NotificationCenterView* notification_center_view() {
    return notification_center_view_;
  }

 private:
  // Updates `MessageViewContainer` borders of the specified list view, based on
  // the `is_ongoing_process` parameter. If `force_update` is true, all
  // borders will update even if their `is_top` and `is_bottom` values remain
  // unchanged from their stored values.
  void UpdateListViewBorders(const bool is_ongoing_process,
                             const bool force_update = false);

  // Creates a `MessageView` that will be owned by a `MessageViewContainer`.
  std::unique_ptr<message_center::MessageView> CreateMessageView(
      const message_center::Notification& notification);

  // Creates the view for the given `notification` and adds it as a child view
  // of the appropriate list view.
  void AddNotificationChildView(message_center::Notification* notification);

  // Syntactic sugar to downcast.
  static const MessageViewContainer* AsMVC(const views::View* v);
  static MessageViewContainer* AsMVC(views::View* v);

  // Owned by the views hierarchy.
  raw_ptr<NotificationCenterView> notification_center_view_ = nullptr;
  raw_ptr<views::View> ongoing_process_list_view_ = nullptr;

  // View trackers to clear view pointers immediately when they're deleted.
  views::ViewTracker notification_center_view_tracker_;
  views::ViewTracker ongoing_process_list_view_tracker_;
};

}  // namespace ash

#endif  // ASH_SYSTEM_NOTIFICATION_CENTER_NOTIFICATION_CENTER_CONTROLLER_H_