This repository was archived by the owner on Aug 2, 2025. It is now read-only.
forked from cztomczak/cefpython
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathcef_view.h
More file actions
401 lines (349 loc) · 12.5 KB
/
cef_view.h
File metadata and controls
401 lines (349 loc) · 12.5 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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
// 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_VIEW_H_
#define CEF_INCLUDE_VIEWS_CEF_VIEW_H_
#pragma once
#include "include/views/cef_view_delegate.h"
class CefBrowserView;
class CefButton;
class CefPanel;
class CefScrollView;
class CefTextfield;
class CefWindow;
///
// A View is a rectangle within the views View hierarchy. It is the base class
// for all Views. 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 CefView : public CefBaseRefCounted {
public:
///
// Returns this View as a BrowserView or NULL if this is not a BrowserView.
///
/*--cef()--*/
virtual CefRefPtr<CefBrowserView> AsBrowserView() = 0;
///
// Returns this View as a Button or NULL if this is not a Button.
///
/*--cef()--*/
virtual CefRefPtr<CefButton> AsButton() = 0;
///
// Returns this View as a Panel or NULL if this is not a Panel.
///
/*--cef()--*/
virtual CefRefPtr<CefPanel> AsPanel() = 0;
///
// Returns this View as a ScrollView or NULL if this is not a ScrollView.
///
/*--cef()--*/
virtual CefRefPtr<CefScrollView> AsScrollView() = 0;
///
// Returns this View as a Textfield or NULL if this is not a Textfield.
///
/*--cef()--*/
virtual CefRefPtr<CefTextfield> AsTextfield() = 0;
///
// Returns the type of this View as a string. Used primarily for testing
// purposes.
///
/*--cef()--*/
virtual CefString GetTypeString() = 0;
///
// Returns a string representation of this View which includes the type and
// various type-specific identifying attributes. If |include_children| is true
// any child Views will also be included. Used primarily for testing purposes.
///
/*--cef()--*/
virtual CefString ToString(bool include_children) = 0;
///
// Returns true if this View is valid.
///
/*--cef()--*/
virtual bool IsValid() = 0;
///
// Returns true if this View is currently attached to another View. A View can
// only be attached to one View at a time.
///
/*--cef()--*/
virtual bool IsAttached() = 0;
///
// Returns true if this View is the same as |that| View.
///
/*--cef()--*/
virtual bool IsSame(CefRefPtr<CefView> that) = 0;
///
// Returns the delegate associated with this View, if any.
///
/*--cef()--*/
virtual CefRefPtr<CefViewDelegate> GetDelegate() = 0;
///
// Returns the top-level Window hosting this View, if any.
///
/*--cef()--*/
virtual CefRefPtr<CefWindow> GetWindow() = 0;
///
// Returns the ID for this View.
///
/*--cef()--*/
virtual int GetID() = 0;
///
// Sets the ID for this View. ID should be unique within the subtree that you
// intend to search for it. 0 is the default ID for views.
///
/*--cef()--*/
virtual void SetID(int id) = 0;
///
// Returns the group id of this View, or -1 if not set.
///
/*--cef()--*/
virtual int GetGroupID() = 0;
///
// A group id is used to tag Views which are part of the same logical group.
// Focus can be moved between views with the same group using the arrow keys.
// The group id is immutable once it's set.
///
/*--cef()--*/
virtual void SetGroupID(int group_id) = 0;
///
// Returns the View that contains this View, if any.
///
/*--cef()--*/
virtual CefRefPtr<CefView> GetParentView() = 0;
///
// Recursively descends the view tree starting at this View, and returns the
// first child that it encounters with the given ID. Returns NULL if no
// matching child view is found.
///
/*--cef()--*/
virtual CefRefPtr<CefView> GetViewForID(int id) = 0;
///
// Sets the bounds (size and position) of this View. Position is in parent
// coordinates.
///
/*--cef()--*/
virtual void SetBounds(const CefRect& bounds) = 0;
///
// Returns the bounds (size and position) of this View. Position is in parent
// coordinates.
///
/*--cef()--*/
virtual CefRect GetBounds() = 0;
///
// Returns the bounds (size and position) of this View. Position is in screen
// coordinates.
///
/*--cef()--*/
virtual CefRect GetBoundsInScreen() = 0;
///
// Sets the size of this View without changing the position.
///
/*--cef()--*/
virtual void SetSize(const CefSize& size) = 0;
///
// Returns the size of this View.
///
/*--cef()--*/
virtual CefSize GetSize() = 0;
///
// Sets the position of this View without changing the size. |position| is in
// parent coordinates.
///
/*--cef()--*/
virtual void SetPosition(const CefPoint& position) = 0;
///
// Returns the position of this View. Position is in parent coordinates.
///
/*--cef()--*/
virtual CefPoint GetPosition() = 0;
///
// Returns the size this View would like to be if enough space is available.
///
/*--cef()--*/
virtual CefSize GetPreferredSize() = 0;
///
// Size this View to its preferred size.
///
/*--cef()--*/
virtual void SizeToPreferredSize() = 0;
///
// Returns the minimum size for this View.
///
/*--cef()--*/
virtual CefSize GetMinimumSize() = 0;
///
// Returns the maximum size for this View.
///
/*--cef()--*/
virtual CefSize GetMaximumSize() = 0;
///
// Returns the height necessary to display this View with the provided width.
///
/*--cef()--*/
virtual int GetHeightForWidth(int width) = 0;
///
// Indicate that this View and all parent Views require a re-layout. This
// ensures the next call to Layout() will propagate to this View even if the
// bounds of parent Views do not change.
///
/*--cef()--*/
virtual void InvalidateLayout() = 0;
///
// Sets whether this View is visible. Windows are hidden by default and other
// views are visible by default. This View and any parent views must be set as
// visible for this View to be drawn in a Window. If this View is set as
// hidden then it and any child views will not be drawn and, if any of those
// views currently have focus, then focus will also be cleared. Painting is
// scheduled as needed. If this View is a Window then calling this method is
// equivalent to calling the Window Show() and Hide() methods.
///
/*--cef()--*/
virtual void SetVisible(bool visible) = 0;
///
// Returns whether this View is visible. A view may be visible but still not
// drawn in a Window if any parent views are hidden. If this View is a Window
// then a return value of true indicates that this Window is currently visible
// to the user on-screen. If this View is not a Window then call IsDrawn() to
// determine whether this View and all parent views are visible and will be
// drawn.
///
/*--cef()--*/
virtual bool IsVisible() = 0;
///
// Returns whether this View is visible and drawn in a Window. A view is drawn
// if it and all parent views are visible. If this View is a Window then
// calling this method is equivalent to calling IsVisible(). Otherwise, to
// determine if the containing Window is visible to the user on-screen call
// IsVisible() on the Window.
///
/*--cef()--*/
virtual bool IsDrawn() = 0;
///
// Set whether this View is enabled. A disabled View does not receive keyboard
// or mouse inputs. If |enabled| differs from the current value the View will
// be repainted. Also, clears focus if the focused View is disabled.
///
/*--cef()--*/
virtual void SetEnabled(bool enabled) = 0;
///
// Returns whether this View is enabled.
///
/*--cef()--*/
virtual bool IsEnabled() = 0;
///
// Sets whether this View is capable of taking focus. It will clear focus if
// the focused View is set to be non-focusable. This is false by default so
// that a View used as a container does not get the focus.
///
/*--cef()--*/
virtual void SetFocusable(bool focusable) = 0;
///
// Returns true if this View is focusable, enabled and drawn.
///
/*--cef()--*/
virtual bool IsFocusable() = 0;
///
// Return whether this View is focusable when the user requires full keyboard
// access, even though it may not be normally focusable.
///
/*--cef()--*/
virtual bool IsAccessibilityFocusable() = 0;
///
// Request keyboard focus. If this View is focusable it will become the
// focused View.
///
/*--cef()--*/
virtual void RequestFocus() = 0;
///
// Sets the background color for this View.
///
/*--cef()--*/
virtual void SetBackgroundColor(cef_color_t color) = 0;
///
// Returns the background color for this View.
///
/*--cef()--*/
virtual cef_color_t GetBackgroundColor() = 0;
///
// Convert |point| from this View's coordinate system to that of the screen.
// This View must belong to a Window when calling this method. Returns true
// if the conversion is successful or false otherwise. Use
// CefDisplay::ConvertPointToPixels() after calling this method if further
// conversion to display-specific pixel coordinates is desired.
///
/*--cef()--*/
virtual bool ConvertPointToScreen(CefPoint& point) = 0;
///
// Convert |point| to this View's coordinate system from that of the screen.
// This View must belong to a Window when calling this method. Returns true if
// the conversion is successful or false otherwise. Use
// CefDisplay::ConvertPointFromPixels() before calling this method if
// conversion from display-specific pixel coordinates is necessary.
///
/*--cef()--*/
virtual bool ConvertPointFromScreen(CefPoint& point) = 0;
///
// Convert |point| from this View's coordinate system to that of the Window.
// This View must belong to a Window when calling this method. Returns true if
// the conversion is successful or false otherwise.
///
/*--cef()--*/
virtual bool ConvertPointToWindow(CefPoint& point) = 0;
///
// Convert |point| to this View's coordinate system from that of the Window.
// This View must belong to a Window when calling this method. Returns true if
// the conversion is successful or false otherwise.
///
/*--cef()--*/
virtual bool ConvertPointFromWindow(CefPoint& point) = 0;
///
// Convert |point| from this View's coordinate system to that of |view|.
// |view| needs to be in the same Window but not necessarily the same view
// hierarchy. Returns true if the conversion is successful or false otherwise.
///
/*--cef()--*/
virtual bool ConvertPointToView(CefRefPtr<CefView> view, CefPoint& point) = 0;
///
// Convert |point| to this View's coordinate system from that |view|. |view|
// needs to be in the same Window but not necessarily the same view hierarchy.
// Returns true if the conversion is successful or false otherwise.
///
/*--cef()--*/
virtual bool ConvertPointFromView(CefRefPtr<CefView> view,
CefPoint& point) = 0;
};
#endif // CEF_INCLUDE_VIEWS_CEF_VIEW_H_