1/*
2 * Copyright (C) 2013 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 ResourceProgressEvent_h
32#define ResourceProgressEvent_h
33
34#include "core/events/ProgressEvent.h"
35
36namespace blink {
37
38// ResourceProgressEvent is a non-standard class that is simply a ProgressEvent
39// with an additional read-only "url" property containing a string URL. This is
40// used by the Chromium NaCl integration to indicate to which resource the
41// event applies. This is useful because the NaCl integration will download
42// (and translate in the case of PNaCl) multiple binary files. It is not
43// constructable by web content at all, and so does not provide the usual
44// EventInit pattern for Event construction.
45class ResourceProgressEvent FINAL : public ProgressEvent {
46    DEFINE_WRAPPERTYPEINFO();
47public:
48    static PassRefPtrWillBeRawPtr<ResourceProgressEvent> create()
49    {
50        return adoptRefWillBeNoop(new ResourceProgressEvent);
51    }
52    static PassRefPtrWillBeRawPtr<ResourceProgressEvent> create(const AtomicString& type, bool lengthComputable, unsigned long long loaded, unsigned long long total, const String& url)
53    {
54        return adoptRefWillBeNoop(new ResourceProgressEvent(type, lengthComputable, loaded, total, url));
55    }
56
57    const String& url() const;
58
59    virtual const AtomicString& interfaceName() const OVERRIDE;
60
61    virtual void trace(Visitor*) OVERRIDE;
62
63protected:
64    ResourceProgressEvent();
65    ResourceProgressEvent(const AtomicString& type, bool lengthComputable, unsigned long long loaded, unsigned long long total, const String& url);
66
67private:
68    String m_url;
69};
70
71} // namespace blink
72
73#endif // ResourceProgressEvent_h
74