blob: bda6900fb0c0924d7f61b8df7ff3ec056fec199b [file] [log] [blame]
// Copyright (c) 2013 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 UI_MESSAGE_CENTER_NOTIFICATION_H_
#define UI_MESSAGE_CENTER_NOTIFICATION_H_
#include <string>
#include <vector>
#include "base/strings/string16.h"
#include "base/time/time.h"
#include "base/values.h"
#include "ui/gfx/image/image.h"
#include "ui/message_center/message_center_export.h"
#include "ui/message_center/notification_delegate.h"
#include "ui/message_center/notification_types.h"
namespace message_center {
struct MESSAGE_CENTER_EXPORT NotificationItem {
string16 title;
string16 message;
NotificationItem(const string16& title, const string16& message);
};
struct MESSAGE_CENTER_EXPORT ButtonInfo {
string16 title;
gfx::Image icon;
ButtonInfo(const string16& title);
};
class MESSAGE_CENTER_EXPORT RichNotificationData {
public:
RichNotificationData();
RichNotificationData(const RichNotificationData& other);
~RichNotificationData();
int priority;
bool never_timeout;
base::Time timestamp;
string16 expanded_message;
gfx::Image image;
std::vector<NotificationItem> items;
int progress;
std::vector<ButtonInfo> buttons;
};
class MESSAGE_CENTER_EXPORT Notification {
public:
Notification(NotificationType type,
const std::string& id,
const string16& title,
const string16& message,
const gfx::Image& icon,
const string16& display_source,
const std::string& extension_id,
const RichNotificationData& optional_fields,
NotificationDelegate* delegate);
Notification(const Notification& other);
Notification& operator=(const Notification& other);
virtual ~Notification();
// Copies the internal on-memory state from |base|, i.e. shown_as_popup,
// is_read, is_expanded, and never_timeout.
void CopyState(Notification* base);
NotificationType type() const { return type_; }
void set_type(NotificationType type) { type_ = type; }
const std::string& id() const { return id_; }
const string16& title() const { return title_; }
void set_title(const string16& title) { title_ = title; }
const string16& message() const { return message_; }
void set_message(const string16& message) { message_ = message; }
// A display string for the source of the notification.
const string16& display_source() const { return display_source_; }
const std::string& extension_id() const { return extension_id_; }
void set_extension_id(const std::string& extension_id) {
extension_id_ = extension_id;
}
// Begin unpacked values from optional_fields.
int priority() const { return optional_fields_.priority; }
void set_priority(int priority) { optional_fields_.priority = priority; }
base::Time timestamp() const { return optional_fields_.timestamp; }
void set_timestamp(const base::Time& timestamp) {
optional_fields_.timestamp = timestamp;
}
const string16& expanded_message() const {
return optional_fields_.expanded_message;
}
void set_expanded_message(const string16& expanded_message) {
optional_fields_.expanded_message = expanded_message;
}
const std::vector<NotificationItem>& items() const {
return optional_fields_.items;
}
void set_items(const std::vector<NotificationItem>& items) {
optional_fields_.items = items;
}
int progress() const { return optional_fields_.progress; }
void set_progress(int progress) { optional_fields_.progress = progress; }
// End unpacked values.
// Images fetched asynchronously.
const gfx::Image& icon() const { return icon_; }
void set_icon(const gfx::Image& icon) { icon_ = icon; }
const gfx::Image& image() const { return optional_fields_.image; }
void set_image(const gfx::Image& image) { optional_fields_.image = image; }
// Buttons, with icons fetched asynchronously.
const std::vector<ButtonInfo>& buttons() const {
return optional_fields_.buttons;
}
void SetButtonIcon(size_t index, const gfx::Image& icon);
bool shown_as_popup() const { return shown_as_popup_; }
void set_shown_as_popup(bool shown_as_popup) {
shown_as_popup_ = shown_as_popup;
}
// Read status in the message center.
bool is_read() const { return is_read_; }
void set_is_read(bool read) { is_read_ = read; }
// Expanded status in the message center (not the popups).
bool is_expanded() const { return is_expanded_; }
void set_is_expanded(bool expanded) { is_expanded_ = expanded; }
// Used to keep the order of notifications with the same timestamp.
// The notification with lesser serial_number is considered 'older'.
unsigned serial_number() { return serial_number_; }
// Marks this explicitly to prevent the timeout dismiss of notification.
// This is used by webkit notifications to keep the existing behavior.
void set_never_timeout(bool never_timeout) {
optional_fields_.never_timeout = never_timeout;
}
bool never_timeout() const { return optional_fields_.never_timeout; }
NotificationDelegate* delegate() const { return delegate_.get(); }
const RichNotificationData& rich_notification_data() const {
return optional_fields_;
}
// Set the priority to SYSTEM. The system priority user needs to call this
// method explicitly, to avoid setting it accidentally.
void SetSystemPriority();
// Delegate actions.
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); }
protected:
// The type of notification we'd like displayed.
NotificationType type_;
std::string id_;
string16 title_;
string16 message_;
// Image data for the associated icon, used by Ash when available.
gfx::Image icon_;
// 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_;
private:
std::string extension_id_;
unsigned serial_number_;
RichNotificationData optional_fields_;
bool shown_as_popup_; // True if this has been shown as a popup.
bool is_read_; // True if this has been seen in the message center.
bool is_expanded_; // True if this has been expanded in the message center.
// A proxy object that allows access back to the JavaScript object that
// represents the notification, for firing events.
scoped_refptr<NotificationDelegate> delegate_;
};
} // namespace message_center
#endif // UI_MESSAGE_CENTER_NOTIFICATION_H_