1 // Copyright (c) 2016 Marshall A. Greenblatt. All rights reserved. 2 // 3 // Redistribution and use in source and binary forms, with or without 4 // modification, are permitted provided that the following conditions are 5 // met: 6 // 7 // * Redistributions of source code must retain the above copyright 8 // notice, this list of conditions and the following disclaimer. 9 // * Redistributions in binary form must reproduce the above 10 // copyright notice, this list of conditions and the following disclaimer 11 // in the documentation and/or other materials provided with the 12 // distribution. 13 // * Neither the name of Google Inc. nor the name Chromium Embedded 14 // Framework nor the names of its contributors may be used to endorse 15 // or promote products derived from this software without specific prior 16 // written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // --------------------------------------------------------------------------- 31 // 32 // The contents of this file must follow a specific format in order to 33 // support the CEF translator tool. See the translator.README.txt file in the 34 // tools directory for more information. 35 // 36 37 #ifndef CEF_INCLUDE_VIEWS_CEF_BROWSER_VIEW_H_ 38 #define CEF_INCLUDE_VIEWS_CEF_BROWSER_VIEW_H_ 39 #pragma once 40 41 #include "include/cef_browser.h" 42 #include "include/views/cef_browser_view_delegate.h" 43 #include "include/views/cef_view.h" 44 45 /// 46 // A View hosting a CefBrowser instance. Methods must be called on the browser 47 // process UI thread unless otherwise indicated. 48 /// 49 /*--cef(source=library)--*/ 50 class CefBrowserView : public CefView { 51 public: 52 /// 53 // Create a new BrowserView. The underlying CefBrowser will not be created 54 // until this view is added to the views hierarchy. The optional |extra_info| 55 // parameter provides an opportunity to specify extra information specific 56 // to the created browser that will be passed to 57 // CefRenderProcessHandler::OnBrowserCreated() in the render process. 58 /// 59 /*--cef(optional_param=client,optional_param=url, 60 optional_param=request_context,optional_param=delegate, 61 optional_param=extra_info)--*/ 62 static CefRefPtr<CefBrowserView> CreateBrowserView( 63 CefRefPtr<CefClient> client, 64 const CefString& url, 65 const CefBrowserSettings& settings, 66 CefRefPtr<CefDictionaryValue> extra_info, 67 CefRefPtr<CefRequestContext> request_context, 68 CefRefPtr<CefBrowserViewDelegate> delegate); 69 70 /// 71 // Returns the BrowserView associated with |browser|. 72 /// 73 /*--cef()--*/ 74 static CefRefPtr<CefBrowserView> GetForBrowser(CefRefPtr<CefBrowser> browser); 75 76 /// 77 // Returns the CefBrowser hosted by this BrowserView. Will return NULL if the 78 // browser has not yet been created or has already been destroyed. 79 /// 80 /*--cef()--*/ 81 virtual CefRefPtr<CefBrowser> GetBrowser() = 0; 82 83 /// 84 // Returns the Chrome toolbar associated with this BrowserView. Only supported 85 // when using the Chrome runtime. The CefBrowserViewDelegate:: 86 // GetChromeToolbarType() method must return a value other than 87 // CEF_CTT_NONE and the toolbar will not be available until after this 88 // BrowserView is added to a CefWindow and CefViewDelegate::OnWindowChanged() 89 // has been called. 90 /// 91 /*--cef()--*/ 92 virtual CefRefPtr<CefView> GetChromeToolbar() = 0; 93 94 /// 95 // Sets whether accelerators registered with CefWindow::SetAccelerator are 96 // triggered before or after the event is sent to the CefBrowser. If 97 // |prefer_accelerators| is true then the matching accelerator will be 98 // triggered immediately and the event will not be sent to the CefBrowser. If 99 // |prefer_accelerators| is false then the matching accelerator will only be 100 // triggered if the event is not handled by web content or by 101 // CefKeyboardHandler. The default value is false. 102 /// 103 /*--cef()--*/ 104 virtual void SetPreferAccelerators(bool prefer_accelerators) = 0; 105 }; 106 107 #endif // CEF_INCLUDE_VIEWS_CEF_BROWSER_VIEW_H_ 108