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 "Widget.h"
30
31namespace WebCore {
32
33class Cursor;
34
35class HostWindow {
36    WTF_MAKE_NONCOPYABLE(HostWindow); WTF_MAKE_FAST_ALLOCATED;
37public:
38    HostWindow() { }
39    virtual ~HostWindow() { }
40
41    // Requests the host invalidate the root view, not the contents. If immediate is true do so synchronously, otherwise async.
42    virtual void invalidateRootView(const IntRect& updateRect, bool immediate) = 0;
43
44    // Requests the host invalidate the contents and the root view. If immediate is true do so synchronously, otherwise async.
45    virtual void invalidateContentsAndRootView(const IntRect& updateRect, bool immediate) = 0;
46
47    // Requests the host scroll backingstore by the specified delta, rect to scroll, and clip rect.
48    virtual void scroll(const IntSize& scrollDelta, const IntRect& rectToScroll, const IntRect& clipRect) = 0;
49
50    // Requests the host invalidate the contents, not the root view. This is the slow path for scrolling.
51    virtual void invalidateContentsForSlowScroll(const IntRect& updateRect, bool immediate) = 0;
52
53#if USE(TILED_BACKING_STORE)
54    // Requests the host to do the actual scrolling. This is only used in combination with a tiled backing store.
55    virtual void delegatedScrollRequested(const IntPoint& scrollPoint) = 0;
56#endif
57
58    // Methods for doing coordinate conversions to and from screen coordinates.
59    virtual IntPoint screenToRootView(const IntPoint&) const = 0;
60    virtual IntRect rootViewToScreen(const IntRect&) const = 0;
61
62    // Method for retrieving the native client of the page.
63    virtual PlatformPageClient platformPageClient() const = 0;
64
65    // To notify WebKit of scrollbar mode changes.
66    virtual void scrollbarsModeDidChange() const = 0;
67
68    // Request that the cursor change.
69    virtual void setCursor(const Cursor&) = 0;
70
71    virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
72
73#if ENABLE(REQUEST_ANIMATION_FRAME)
74    virtual void scheduleAnimation() = 0;
75#endif
76};
77
78} // namespace WebCore
79
80#endif // HostWindow_h
81