Abstract ImageEventSender into a general purpose EventSender
[WebKit-https.git] / Source / WebCore / loader / ImageLoader.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2009 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef ImageLoader_h
24 #define ImageLoader_h
25
26 #include "CachedImage.h"
27 #include "CachedResourceHandle.h"
28 #include <wtf/text/AtomicString.h>
29
30 namespace WebCore {
31
32 class Element;
33 class ImageLoader;
34 class RenderImageResource;
35
36 template<typename T> class EventSender;
37 typedef EventSender<ImageLoader> ImageEventSender;
38
39 class ImageLoader : public CachedImageClient {
40 public:
41     ImageLoader(Element*);
42     virtual ~ImageLoader();
43
44     // This function should be called when the element is attached to a document; starts
45     // loading if a load hasn't already been started.
46     void updateFromElement();
47
48     // This function should be called whenever the 'src' attribute is set, even if its value
49     // doesn't change; starts new load unconditionally (matches Firefox and Opera behavior).
50     void updateFromElementIgnoringPreviousError();
51
52     void elementDidMoveToNewDocument();
53
54     Element* element() const { return m_element; }
55     bool imageComplete() const { return m_imageComplete; }
56
57     CachedImage* image() const { return m_image.get(); }
58     void setImage(CachedImage*); // Cancels pending beforeload and load events, and doesn't dispatch new ones.
59
60     void setLoadManually(bool loadManually) { m_loadManually = loadManually; }
61
62     bool haveFiredBeforeLoadEvent() const { return m_firedBeforeLoad; }
63     bool haveFiredLoadEvent() const { return m_firedLoad; }
64
65     void dispatchPendingEvent(ImageEventSender*);
66
67     static void dispatchPendingBeforeLoadEvents();
68     static void dispatchPendingLoadEvents();
69
70 protected:
71     virtual void notifyFinished(CachedResource*);
72
73 private:
74     virtual void dispatchLoadEvent() = 0;
75     virtual String sourceURI(const AtomicString&) const = 0;
76
77     void dispatchPendingBeforeLoadEvent();
78     void dispatchPendingLoadEvent();
79
80     RenderImageResource* renderImageResource();
81     void updateRenderer();
82
83     Element* m_element;
84     CachedResourceHandle<CachedImage> m_image;
85     AtomicString m_failedLoadURL;
86     bool m_firedBeforeLoad : 1;
87     bool m_firedLoad : 1;
88     bool m_imageComplete : 1;
89     bool m_loadManually : 1;
90 };
91
92 }
93
94 #endif