WebCore/HostWindow.h

   1 /*
   2  * Copyright (C) 2008 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. ``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 INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef HostWindow_h
  27 #define HostWindow_h
  28
  29 #include <wtf/Noncopyable.h>
  30 #include "IntRect.h"
  31 #include "Widget.h"
  32
  33 namespace WebCore {
  34
  35 class IntPoint;
  36 class IntRect;
  37
  38 class HostWindow : Noncopyable {
  39 public:
  40     HostWindow() {}
  41     virtual ~HostWindow() {}
  42
  43     // The repaint method asks the host window to repaint a rect in the window's coordinate space.  The
  44     // contentChanged boolean indicates whether or not the Web page content actually changed (or if a repaint
  45     // of unchanged content is being requested).
  46     virtual void repaint(const IntRect&, bool contentChanged, bool immediate = false, bool repaintContentOnly = false) = 0;
  47     virtual void scroll(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) = 0;
  48
  49     // The paint method just causes a synchronous update of the window to happen for platforms that need it (Windows).
  50     void paint() { repaint(IntRect(), false, true); }
  51
  52     // Methods for doing coordinate conversions to and from screen coordinates.
  53     virtual IntPoint screenToWindow(const IntPoint&) const = 0;
  54     virtual IntRect windowToScreen(const IntRect&) const = 0;
  55
  56     // Method for retrieving the native window.
  57     virtual PlatformWidget platformWindow() const = 0;
  58
  59     // For scrolling a rect into view recursively.  Useful in the cases where a WebView is embedded inside some containing
  60     // platform-specific ScrollView.
  61     virtual void scrollRectIntoView(const IntRect&, const ScrollView*) const = 0;
  62 };
  63
  64 } // namespace WebCore
  65
  66 #endif // HostWindow_h