forked from cztomczak/cefpython
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcef_frame.h
More file actions
220 lines (197 loc) · 6.41 KB
/
cef_frame.h
File metadata and controls
220 lines (197 loc) · 6.41 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
// Copyright (c) 2011 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_CEF_FRAME_H_
#define CEF_INCLUDE_CEF_FRAME_H_
#pragma once
#include "include/cef_base.h"
#include "include/cef_dom.h"
#include "include/cef_request.h"
#include "include/cef_stream.h"
class CefBrowser;
class CefV8Context;
///
// Class used to represent a frame in the browser window. The methods of this
// class may be called on any thread unless otherwise indicated in the comments.
///
/*--cef(source=library)--*/
class CefFrame : public virtual CefBase {
public:
///
// Execute undo in this frame.
///
/*--cef()--*/
virtual void Undo() =0;
///
// Execute redo in this frame.
///
/*--cef()--*/
virtual void Redo() =0;
///
// Execute cut in this frame.
///
/*--cef()--*/
virtual void Cut() =0;
///
// Execute copy in this frame.
///
/*--cef()--*/
virtual void Copy() =0;
///
// Execute paste in this frame.
///
/*--cef()--*/
virtual void Paste() =0;
///
// Execute delete in this frame.
///
/*--cef(capi_name=del)--*/
virtual void Delete() =0;
///
// Execute select all in this frame.
///
/*--cef()--*/
virtual void SelectAll() =0;
///
// Execute printing in the this frame. The user will be prompted with the
// print dialog appropriate to the operating system.
///
/*--cef()--*/
virtual void Print() =0;
///
// Save this frame's HTML source to a temporary file and open it in the
// default text viewing application.
///
/*--cef()--*/
virtual void ViewSource() =0;
///
// Returns this frame's HTML source as a string. This method should only be
// called on the UI thread.
///
/*--cef()--*/
virtual CefString GetSource() =0;
///
// Returns this frame's display text as a string. This method should only be
// called on the UI thread.
///
/*--cef()--*/
virtual CefString GetText() =0;
///
// Load the request represented by the |request| object.
///
/*--cef()--*/
virtual void LoadRequest(CefRefPtr<CefRequest> request) =0;
///
// Load the specified |url|.
///
/*--cef()--*/
virtual void LoadURL(const CefString& url) =0;
///
// Load the contents of |string_val| with the optional dummy target |url|.
///
/*--cef()--*/
virtual void LoadString(const CefString& string_val,
const CefString& url) =0;
///
// Load the contents of |stream| with the optional dummy target |url|.
///
/*--cef()--*/
virtual void LoadStream(CefRefPtr<CefStreamReader> stream,
const CefString& url) =0;
///
// Execute a string of JavaScript code in this frame. The |script_url|
// parameter is the URL where the script in question can be found, if any.
// The renderer may request this URL to show the developer the source of the
// error. The |start_line| parameter is the base line number to use for error
// reporting.
///
/*--cef(optional_param=scriptUrl)--*/
virtual void ExecuteJavaScript(const CefString& jsCode,
const CefString& scriptUrl,
int startLine) =0;
///
// Returns true if this is the main (top-level) frame.
///
/*--cef()--*/
virtual bool IsMain() =0;
///
// Returns true if this is the focused frame. This method should only be
// called on the UI thread.
///
/*--cef()--*/
virtual bool IsFocused() =0;
///
// Returns the name for this frame. If the frame has an assigned name (for
// example, set via the iframe "name" attribute) then that value will be
// returned. Otherwise a unique name will be constructed based on the frame
// parent hierarchy. The main (top-level) frame will always have an empty name
// value.
///
/*--cef()--*/
virtual CefString GetName() =0;
///
// Returns the globally unique identifier for this frame.
///
/*--cef()--*/
virtual int64 GetIdentifier() =0;
///
// Returns the parent of this frame or NULL if this is the main (top-level)
// frame. This method should only be called on the UI thread.
///
/*--cef()--*/
virtual CefRefPtr<CefFrame> GetParent() =0;
///
// Returns the URL currently loaded in this frame.
///
/*--cef()--*/
virtual CefString GetURL() =0;
///
// Returns the browser that this frame belongs to.
///
/*--cef()--*/
virtual CefRefPtr<CefBrowser> GetBrowser() =0;
///
// Visit the DOM document.
///
/*--cef()--*/
virtual void VisitDOM(CefRefPtr<CefDOMVisitor> visitor) =0;
///
// Get the V8 context associated with the frame. This method should only be
// called on the UI thread.
///
/*--cef()--*/
virtual CefRefPtr<CefV8Context> GetV8Context() =0;
};
#endif // CEF_INCLUDE_CEF_FRAME_H_