Apply FINAL to the Node hierarchy.
[WebKit.git] / Source / WebCore / html / ImageDocument.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
20  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
23  */
24
25 #ifndef ImageDocument_h
26 #define ImageDocument_h
27
28 #include "HTMLDocument.h"
29
30 namespace WebCore {
31
32 class CachedImage;
33 class ImageDocumentElement;
34
35 class ImageDocument FINAL : public HTMLDocument {
36 public:
37     static PassRefPtr<ImageDocument> create(Frame* frame, const KURL& url)
38     {
39         return adoptRef(new ImageDocument(frame, url));
40     }
41
42     CachedImage* cachedImage();
43     ImageDocumentElement* imageElement() const { return m_imageElement; }
44     void disconnectImageElement() { m_imageElement = 0; }
45     
46     void windowSizeChanged();
47     void imageUpdated();
48     void imageClicked(int x, int y);
49
50 private:
51     ImageDocument(Frame*, const KURL&);
52
53     virtual PassRefPtr<DocumentParser> createParser();
54     
55     void createDocumentStructure();
56     void resizeImageToFit();
57     void restoreImageSize();
58     bool imageFitsInWindow() const;
59     bool shouldShrinkToFit() const;
60     float scale() const;
61     
62     ImageDocumentElement* m_imageElement;
63     
64     // Whether enough of the image has been loaded to determine its size
65     bool m_imageSizeIsKnown;
66     
67     // Whether the image is shrunk to fit or not
68     bool m_didShrinkImage;
69     
70     // Whether the image should be shrunk or not
71     bool m_shouldShrinkImage;
72 };
73
74 inline ImageDocument* toImageDocument(Document* document)
75 {
76     ASSERT_WITH_SECURITY_IMPLICATION(!document || document->isImageDocument());
77     return static_cast<ImageDocument*>(document);
78 }
79
80 inline const ImageDocument* toImageDocument(const Document* document)
81 {
82     ASSERT_WITH_SECURITY_IMPLICATION(!document || document->isImageDocument());
83     return static_cast<const ImageDocument*>(document);
84 }
85
86 // This will catch anyone doing an unnecessary cast.
87 void toImageDocument(const ImageDocument*);
88
89 }
90
91 #endif // ImageDocument_h