| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_H_ |
| #define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_H_ |
| |
| #include <string> |
| |
| #include "base/basictypes.h" |
| #include "base/memory/scoped_ptr.h" |
| #include "base/strings/string16.h" |
| #include "base/values.h" |
| #include "chrome/browser/notifications/notification_delegate.h" |
| #include "third_party/WebKit/public/web/WebTextDirection.h" |
| #include "ui/gfx/image/image.h" |
| #include "ui/message_center/notification.h" |
| #include "ui/message_center/notification_types.h" |
| #include "url/gurl.h" |
| |
| // Representation of a notification to be shown to the user. |
| // On non-Ash platforms these are rendered as HTML, sometimes described by a |
| // data url converted from text + icon data. On Ash they are rendered as |
| // formated text and icon data. |
| class Notification : public message_center::Notification { |
| public: |
| // Initializes a notification with HTML content. |
| Notification(const GURL& origin_url, |
| const GURL& content_url, |
| const base::string16& display_source, |
| const base::string16& replace_id, |
| NotificationDelegate* delegate); |
| |
| // Initializes a notification with text content. On non-ash platforms, this |
| // creates an HTML representation using a data: URL for display. |
| Notification(const GURL& origin_url, |
| const GURL& icon_url, |
| const base::string16& title, |
| const base::string16& body, |
| blink::WebTextDirection dir, |
| const base::string16& display_source, |
| const base::string16& replace_id, |
| NotificationDelegate* delegate); |
| |
| // Initializes a notification with text content and an icon image. Currently |
| // only used on Ash. Does not generate content_url_. |
| Notification(const GURL& origin_url, |
| const gfx::Image& icon, |
| const base::string16& title, |
| const base::string16& body, |
| blink::WebTextDirection dir, |
| const base::string16& display_source, |
| const base::string16& replace_id, |
| NotificationDelegate* delegate); |
| |
| Notification( |
| message_center::NotificationType type, |
| const GURL& origin_url, |
| const base::string16& title, |
| const base::string16& body, |
| const gfx::Image& icon, |
| blink::WebTextDirection dir, |
| const message_center::NotifierId& notifier_id, |
| const base::string16& display_source, |
| const base::string16& replace_id, |
| const message_center::RichNotificationData& rich_notification_data, |
| NotificationDelegate* delegate); |
| |
| Notification(const Notification& notification); |
| virtual ~Notification(); |
| Notification& operator=(const Notification& notification); |
| |
| // If this is a HTML notification. |
| bool is_html() const { return is_html_; } |
| |
| // The URL (may be data:) containing the contents for the notification. |
| const GURL& content_url() const { return content_url_; } |
| |
| // The origin URL of the script which requested the notification. |
| const GURL& origin_url() const { return origin_url_; } |
| |
| // A url for the icon to be shown (optional). |
| const GURL& icon_url() const { return icon_url_; } |
| |
| // A unique identifier used to update (replace) or remove a notification. |
| const base::string16& replace_id() const { return replace_id_; } |
| |
| // A url for the button icons to be shown (optional). |
| const GURL& button_one_icon_url() const { return button_one_icon_url_; } |
| const GURL& button_two_icon_url() const { return button_two_icon_url_; } |
| |
| // A url for the image to be shown (optional). |
| const GURL& image_url() const { return image_url_; } |
| |
| std::string notification_id() const { return delegate()->id(); } |
| int process_id() const { return delegate()->process_id(); } |
| |
| content::RenderViewHost* GetRenderViewHost() const { |
| return delegate()->GetRenderViewHost(); |
| } |
| void DoneRendering() { delegate()->ReleaseRenderViewHost(); } |
| |
| NotificationDelegate* delegate() const { return delegate_.get(); } |
| |
| private: |
| // The Origin of the page/worker which created this notification. |
| GURL origin_url_; |
| |
| // URL for the icon associated with the notification. Requires delegate_ |
| // to have a non NULL RenderViewHost. |
| GURL icon_url_; |
| |
| // If this is a HTML notification, the content is in |content_url_|. If |
| // false, the data is in |title_| and |message_|. |
| bool is_html_; |
| |
| // The URL of the HTML content of the toast (may be a data: URL for simple |
| // string-based notifications). |
| GURL content_url_; |
| |
| // The URLs of the button images for a rich notification. |
| GURL button_one_icon_url_; |
| GURL button_two_icon_url_; |
| |
| // The URL of a large image to be displayed for a a rich notification. |
| GURL image_url_; |
| |
| // The user-supplied replace ID for the notification. |
| base::string16 replace_id_; |
| |
| // A proxy object that allows access back to the JavaScript object that |
| // represents the notification, for firing events. |
| scoped_refptr<NotificationDelegate> delegate_; |
| }; |
| |
| #endif // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_H_ |