1 /* 2 * Copyright (C) 2009 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebNotification_h 32 #define WebNotification_h 33 34 #include "../platform/WebCommon.h" 35 #include "../platform/WebPrivatePtr.h" 36 #include "../platform/WebString.h" 37 #include "WebTextDirection.h" 38 39 namespace WebCore { class Notification; } 40 41 #if BLINK_IMPLEMENTATION 42 namespace WTF { template <typename T> class PassRefPtr; } 43 #endif 44 45 namespace blink { 46 47 class WebURL; 48 49 // Represents access to a desktop notification. 50 class WebNotification { 51 public: WebNotification()52 WebNotification() { } WebNotification(const WebNotification & other)53 WebNotification(const WebNotification& other) { assign(other); } 54 WebNotification& operator=(const WebNotification& other) 55 { 56 assign(other); 57 return *this; 58 } 59 ~WebNotification()60 ~WebNotification() { reset(); } 61 62 BLINK_EXPORT void reset(); 63 BLINK_EXPORT void assign(const WebNotification&); 64 65 // Operators required to put WebNotification in an std::map. Mind that the 66 // order of the notifications in an ordered map will be arbitrary. 67 BLINK_EXPORT bool equals(const WebNotification& other) const; 68 BLINK_EXPORT bool lessThan(const WebNotification& other) const; 69 70 BLINK_EXPORT WebString title() const; 71 72 BLINK_EXPORT WebTextDirection direction() const; 73 BLINK_EXPORT WebString lang() const; 74 BLINK_EXPORT WebString body() const; 75 BLINK_EXPORT WebString tag() const; 76 BLINK_EXPORT WebURL iconURL() const; 77 78 // Called to indicate the notification has been displayed. 79 BLINK_EXPORT void dispatchShowEvent(); 80 81 // Called to indicate an error has occurred with this notification. 82 BLINK_EXPORT void dispatchErrorEvent(const WebString& errorMessage); 83 84 // Called to indicate the notification has been closed. |byUser| indicates 85 // whether it was closed by the user instead of automatically by the system. 86 BLINK_EXPORT void dispatchCloseEvent(bool byUser); 87 88 // Called to indicate the notification was clicked on. 89 BLINK_EXPORT void dispatchClickEvent(); 90 91 // FIXME: Remove these methods once Chromium switched to the new APIs. replaceId()92 WebString replaceId() const { return tag(); } dispatchDisplayEvent()93 void dispatchDisplayEvent() { dispatchShowEvent(); } 94 95 #if BLINK_IMPLEMENTATION 96 WebNotification(WebCore::Notification*); 97 WebNotification& operator=(WebCore::Notification*); 98 #endif 99 100 private: 101 WebPrivatePtr<WebCore::Notification> m_private; 102 }; 103 104 inline bool operator==(const WebNotification& a, const WebNotification& b) 105 { 106 return a.equals(b); 107 } 108 109 inline bool operator!=(const WebNotification& a, const WebNotification& b) 110 { 111 return !a.equals(b); 112 } 113 114 inline bool operator<(const WebNotification& a, const WebNotification& b) 115 { 116 return a.lessThan(b); 117 } 118 119 } // namespace blink 120 121 #endif 122