1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebWidgetClient_h
#define WebWidgetClient_h
#include "WebNavigationPolicy.h"
#include "WebScreenInfo.h"
#include "platform/WebCommon.h"
#include "platform/WebRect.h"
namespace WebKit {
class WebString;
class WebWidget;
struct WebCursorInfo;
struct WebSize;
class WebWidgetClient {
public:
// Called when a region of the WebWidget needs to be re-painted.
virtual void didInvalidateRect(const WebRect&) { }
// Called when a region of the WebWidget, given by clipRect, should be
// scrolled by the specified dx and dy amounts.
virtual void didScrollRect(int dx, int dy, const WebRect& clipRect) { }
// Called when the Widget has changed size as a result of an auto-resize.
virtual void didAutoResize(const WebSize& newSize) { }
// Called when the compositor is enabled or disabled.
// The inputHandlerIdentifier can be used on the compositor thread to get access
// to the WebCompositorInputHandler instance associated with this WebWidget.
// If there is no WebCompositorInputHandler associated with this WebWidget (for example if
// threaded compositing is not enabled) then calling WebCompositorInputHandler::fromIdentifier()
// for the specified identifier will return 0.
virtual void didActivateCompositor(int inputHandlerIdentifier) { }
virtual void didDeactivateCompositor() { }
// Indicates to the embedder that the compositor is about to begin a
// frame. This is primarily to signal to flow control mechanisms that a
// frame is beginning, not to perform actual painting work.
virtual void willBeginCompositorFrame() { }
// Indicates to the embedder that the WebWidget is ready for additional
// input.
virtual void didBecomeReadyForAdditionalInput() { }
// Called for compositing mode when the draw commands for a WebKit-side
// frame have been issued.
virtual void didCommitAndDrawCompositorFrame() { }
// Called for compositing mode when swapbuffers has been posted in the GPU
// process.
virtual void didCompleteSwapBuffers() { }
// Called when a call to WebWidget::composite is required
virtual void scheduleComposite() { }
// Called when a call to WebWidget::animate is required
virtual void scheduleAnimation() { }
// Called when the widget acquires or loses focus, respectively.
virtual void didFocus() { }
virtual void didBlur() { }
// Called when the cursor for the widget changes.
virtual void didChangeCursor(const WebCursorInfo&) { }
// Called when the widget should be closed. WebWidget::close() should
// be called asynchronously as a result of this notification.
virtual void closeWidgetSoon() { }
// Called to show the widget according to the given policy.
virtual void show(WebNavigationPolicy) { }
// Called to block execution of the current thread until the widget is
// closed.
virtual void runModal() { }
// Called to enter/exit fullscreen mode. If enterFullScreen returns true,
// then WebWidget::{will,Did}EnterFullScreen should bound resizing the
// WebWidget into fullscreen mode. Similarly, when exitFullScreen is
// called, WebWidget::{will,Did}ExitFullScreen should bound resizing the
// WebWidget out of fullscreen mode.
virtual bool enterFullScreen() { return false; }
virtual void exitFullScreen() { }
// Called to get/set the position of the widget in screen coordinates.
virtual WebRect windowRect() { return WebRect(); }
virtual void setWindowRect(const WebRect&) { }
// Called when a tooltip should be shown at the current cursor position.
virtual void setToolTipText(const WebString&, WebTextDirection hint) { }
// Called to get the position of the resizer rect in window coordinates.
virtual WebRect windowResizerRect() { return WebRect(); }
// Called to get the position of the root window containing the widget
// in screen coordinates.
virtual WebRect rootWindowRect() { return WebRect(); }
// Called to query information about the screen where this widget is
// displayed.
virtual WebScreenInfo screenInfo() { return WebScreenInfo(); }
// Called to get the scale factor of the display.
virtual float deviceScaleFactor() { return 1; }
// When this method gets called, WebWidgetClient implementation should
// reset the input method by cancelling any ongoing composition.
virtual void resetInputMethod() { }
// Requests to lock the mouse cursor. If true is returned, the success
// result will be asynchronously returned via a single call to
// WebWidget::didAcquirePointerLock() or
// WebWidget::didNotAcquirePointerLock().
// If false, the request has been denied synchronously.
virtual bool requestPointerLock() { return false; }
// Cause the pointer lock to be released. This may be called at any time,
// including when a lock is pending but not yet acquired.
// WebWidget::didLosePointerLock() is called when unlock is complete.
virtual void requestPointerUnlock() { }
// Returns true iff the pointer is locked to this widget.
virtual bool isPointerLocked() { return false; }
protected:
~WebWidgetClient() { }
};
} // namespace WebKit
#endif
|
