Repository navigation
Expand file tree
/
Copy pathcef_window.h
More file actions
318 lines (279 loc) · 9.36 KB
/
Copy pathcef_window.h
File metadata and controls
318 lines (279 loc) · 9.36 KB
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
// Copyright (c) 2016 Marshall A. Greenblatt. 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 name Chromium Embedded
// Framework 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.
//
// ---------------------------------------------------------------------------
//
// The contents of this file must follow a specific format in order to
// support the CEF translator tool. See the translator.README.txt file in the
// tools directory for more information.
//
#ifndef CEF_INCLUDE_VIEWS_CEF_WINDOW_H_
#define CEF_INCLUDE_VIEWS_CEF_WINDOW_H_
#pragma once
#include "include/cef_image.h"
#include "include/cef_menu_model.h"
#include "include/views/cef_display.h"
#include "include/views/cef_panel.h"
#include "include/views/cef_window_delegate.h"
///
// A Window is a top-level Window/widget in the Views hierarchy. By default it
// will have a non-client area with title bar, icon and buttons that supports
// moving and resizing. All size and position values are in density independent
// pixels (DIP) unless otherwise indicated. Methods must be called on the
// browser process UI thread unless otherwise indicated.
///
/*--cef(source=library)--*/
class CefWindow : public CefPanel {
public:
///
// Create a new Window.
///
/*--cef(optional_param=delegate)--*/
static CefRefPtr<CefWindow> CreateTopLevelWindow(
CefRefPtr<CefWindowDelegate> delegate);
///
// Show the Window.
///
/*--cef()--*/
virtual void Show() =0;
///
// Hide the Window.
///
/*--cef()--*/
virtual void Hide() =0;
///
// Sizes the Window to |size| and centers it in the current display.
///
/*--cef()--*/
virtual void CenterWindow(const CefSize& size) =0;
///
// Close the Window.
///
/*--cef()--*/
virtual void Close() =0;
///
// Returns true if the Window has been closed.
///
/*--cef()--*/
virtual bool IsClosed() =0;
///
// Activate the Window, assuming it already exists and is visible.
///
/*--cef()--*/
virtual void Activate() =0;
///
// Deactivate the Window, making the next Window in the Z order the active
// Window.
///
/*--cef()--*/
virtual void Deactivate() =0;
///
// Returns whether the Window is the currently active Window.
///
/*--cef()--*/
virtual bool IsActive() =0;
///
// Bring this Window to the top of other Windows in the Windowing system.
///
/*--cef()--*/
virtual void BringToTop() =0;
///
// Set the Window to be on top of other Windows in the Windowing system.
///
/*--cef()--*/
virtual void SetAlwaysOnTop(bool on_top) =0;
///
// Returns whether the Window has been set to be on top of other Windows in
// the Windowing system.
///
/*--cef()--*/
virtual bool IsAlwaysOnTop() =0;
///
// Maximize the Window.
///
/*--cef()--*/
virtual void Maximize() =0;
///
// Minimize the Window.
///
/*--cef()--*/
virtual void Minimize() =0;
///
// Restore the Window.
///
/*--cef()--*/
virtual void Restore() =0;
///
// Set fullscreen Window state.
///
/*--cef()--*/
virtual void SetFullscreen(bool fullscreen) =0;
///
// Returns true if the Window is maximized.
///
/*--cef()--*/
virtual bool IsMaximized() =0;
///
// Returns true if the Window is minimized.
///
/*--cef()--*/
virtual bool IsMinimized() =0;
///
// Returns true if the Window is fullscreen.
///
/*--cef()--*/
virtual bool IsFullscreen() =0;
///
// Set the Window title.
///
/*--cef(optional_param=title)--*/
virtual void SetTitle(const CefString& title) =0;
///
// Get the Window title.
///
/*--cef()--*/
virtual CefString GetTitle() =0;
///
// Set the Window icon. This should be a 16x16 icon suitable for use in the
// Windows's title bar.
///
/*--cef()--*/
virtual void SetWindowIcon(CefRefPtr<CefImage> image) =0;
///
// Get the Window icon.
///
/*--cef()--*/
virtual CefRefPtr<CefImage> GetWindowIcon() =0;
///
// Set the Window App icon. This should be a larger icon for use in the host
// environment app switching UI. On Windows, this is the ICON_BIG used in
// Alt-Tab list and Windows taskbar. The Window icon will be used by default
// if no Window App icon is specified.
///
/*--cef()--*/
virtual void SetWindowAppIcon(CefRefPtr<CefImage> image) =0;
///
// Get the Window App icon.
///
/*--cef()--*/
virtual CefRefPtr<CefImage> GetWindowAppIcon() =0;
///
// Show a menu with contents |menu_model|. |screen_point| specifies the menu
// position in screen coordinates. |anchor_position| specifies how the menu
// will be anchored relative to |screen_point|.
///
/*--cef()--*/
virtual void ShowMenu(CefRefPtr<CefMenuModel> menu_model,
const CefPoint& screen_point,
cef_menu_anchor_position_t anchor_position) =0;
///
// Cancel the menu that is currently showing, if any.
///
/*--cef()--*/
virtual void CancelMenu() =0;
///
// Returns the Display that most closely intersects the bounds of this Window.
// May return NULL if this Window is not currently displayed.
///
/*--cef()--*/
virtual CefRefPtr<CefDisplay> GetDisplay() =0;
///
// Returns the bounds (size and position) of this Window's client area.
// Position is in screen coordinates.
///
/*--cef()--*/
virtual CefRect GetClientAreaBoundsInScreen() =0;
///
// Set the regions where mouse events will be intercepted by this Window to
// support drag operations. Call this method with an empty vector to clear the
// draggable regions. The draggable region bounds should be in window
// coordinates.
///
/*--cef(optional_param=regions)--*/
virtual void SetDraggableRegions(
const std::vector<CefDraggableRegion>& regions) =0;
///
// Retrieve the platform window handle for this Window.
///
/*--cef()--*/
virtual CefWindowHandle GetWindowHandle() =0;
///
// Simulate a key press. |key_code| is the VKEY_* value from Chromium's
// ui/events/keycodes/keyboard_codes.h header (VK_* values on Windows).
// |event_flags| is some combination of EVENTFLAG_SHIFT_DOWN,
// EVENTFLAG_CONTROL_DOWN and/or EVENTFLAG_ALT_DOWN. This method is exposed
// primarily for testing purposes.
///
/*--cef()--*/
virtual void SendKeyPress(int key_code,
uint32 event_flags) =0;
///
// Simulate a mouse move. The mouse cursor will be moved to the specified
// (screen_x, screen_y) position. This method is exposed primarily for testing
// purposes.
///
/*--cef()--*/
virtual void SendMouseMove(int screen_x, int screen_y) =0;
///
// Simulate mouse down and/or mouse up events. |button| is the mouse button
// type. If |mouse_down| is true a mouse down event will be sent. If
// |mouse_up| is true a mouse up event will be sent. If both are true a mouse
// down event will be sent followed by a mouse up event (equivalent to
// clicking the mouse button). The events will be sent using the current
// cursor position so make sure to call SendMouseMove() first to position the
// mouse. This method is exposed primarily for testing purposes.
///
/*--cef()--*/
virtual void SendMouseEvents(cef_mouse_button_type_t button,
bool mouse_down,
bool mouse_up) =0;
///
// Set the keyboard accelerator for the specified |command_id|. |key_code| can
// be any virtual key or character value. CefWindowDelegate::OnAccelerator
// will be called if the keyboard combination is triggered while this window
// has focus.
///
/*--cef()--*/
virtual void SetAccelerator(int command_id,
int key_code,
bool shift_pressed,
bool ctrl_pressed,
bool alt_pressed) =0;
///
// Remove the keyboard accelerator for the specified |command_id|.
///
/*--cef()--*/
virtual void RemoveAccelerator(int command_id) =0;
///
// Remove all keyboard accelerators.
///
/*--cef()--*/
virtual void RemoveAllAccelerators() =0;
};
#endif // CEF_INCLUDE_VIEWS_CEF_WINDOW_H_