ui/message_center/message_center.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_MESSAGE_CENTER_MESSAGE_CENTER_H_
   6 #define UI_MESSAGE_CENTER_MESSAGE_CENTER_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/observer_list.h"
  12 #include "ui/gfx/native_widget_types.h"
  13 #include "ui/message_center/message_center_export.h"
  14 #include "ui/message_center/notification_change_observer.h"
  15 #include "ui/message_center/notification_list.h"
  16 #include "ui/message_center/notification_types.h"
  17
  18 namespace base {
  19 class DictionaryValue;
  20 }
  21
  22 // Class for managing the NotificationList. The client (e.g. Chrome) calls
  23 // [Add|Remove|Update]Notification to create and update notifications in the
  24 // list. It can also implement Delegate to receive callbacks when a
  25 // notification is removed (closed), or clicked on.
  26 // If an Observer is provided, it will be informed when the notification list
  27 // changes, and is expected to handle creating, showing, and hiding of any
  28 // bubbles.
  29
  30 namespace message_center {
  31
  32 class MESSAGE_CENTER_EXPORT MessageCenter : public NotificationChangeObserver,
  33                                             public NotificationList::Delegate {
  34  public:
  35   // Creates the global message center object.
  36   static void Initialize();
  37
  38   // Returns the global message center object. Initialize must be called first.
  39   static MessageCenter* Get();
  40
  41   // Destroys the global message_center object.
  42   static void Shutdown();
  43
  44   // Class that hosts the message center.
  45   class MESSAGE_CENTER_EXPORT Observer {
  46    public:
  47     // Called when the notification list has changed. |new_notification| will
  48     // be true if a notification was added or updated.
  49     virtual void OnMessageCenterChanged(bool new_notification) = 0;
  50    protected:
  51     virtual ~Observer() {}
  52   };
  53
  54   class MESSAGE_CENTER_EXPORT Delegate {
  55    public:
  56     virtual ~Delegate();
  57
  58     // Called when the notification associated with |notification_id| is
  59     // removed (i.e. closed by the user).
  60     virtual void NotificationRemoved(const std::string& notification_id,
  61                                      bool by_user) = 0;
  62
  63     // Request to disable the extension associated with |notification_id|.
  64     virtual void DisableExtension(const std::string& notification_id) = 0;
  65
  66     // Request to disable notifications from the source of |notification_id|.
  67     virtual void DisableNotificationsFromSource(
  68         const std::string& notification_id) = 0;
  69
  70     // Request to show the notification settings (|notification_id| is used
  71     // to identify the requesting browser context).
  72     virtual void ShowSettings(const std::string& notification_id) = 0;
  73
  74     // Request to show the notification settings dialog. |context| is necessary
  75     // to create a new window.
  76     virtual void ShowSettingsDialog(gfx::NativeView context) = 0;
  77
  78     // Called when the notification body is clicked on.
  79     virtual void OnClicked(const std::string& notification_id) = 0;
  80
  81     // Called when a button in a notification is clicked. |button_index|
  82     // indicates which button was clicked, zero-indexed (button one is 0,
  83     // button two is 1).
  84     //
  85     // TODO(miket): consider providing default implementations for the pure
  86     // virtuals above, to avoid changing so many files in disparate parts of
  87     // the codebase each time we enhance this interface.
  88     virtual void OnButtonClicked(const std::string& id, int button_index) = 0;
  89   };
  90
  91   // Called to set the delegate.  Generally called only once, except in tests.
  92   // Changing the delegate does not affect notifications in its
  93   // NotificationList.
  94   void SetDelegate(Delegate* delegate);
  95
  96   // Management of the observer list.
  97   void AddObserver(Observer* observer);
  98   void RemoveObserver(Observer* observer);
  99
 100   // Informs the notification list whether the message center is visible.
 101   // This affects whether or not a message has been "read".
 102   void SetMessageCenterVisible(bool visible);
 103
 104   // Accessors to notification_list_
 105   size_t NotificationCount() const;
 106   size_t UnreadNotificationCount() const;
 107   bool HasPopupNotifications() const;
 108
 109   // Adds a new notification. |id| is a unique identifier, used to update or
 110   // remove notifications. |title| and |meesage| describe the notification text.
 111   // Use SetNotificationIcon, SetNotificationImage, or SetNotificationButtonIcon
 112   // to set images. If |extension_id| is provided then 'Disable extension' will
 113   // appear in a dropdown menu and the id will be used to disable notifications
 114   // from the extension. Otherwise if |display_source| is provided, a menu item
 115   // showing the source and allowing notifications from that source to be
 116   // disabled will be shown. All actual disabling is handled by the Delegate.
 117   void AddNotification(NotificationType type,
 118                        const std::string& id,
 119                        const string16& title,
 120                        const string16& message,
 121                        const string16& display_source,
 122                        const std::string& extension_id,
 123                        const base::DictionaryValue* optional_fields);
 124
 125   // Updates an existing notification with id = old_id and set its id to new_id.
 126   // |optional_fields| can be NULL in case of no updates on those fields.
 127   void UpdateNotification(const std::string& old_id,
 128                           const std::string& new_id,
 129                           const string16& title,
 130                           const string16& message,
 131                           const base::DictionaryValue* optional_fields);
 132
 133   // Removes an existing notification.
 134   void RemoveNotification(const std::string& id);
 135
 136   void SetNotificationIcon(const std::string& notification_id,
 137                            const gfx::Image& image);
 138
 139   void SetNotificationImage(const std::string& notification_id,
 140                             const gfx::Image& image);
 141
 142   void SetNotificationButtonIcon(const std::string& notification_id,
 143                                  int button_index,
 144                                  const gfx::Image& image);
 145
 146   NotificationList* notification_list() { return notification_list_.get(); }
 147   bool quiet_mode() const { return notification_list_->quiet_mode(); }
 148
 149   // Overridden from NotificationChangeObserver:
 150   virtual void OnRemoveNotification(const std::string& id, bool by_user)
 151       OVERRIDE;
 152   virtual void OnRemoveAllNotifications(bool by_user) OVERRIDE;
 153   virtual void OnDisableNotificationsByExtension(const std::string& id)
 154       OVERRIDE;
 155   virtual void OnDisableNotificationsByUrl(const std::string& id) OVERRIDE;
 156   virtual void OnShowNotificationSettings(const std::string& id) OVERRIDE;
 157   virtual void OnShowNotificationSettingsDialog(gfx::NativeView context)
 158       OVERRIDE;
 159   virtual void OnExpanded(const std::string& id) OVERRIDE;
 160   virtual void OnClicked(const std::string& id) OVERRIDE;
 161   virtual void OnButtonClicked(const std::string& id, int button_index)
 162       OVERRIDE;
 163
 164   // Overridden from NotificationList::Delegate:
 165   virtual void SendRemoveNotification(const std::string& id,
 166                                       bool by_user) OVERRIDE;
 167   virtual void OnQuietModeChanged(bool quiet_mode) OVERRIDE;
 168
 169  protected:
 170   MessageCenter();
 171   virtual ~MessageCenter();
 172
 173  private:
 174   // Calls OnMessageCenterChanged on each observer.
 175   void NotifyMessageCenterChanged(bool new_notification);
 176
 177   scoped_ptr<NotificationList> notification_list_;
 178   ObserverList<Observer> observer_list_;
 179   Delegate* delegate_;
 180
 181   DISALLOW_COPY_AND_ASSIGN(MessageCenter);
 182 };
 183
 184 }  // namespace message_center
 185
 186 #endif  // UI_MESSAGE_CENTER_MESSAGE_CENTER_H_