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