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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
// 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/string16.h"
#include "base/values.h"
#include "chrome/browser/notifications/notification_delegate.h"
#include "googleurl/src/gurl.h"
#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextDirection.h"
#include "ui/gfx/image/image.h"
#include "ui/message_center/notification_types.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:
// Initializes a notification with HTML content.
Notification(const GURL& origin_url,
const GURL& content_url,
const string16& display_source,
const 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 string16& title,
const string16& body,
WebKit::WebTextDirection dir,
const string16& display_source,
const string16& replace_id,
NotificationDelegate* delegate);
// Initializes a notification with a given type. Makes a deep copy of
// optional_fields.
Notification(message_center::NotificationType type,
const GURL& origin_url,
const GURL& icon_url,
const string16& title,
const string16& body,
WebKit::WebTextDirection dir,
const string16& display_source,
const string16& replace_id,
const DictionaryValue* optional_fields,
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 string16& title,
const string16& body,
WebKit::WebTextDirection dir,
const string16& display_source,
const string16& replace_id,
NotificationDelegate* delegate);
Notification(const Notification& notification);
~Notification();
Notification& operator=(const Notification& notification);
// If this is a HTML notification.
bool is_html() const { return is_html_; }
message_center::NotificationType type() const {
return type_;
}
// The URL (may be data:) containing the contents for the notification.
const GURL& content_url() const { return content_url_; }
// Title and message text of the notification.
const string16& title() const { return title_; }
const string16& body() const { return body_; }
// 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_; }
// An image for the icon to be shown (optional).
const gfx::Image& icon() const { return icon_; }
// A display string for the source of the notification.
const string16& display_source() const { return display_source_; }
// A unique identifier used to update (replace) or remove a notification.
const string16& replace_id() const { return replace_id_; }
const DictionaryValue* optional_fields() const {
return optional_fields_.get();
}
// Marks this explicitly to prevent the timeout dismiss of notification.
// This is used by webkit notifications to keep the existing behavior.
void DisableTimeout();
void Display() const { delegate()->Display(); }
void Error() const { delegate()->Error(); }
bool HasClickedListener() const { return delegate()->HasClickedListener(); }
void Click() const { delegate()->Click(); }
void ButtonClick(int index) const { delegate()->ButtonClick(index); }
void Close(bool by_user) const { delegate()->Close(by_user); }
void DoneRendering() { delegate()->ReleaseRenderViewHost(); }
std::string notification_id() const { return delegate()->id(); }
int process_id() const { return delegate()->process_id(); }
content::RenderViewHost* GetRenderViewHost() const {
return delegate()->GetRenderViewHost();
}
NotificationDelegate* delegate() const { return delegate_.get(); }
private:
// The type of notification we'd like displayed.
message_center::NotificationType type_;
// The Origin of the page/worker which created this notification.
GURL origin_url_;
// Image data for the associated icon, used by Ash when available.
gfx::Image icon_;
// 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 |body_|.
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 content for a text notification.
string16 title_;
string16 body_;
// The display string for the source of the notification. Could be
// the same as origin_url_, or the name of an extension.
string16 display_source_;
// The replace ID for the notification.
string16 replace_id_;
scoped_ptr<DictionaryValue> optional_fields_;
// 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_
|
