ui/message_center/notification.h

   1 // Copyright (c) 2013 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_NOTIFICATION_H_
   6 #define UI_MESSAGE_CENTER_NOTIFICATION_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/string16.h"
  12 #include "base/time.h"
  13 #include "base/values.h"
  14 #include "ui/gfx/image/image.h"
  15 #include "ui/message_center/message_center_export.h"
  16 #include "ui/message_center/notification_types.h"
  17
  18 namespace message_center {
  19
  20 struct MESSAGE_CENTER_EXPORT NotificationItem {
  21   string16 title;
  22   string16 message;
  23
  24   NotificationItem(const string16& title, const string16& message);
  25 };
  26
  27 struct MESSAGE_CENTER_EXPORT ButtonInfo {
  28   string16 title;
  29   gfx::Image icon;
  30
  31   ButtonInfo(const string16& title);
  32 };
  33
  34 class MESSAGE_CENTER_EXPORT Notification {
  35  public:
  36   Notification(NotificationType type,
  37                const std::string& id,
  38                const string16& title,
  39                const string16& message,
  40                const string16& display_source,
  41                const std::string& extension_id,
  42                const DictionaryValue* optional_fields);  // May be NULL.
  43   virtual ~Notification();
  44
  45   NotificationType type() const { return type_; }
  46   const std::string& id() const { return id_; }
  47   const string16& title() const { return title_; }
  48   const string16& message() const { return message_; }
  49   const string16& display_source() const { return display_source_; }
  50   const std::string& extension_id() const { return extension_id_; }
  51
  52   // Begin unpacked values from optional_fields.
  53   int priority() const { return priority_; }
  54   base::Time timestamp() const { return timestamp_; }
  55   const string16& expanded_message() const { return expanded_message_; }
  56   const std::vector<NotificationItem>& items() const { return items_; }
  57   // End unpacked values.
  58
  59   // Images fetched asynchronously.
  60   const gfx::Image& icon() const { return icon_; }
  61   void set_icon(const gfx::Image& icon) { icon_ = icon; }
  62
  63   const gfx::Image& image() const { return image_; }
  64   void set_image(const gfx::Image& image) { image_ = image; }
  65
  66   // Buttons, with icons fetched asynchronously.
  67   const std::vector<ButtonInfo>& buttons() const { return buttons_; }
  68   bool SetButtonIcon(size_t index, const gfx::Image& icon);
  69
  70   bool shown_as_popup() const { return shown_as_popup_; }
  71   void set_shown_as_popup(bool shown_as_popup) {
  72     shown_as_popup_ = shown_as_popup;
  73   }
  74
  75   // Read status in the message center.
  76   bool is_read() const { return is_read_; }
  77   void set_is_read(bool read) { is_read_ = read; }
  78
  79   // Expanded status in the message center (not the popups).
  80   bool is_expanded() const { return is_expanded_; }
  81   void set_is_expanded(bool expanded) { is_expanded_ = expanded; }
  82
  83   // Used to keep the order of notifications with the same timestamp.
  84   // The notification with lesser serial_number is considered 'older'.
  85   unsigned serial_number() { return serial_number_; }
  86
  87   bool never_timeout() const { return never_timeout_; }
  88
  89  private:
  90   // Unpacks the provided |optional_fields| and applies the values to override
  91   // the notification's data members.
  92   void ApplyOptionalFields(const DictionaryValue* optional_fields);
  93
  94   NotificationType type_;
  95   std::string id_;
  96   string16 title_;
  97   string16 message_;
  98   string16 display_source_;
  99   std::string extension_id_;
 100   int priority_;
 101   base::Time timestamp_;
 102   unsigned serial_number_;
 103   string16 expanded_message_;
 104   std::vector<NotificationItem> items_;
 105   gfx::Image icon_;
 106   gfx::Image image_;
 107   std::vector<ButtonInfo> buttons_;
 108   bool shown_as_popup_;  // True if this has been shown as a popup.
 109   bool is_read_;  // True if this has been seen in the message center.
 110   bool is_expanded_;  // True if this has been expanded in the message center.
 111   bool never_timeout_; // True if it doesn't timeout when it appears as a toast.
 112
 113   DISALLOW_COPY_AND_ASSIGN(Notification);
 114 };
 115
 116 }  // namespace message_center
 117
 118 #endif  // UI_MESSAGE_CENTER_NOTIFICATION_H_