chrome/browser/notifications/notification_ui_manager.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 CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_
   6 #define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12
  13 class GURL;
  14 class Notification;
  15 class PrefService;
  16 class Profile;
  17
  18 // This virtual interface is used to manage the UI surfaces for desktop
  19 // notifications. There is one instance per profile.
  20 class NotificationUIManager {
  21  public:
  22   virtual ~NotificationUIManager() {}
  23
  24   // Creates an initialized UI manager.
  25   static NotificationUIManager* Create(PrefService* local_state);
  26
  27   // Adds a notification to be displayed. Virtual for unit test override.
  28   virtual void Add(const Notification& notification,
  29                    Profile* profile) = 0;
  30
  31   // Returns true if any notifications match the supplied ID, either currently
  32   // displayed or in the queue.
  33   virtual bool DoesIdExist(const std::string& notification_id) = 0;
  34
  35   // Removes any notifications matching the supplied ID, either currently
  36   // displayed or in the queue.  Returns true if anything was removed.
  37   virtual bool CancelById(const std::string& notification_id) = 0;
  38
  39   // Removes notifications matching the |source_origin| (which could be an
  40   // extension ID). Returns true if anything was removed.
  41   virtual bool CancelAllBySourceOrigin(const GURL& source_origin) = 0;
  42
  43   // Removes notifications matching |profile|. Returns true if any were removed.
  44   virtual bool CancelAllByProfile(Profile* profile) = 0;
  45
  46   // Cancels all pending notifications and closes anything currently showing.
  47   // Used when the app is terminating.
  48   virtual void CancelAll() = 0;
  49
  50   // Temporary, while we have two implementations of Notifications UI Managers.
  51   // One is older BalloonCollection-based and uses renderers to show
  52   // notifications, another delegates to the new MessageCenter and uses native
  53   // UI widgets.
  54   // TODO(dimich): remove these eventually.
  55   static bool DelegatesToMessageCenter();
  56
  57  protected:
  58   NotificationUIManager() {}
  59
  60  private:
  61   DISALLOW_COPY_AND_ASSIGN(NotificationUIManager);
  62 };
  63
  64 #endif  // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_H_