LEFT | RIGHT |
1 /* | 1 /* |
2 * This file is part of Adblock Plus <https://adblockplus.org/>, | 2 * This file is part of Adblock Plus <https://adblockplus.org/>, |
3 * Copyright (C) 2006-2015 Eyeo GmbH | 3 * Copyright (C) 2006-2016 Eyeo GmbH |
4 * | 4 * |
5 * Adblock Plus is free software: you can redistribute it and/or modify | 5 * Adblock Plus is free software: you can redistribute it and/or modify |
6 * it under the terms of the GNU General Public License version 3 as | 6 * it under the terms of the GNU General Public License version 3 as |
7 * published by the Free Software Foundation. | 7 * published by the Free Software Foundation. |
8 * | 8 * |
9 * Adblock Plus is distributed in the hope that it will be useful, | 9 * Adblock Plus is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
13 * | 13 * |
14 * You should have received a copy of the GNU General Public License | 14 * You should have received a copy of the GNU General Public License |
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. | 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
16 */ | 16 */ |
17 | 17 |
18 #ifndef ADBLOCK_PLUS_NOTIFICATION_H | 18 #ifndef ADBLOCK_PLUS_NOTIFICATION_H |
19 #define ADBLOCK_PLUS_NOTIFICATION_H | 19 #define ADBLOCK_PLUS_NOTIFICATION_H |
20 | 20 |
21 #include <string> | 21 #include <string> |
22 #include <vector> | 22 #include <vector> |
23 #include "tr1_memory.h" | 23 #include <memory> |
24 | 24 |
25 namespace AdblockPlus | 25 namespace AdblockPlus |
26 { | 26 { |
27 class FilterEngine; | 27 class FilterEngine; |
28 /** | 28 /** |
29 * Possible notification types. | 29 * Possible notification types. |
30 */ | 30 */ |
31 enum NotificationType | 31 enum NotificationType |
32 { | 32 { |
33 NOTIFICATION_TYPE_INFORMATION, | 33 NOTIFICATION_TYPE_INFORMATION, |
34 NOTIFICATION_TYPE_QUESTION, | 34 NOTIFICATION_TYPE_QUESTION, |
35 NOTIFICATION_TYPE_CRITICAL | 35 NOTIFICATION_TYPE_CRITICAL |
36 }; | 36 }; |
37 | 37 |
38 /** | 38 /** |
| 39 * Contains notification title and message. It's returned by |
| 40 * `Notification::GetTexts`. |
| 41 */ |
| 42 struct NotificationTexts |
| 43 { |
| 44 std::string title; |
| 45 std::string message; |
| 46 }; |
| 47 |
| 48 /** |
39 * Wrapper for an Adblock Plus notification object. | 49 * Wrapper for an Adblock Plus notification object. |
40 */ | 50 */ |
41 class Notification: public JsValue | 51 class Notification: public JsValue, |
| 52 public std::enable_shared_from_this<Notification> |
42 { | 53 { |
43 friend class FilterEngine; | 54 friend class FilterEngine; |
44 protected: | 55 protected: |
45 static std::tr1::shared_ptr<Notification> JsValueToNotification(JsValue&& js
Value); | |
46 /** | 56 /** |
47 * Constructor. | 57 * Constructor. |
48 * @param jsValue `JsValuePtr` notification JavaScript object. | 58 * @param jsValue `JsValue&&` notification JavaScript object. |
49 */ | 59 */ |
50 explicit Notification(JsValue&& jsValue); | 60 explicit Notification(JsValue&& jsValue); |
51 public: | 61 public: |
52 /** | 62 /** |
53 * Retrieves the type of this notification. | 63 * Retrieves the type of this notification. |
54 * @return Type of this notification. | 64 * @return Type of this notification. |
55 */ | 65 */ |
56 NotificationType GetType() const; | 66 NotificationType GetType() const; |
57 | 67 |
58 /** | 68 /** |
59 * Retrieves the title of this notification. | 69 * Retrieves the title and message of this notification. |
60 * @return Title of this notification. | 70 * @return Translated texts. |
61 */ | 71 */ |
62 const std::string& GetTitle() const; | 72 NotificationTexts GetTexts() const; |
63 | |
64 /** | |
65 * Retrieves the message of this notification. | |
66 * @return Message of this notification. | |
67 */ | |
68 const std::string& GetMessageString() const; | |
69 | 73 |
70 /** | 74 /** |
71 * Retrieves the URLs which should be mapped to the links in the message. | 75 * Retrieves the URLs which should be mapped to the links in the message. |
72 * @return List of links. | 76 * @return List of links. |
73 */ | 77 */ |
74 std::vector<std::string> GetLinks() const; | 78 std::vector<std::string> GetLinks() const; |
75 | 79 |
76 /** | 80 /** |
77 * Marks this notification as shown. It is only relevant for question | 81 * Marks this notification as shown. It is only relevant for question |
78 * notifications. Other notifications are marked automatically. | 82 * notifications. Other notifications are marked automatically. |
79 */ | 83 */ |
80 void MarkAsShown(); | 84 void MarkAsShown(); |
81 private: | 85 private: |
82 std::string title; | |
83 std::string message; | |
84 NotificationType type; | |
85 }; | 86 }; |
86 typedef std::tr1::shared_ptr<Notification> NotificationPtr; | 87 typedef std::shared_ptr<Notification> NotificationPtr; |
87 } | 88 } |
88 | 89 |
89 #endif | 90 #endif |
LEFT | RIGHT |