949424903917ba3fd6df0988c0c91f43fc8fbf45
[WebKit-https.git] / WebKit2 / WebProcess / WebPage / DrawingArea.h
1 /*
2  * Copyright (C) 2010 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef DrawingArea_h
27 #define DrawingArea_h
28
29 #include <WebCore/IntRect.h>
30
31 namespace WebCore {
32     class IntRect;
33     class IntSize;
34 #if USE(ACCELERATED_COMPOSITING)
35     class GraphicsLayer;
36 #endif
37 }
38
39 namespace CoreIPC {
40     class ArgumentDecoder;
41     class Connection;
42     class MessageID;
43 }
44
45 namespace WebKit {
46
47 class WebPage;
48
49 class DrawingArea {
50 public:
51     enum Type {
52         ChunkedUpdateDrawingAreaType,
53 #if USE(ACCELERATED_COMPOSITING)
54         LayerBackedDrawingAreaType,
55 #endif
56     };
57
58     // FIXME: It might make sense to move this create function into a factory style class. 
59     static DrawingArea* create(Type, WebPage*);
60     virtual ~DrawingArea();
61     
62     virtual void invalidateWindow(const WebCore::IntRect& rect, bool immediate) = 0;
63     virtual void invalidateContentsAndWindow(const WebCore::IntRect& rect, bool immediate) = 0;
64     virtual void invalidateContentsForSlowScroll(const WebCore::IntRect& rect, bool immediate) = 0;
65     virtual void scroll(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& rectToScroll, const WebCore::IntRect& clipRect) = 0;
66
67     virtual void setNeedsDisplay(const WebCore::IntRect&) = 0;
68     virtual void display() = 0;
69
70 #if USE(ACCELERATED_COMPOSITING)
71     virtual void attachCompositingContext(WebCore::GraphicsLayer*) = 0;
72     virtual void detachCompositingContext() = 0;
73     virtual void scheduleCompositingLayerSync() = 0;
74     virtual void syncCompositingLayers() = 0;
75 #endif
76
77     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder&) = 0;
78
79     // The DrawingArea should never be encoded itself. Instead, the DrawingAreaProxy should be encoded.
80     // The DrawingArea should also never be decoded itself. Instead, the DrawingArea::Type should be decoded.
81
82 protected:
83     DrawingArea(Type, WebPage*);
84
85     Type m_type;
86     WebPage* m_webPage;
87 };
88
89 } // namespace WebKit
90
91 #endif // DrawingArea_h