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 "WebTextDirection.h"
     36 
     37 #if WEBKIT_IMPLEMENTATION
     38 namespace WebCore { class Notification; }
     39 namespace WTF { template <typename T> class PassRefPtr; }
     40 #endif
     41 
     42 namespace WTF {
     43 class AtomicString;
     44 }
     45 
     46 namespace WebKit {
     47 
     48 class WebNotificationPrivate;
     49 class WebURL;
     50 class WebString;
     51 
     52 // Represents access to a desktop notification.
     53 class WebNotification {
     54 public:
     55     WebNotification() : m_private(0) { }
     56     WebNotification(const WebNotification& other) : m_private(0) { assign(other); }
     57 
     58     ~WebNotification() { reset(); }
     59 
     60     WEBKIT_EXPORT void reset();
     61     WEBKIT_EXPORT void assign(const WebNotification&);
     62 
     63     WebNotification& operator=(const WebNotification& other)
     64     {
     65         assign(other);
     66         return *this;
     67     }
     68 
     69     // Operators required to put WebNotification in an ordered map.
     70     bool equals(const WebNotification& other) const { return m_private == other.m_private; }
     71     WEBKIT_EXPORT bool lessThan(const WebNotification& other) const;
     72 
     73     // DEPRECATED: Always returns false.
     74     WEBKIT_EXPORT bool isHTML() const;
     75 
     76     // DEPRECATED: Always returns an invalid URL.
     77     WEBKIT_EXPORT WebURL url() const;
     78 
     79     WEBKIT_EXPORT WebURL iconURL() const;
     80     WEBKIT_EXPORT WebString title() const;
     81     WEBKIT_EXPORT WebString body() const;
     82     WEBKIT_EXPORT WebTextDirection direction() const;
     83 
     84     WEBKIT_EXPORT WebString replaceId() const;
     85 
     86     // Called if the presenter goes out of scope before the notification does.
     87     WEBKIT_EXPORT void detachPresenter();
     88 
     89     // Called to indicate the notification has been displayed.
     90     WEBKIT_EXPORT void dispatchDisplayEvent();
     91 
     92     // Called to indicate an error has occurred with this notification.
     93     WEBKIT_EXPORT void dispatchErrorEvent(const WebString& errorMessage);
     94 
     95     // Called to indicate the notification has been closed.  If it was
     96     // closed by the user (as opposed to automatically by the system),
     97     // the byUser parameter will be true.
     98     WEBKIT_EXPORT void dispatchCloseEvent(bool byUser);
     99 
    100     // Called to indicate the notification was clicked on.
    101     WEBKIT_EXPORT void dispatchClickEvent();
    102 
    103 #if WEBKIT_IMPLEMENTATION
    104     WebNotification(const WTF::PassRefPtr<WebCore::Notification>&);
    105     WebNotification& operator=(const WTF::PassRefPtr<WebCore::Notification>&);
    106     operator WTF::PassRefPtr<WebCore::Notification>() const;
    107 #endif
    108 
    109 private:
    110     void assign(WebNotificationPrivate*);
    111     void dispatchEvent(const WTF::AtomicString& type);
    112     WebNotificationPrivate* m_private;
    113 };
    114 
    115 inline bool operator==(const WebNotification& a, const WebNotification& b)
    116 {
    117     return a.equals(b);
    118 }
    119 
    120 inline bool operator!=(const WebNotification& a, const WebNotification& b)
    121 {
    122     return !a.equals(b);
    123 }
    124 
    125 inline bool operator<(const WebNotification& a, const WebNotification& b)
    126 {
    127     return a.lessThan(b);
    128 }
    129 
    130 } // namespace WebKit
    131 
    132 #endif
    133