OLD | NEW |
| (Empty) |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef HEADLESS_PUBLIC_WEB_FRAME_H_ | |
6 #define HEADLESS_PUBLIC_WEB_FRAME_H_ | |
7 | |
8 #include "base/callback.h" | |
9 #include "base/macros.h" | |
10 #include "base/values.h" | |
11 #include "headless/public/headless_export.h" | |
12 | |
13 namespace headless { | |
14 | |
15 class WebDocument; | |
16 | |
17 // Class representing a frame in a web page (e.g. main frame or an iframe). | |
18 // Should be accessed from renderer main thread. | |
19 class HEADLESS_EXPORT WebFrame { | |
20 public: | |
21 virtual ~WebFrame() {} | |
22 | |
23 using ScriptExecutionCallback = | |
24 base::Callback<void(const std::vector<scoped_ptr<base::Value>>&)>; | |
25 | |
26 // Schedule given script for execution. | |
27 virtual void ExecuteScript(const std::string& source_code) = 0; | |
28 | |
29 // Execute given script and return its result. | |
30 // Returned value will be converted to json (base::Value). | |
31 // Special effects to bear in mind: | |
32 // - Boolean will be converted to base::FundamentalValue (no surprises here). | |
33 // - Number will be converted to base::FundamentalValue. | |
34 // - Array will be converted to base::ListValue. | |
35 // Note: All non-numerical properties will be omitted | |
36 // (e.g. "array = [1, 2, 3]; array['property'] = 'value'; return array" | |
37 // will return [1, 2, 3]). | |
38 // - Object will be converted to base::DictionaryValue | |
39 // Note: Only string can be key in base::DictionaryValue, so all non-string | |
40 // properties will be omitted | |
41 // (e.g. "obj = Object(); obj['key'] = 'value'; obj[0] = 42;" will return | |
42 // {"key":"value"}). | |
43 virtual void ExecuteScriptAndReturnValue( | |
44 const std::string& source_code, | |
45 const ScriptExecutionCallback& callback) = 0; | |
46 | |
47 virtual std::string ContentAsText(size_t max_chars) const = 0; | |
48 virtual std::string ContentAsMarkup() const = 0; | |
49 virtual proto::Document ContentAsProtobuf() const = 0; | |
50 | |
51 virtual gfx::Size GetScrollOffset() const = 0; | |
52 virtual void SetScrollOffset(const gfx::Size& offset) = 0; | |
53 | |
54 virtual float GetPageScaleFactor() const = 0; | |
55 virtual void SetPageScaleFactor(float page_scale_factor) = 0; | |
56 | |
57 private: | |
58 DISALLOW_COPY_AND_ASSIGN(WebFrame); | |
59 }; | |
60 | |
61 } // namespace headless | |
62 | |
63 #endif // HEADLESS_PUBLIC_WEB_FRAME_H_ | |
OLD | NEW |