system_notification.h revision c407dc5cd9bdc5668497f21b26b09d988ab439de
1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright (c) 2010 The Chromium Authors. All rights reserved.
2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Use of this source code is governed by a BSD-style license that can be
3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// found in the LICENSE file.
4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef CHROME_BROWSER_CHROMEOS_NOTIFICATIONS_SYSTEM_NOTIFICATION_H_
6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define CHROME_BROWSER_CHROMEOS_NOTIFICATIONS_SYSTEM_NOTIFICATION_H_
7c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string>
9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/basictypes.h"
11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/move.h"
12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/ref_counted.h"
13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/string16.h"
14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "chrome/browser/chromeos/notifications/balloon_collection_impl.h"
15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "chrome/browser/notifications/notification_delegate.h"
16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "googleurl/src/gurl.h"
17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass Profile;
19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochnamespace chromeos {
21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// The system notification object handles the display of a system notification
23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass SystemNotification {
25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public:
26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // The profile is the current user profile. The id is any string used
27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // to uniquely identify this notification. The title is the title of
28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // the message to be displayed. On creation, the message is hidden.
29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  SystemNotification(Profile* profile, std::string id, int icon_resource_id,
30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch                     string16 title);
31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  ~SystemNotification();
33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
34c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Show will show or update the message for this notification
35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // on a transition to urgent, the notification will be shown if it was
36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // previously hidden or minimized by the user.
37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  void Show(const string16& message, bool urgent);
38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Hide will dismiss the notification, if the notification is already
40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // hidden it does nothing
41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  void Hide();
42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Current visibility state for this notification.
44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  bool visible() const { return visible_; }
45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  // Current urgent state for this notification.
47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  bool urgent() const { return urgent_; }
48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private:
50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  class Delegate : public NotificationDelegate {
51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch   public:
52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    explicit Delegate(std::string id) : id_(base::move(id)) {}
53c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    void Display() {}
54c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    void Error() {}
55c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    void Close(bool by_user) {}
56c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    std::string id() const { return id_; }
57c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
58c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch   private:
59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    std::string id_;
60c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
61c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch    DISALLOW_COPY_AND_ASSIGN(Delegate);
62c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  };
63c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
64c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  Profile* profile_;
65c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  BalloonCollectionImpl* collection_;
66c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  scoped_refptr<Delegate> delegate_;
67c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  GURL icon_;
68c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  string16 title_;
69c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  bool visible_;
70c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  bool urgent_;
71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch  DISALLOW_COPY_AND_ASSIGN(SystemNotification);
73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch};
74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}  // namespace chromeos
76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif  // CHROME_BROWSER_CHROMEOS_NOTIFICATIONS_SYSTEM_NOTIFICATION_H_
78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch
79