Home | History | Annotate | Download | only in web 
      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 #if BLINK_IMPLEMENTATION
     40 namespace WTF { template <typename T> class PassRefPtr; }
     41 #endif
     42 
     43 namespace blink {
     44 
     45 class Notification;
     46 class WebURL;
     47 
     48 // Represents access to a desktop notification.
     49 class WebNotification {
     50 public:
     51     WebNotification() { }
     52     WebNotification(const WebNotification& other) { assign(other); }
     53     WebNotification& operator=(const WebNotification& other)
     54     {
     55         assign(other);
     56         return *this;
     57     }
     58 
     59     ~WebNotification() { reset(); }
     60 
     61     BLINK_EXPORT void reset();
     62     BLINK_EXPORT void assign(const WebNotification&);
     63 
     64     // Operators required to put WebNotification in an std::map. Mind that the
     65     // order of the notifications in an ordered map will be arbitrary.
     66     BLINK_EXPORT bool equals(const WebNotification& other) const;
     67     BLINK_EXPORT bool lessThan(const WebNotification& other) const;
     68 
     69     BLINK_EXPORT WebString title() const;
     70 
     71     BLINK_EXPORT WebTextDirection direction() const;
     72     BLINK_EXPORT WebString lang() const;
     73     BLINK_EXPORT WebString body() const;
     74     BLINK_EXPORT WebString tag() const;
     75     BLINK_EXPORT WebURL iconURL() const;
     76 
     77     // Called to indicate the notification has been displayed.
     78     BLINK_EXPORT void dispatchShowEvent();
     79 
     80     // Called to indicate an error has occurred with this notification.
     81     BLINK_EXPORT void dispatchErrorEvent(const WebString& errorMessage);
     82 
     83     // Called to indicate the notification has been closed. |byUser| indicates
     84     // whether it was closed by the user instead of automatically by the system.
     85     BLINK_EXPORT void dispatchCloseEvent(bool byUser);
     86 
     87     // Called to indicate the notification was clicked on.
     88     BLINK_EXPORT void dispatchClickEvent();
     89 
     90     // FIXME: Remove these methods once Chromium switched to the new APIs.
     91     WebString replaceId() const { return tag(); }
     92     void dispatchDisplayEvent() { dispatchShowEvent(); }
     93 
     94 #if BLINK_IMPLEMENTATION
     95     WebNotification(Notification*);
     96     WebNotification& operator=(Notification*);
     97 #endif
     98 
     99 private:
    100     WebPrivatePtr<Notification> m_private;
    101 };
    102 
    103 inline bool operator==(const WebNotification& a, const WebNotification& b)
    104 {
    105     return a.equals(b);
    106 }
    107 
    108 inline bool operator!=(const WebNotification& a, const WebNotification& b)
    109 {
    110     return !a.equals(b);
    111 }
    112 
    113 inline bool operator<(const WebNotification& a, const WebNotification& b)
    114 {
    115     return a.lessThan(b);
    116 }
    117 
    118 } // namespace blink
    119 
    120 #endif
    121