summaryrefslogtreecommitdiffstats
path: root/webkit/api/public/WebNotification.h
blob: fb6cd6df0352eb6ef8bd1132da09558e85a5bd86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * Copyright (C) 2009 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebNotification_h
#define WebNotification_h

#include "WebCommon.h"

#if WEBKIT_IMPLEMENTATION
namespace WebCore { class Notification; }
namespace WTF { template <typename T> class PassRefPtr; }
#endif

namespace WebKit {
    class WebNotificationPrivate;
    class WebURL;
    class WebString;

    // Represents access to a desktop notification.
    class WebNotification {
    public:
        WebNotification() : m_private(0) { }
        WebNotification(const WebNotification& other) : m_private(0) { assign(other); }

        ~WebNotification() { reset(); }

        WEBKIT_API void reset();
        WEBKIT_API void assign(const WebNotification&);

        WebNotification& operator=(const WebNotification& other) { assign(other); return *this; }

        // Operators required to put WebNotification in an ordered map.
        bool equals(const WebNotification& other) const { return m_private == other.m_private; }
        bool lessThan(const WebNotification& other) const;

        // Is the notification HTML vs. icon-title-text?
        WEBKIT_API bool isHTML() const;

        // If HTML, the URL which contains the contents of the notification.
        WEBKIT_API WebURL url() const;

        // If not HTML, the parameters for the icon-title-text notification.
        WEBKIT_API WebString icon() const;
        WEBKIT_API WebString title() const;
        WEBKIT_API WebString body() const;

        // Called to indicate the notification has been displayed.
        WEBKIT_API void dispatchDisplayEvent();

        // Called to indicate an error has occurred with this notification.
        WEBKIT_API void dispatchErrorEvent(const WebString& errorMessage);

        // Called to indicate the notification has been closed.  If it was
        // closed by the user (as opposed to automatically by the system),
        // the byUser parameter will be true.
        WEBKIT_API void dispatchCloseEvent(bool byUser);

#if WEBKIT_IMPLEMENTATION
        WebNotification(const WTF::PassRefPtr<WebCore::Notification>&);
        WebNotification& operator=(const WTF::PassRefPtr<WebCore::Notification>&);
        operator WTF::PassRefPtr<WebCore::Notification>() const;
#endif

    private:
        void assign(WebNotificationPrivate*);
        WebNotificationPrivate* m_private;
    };

    inline bool operator==(const WebNotification& a, const WebNotification& b)
    {
        return a.equals(b);
    }

    inline bool operator!=(const WebNotification& a, const WebNotification& b)
    {
        return !a.equals(b);
    }

    inline bool operator<(const WebNotification& a, const WebNotification& b)
    {
        return a.lessThan(b);
    }

} // namespace WebKit

#endif