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     // This has to match DrawingAreaProxy::Type.

    52     enum Type {

    53         None,

    54         ChunkedUpdateDrawingAreaType,

    55 #if USE(ACCELERATED_COMPOSITING)

    56         LayerBackedDrawingAreaType,

    57 #endif

    58     };

    59 

    60     // FIXME: It might make sense to move this create function into a factory style class. 

    61     static DrawingArea* create(Type, WebPage*);

    62     virtual ~DrawingArea();

    63     

    64     Type type() const { return m_type; }

    65     

    66     virtual void invalidateWindow(const WebCore::IntRect& rect, bool immediate) = 0;

    67     virtual void invalidateContentsAndWindow(const WebCore::IntRect& rect, bool immediate) = 0;

    68     virtual void invalidateContentsForSlowScroll(const WebCore::IntRect& rect, bool immediate) = 0;

    69     virtual void scroll(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& rectToScroll, const WebCore::IntRect& clipRect) = 0;

    70 

    71     virtual void setNeedsDisplay(const WebCore::IntRect&) = 0;

    72     virtual void display() = 0;

    73 

    74 #if USE(ACCELERATED_COMPOSITING)

    75     virtual void attachCompositingContext() = 0;

    76     virtual void detachCompositingContext() = 0;

    77     virtual void setRootCompositingLayer(WebCore::GraphicsLayer*) = 0;

    78     virtual void scheduleCompositingLayerSync() = 0;

    79     virtual void syncCompositingLayers() = 0;

    80 #endif

    81 

    82     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder&) = 0;

    83 

    84     // The DrawingArea should never be encoded itself. Instead, the DrawingAreaProxy should be encoded.

    85     // The DrawingArea should also never be decoded itself. Instead, the DrawingArea::Type should be decoded.

    86 

    87 protected:

    88     DrawingArea(Type, WebPage*);

    89 

    90     Type m_type;

    91     WebPage* m_webPage;

    92 };

    93 

    94 } // namespace WebKit

    95 

    96 #endif // DrawingArea_h