+++ /dev/null
-// Copyright (c) 2012 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_BROWSER_H_
-#define CEF_INCLUDE_CEF_BROWSER_H_
-#pragma once
-
-#include "include/cef_base.h"
-#include "include/cef_frame.h"
-#include "include/cef_process_message.h"
-#include "include/cef_request_context.h"
-#include <vector>
-
-class CefBrowserHost;
-class CefClient;
-
-
-///
-// Class used to represent a browser window. When used in the browser process
-// the methods of this class may be called on any thread unless otherwise
-// indicated in the comments. When used in the render process the methods of
-// this class may only be called on the main thread.
-///
-/*--cef(source=library)--*/
-class CefBrowser : public virtual CefBase {
- public:
- ///
- // Returns the browser host object. This method can only be called in the
- // browser process.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefBrowserHost> GetHost() =0;
-
- ///
- // Returns true if the browser can navigate backwards.
- ///
- /*--cef()--*/
- virtual bool CanGoBack() =0;
-
- ///
- // Navigate backwards.
- ///
- /*--cef()--*/
- virtual void GoBack() =0;
-
- ///
- // Returns true if the browser can navigate forwards.
- ///
- /*--cef()--*/
- virtual bool CanGoForward() =0;
-
- ///
- // Navigate forwards.
- ///
- /*--cef()--*/
- virtual void GoForward() =0;
-
- ///
- // Returns true if the browser is currently loading.
- ///
- /*--cef()--*/
- virtual bool IsLoading() =0;
-
- ///
- // Reload the current page.
- ///
- /*--cef()--*/
- virtual void Reload() =0;
-
- ///
- // Reload the current page ignoring any cached data.
- ///
- /*--cef()--*/
- virtual void ReloadIgnoreCache() =0;
-
- ///
- // Stop loading the page.
- ///
- /*--cef()--*/
- virtual void StopLoad() =0;
-
- ///
- // Returns the globally unique identifier for this browser.
- ///
- /*--cef()--*/
- virtual int GetIdentifier() =0;
-
- ///
- // Returns true if this object is pointing to the same handle as |that|
- // object.
- ///
- /*--cef()--*/
- virtual bool IsSame(CefRefPtr<CefBrowser> that) =0;
-
- ///
- // Returns true if the window is a popup window.
- ///
- /*--cef()--*/
- virtual bool IsPopup() =0;
-
- ///
- // Returns true if a document has been loaded in the browser.
- ///
- /*--cef()--*/
- virtual bool HasDocument() =0;
-
- ///
- // Returns the main (top-level) frame for the browser window.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefFrame> GetMainFrame() =0;
-
- ///
- // Returns the focused frame for the browser window.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefFrame> GetFocusedFrame() =0;
-
- ///
- // Returns the frame with the specified identifier, or NULL if not found.
- ///
- /*--cef(capi_name=get_frame_byident)--*/
- virtual CefRefPtr<CefFrame> GetFrame(int64 identifier) =0;
-
- ///
- // Returns the frame with the specified name, or NULL if not found.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefFrame> GetFrame(const CefString& name) =0;
-
- ///
- // Returns the number of frames that currently exist.
- ///
- /*--cef()--*/
- virtual size_t GetFrameCount() =0;
-
- ///
- // Returns the identifiers of all existing frames.
- ///
- /*--cef(count_func=identifiers:GetFrameCount)--*/
- virtual void GetFrameIdentifiers(std::vector<int64>& identifiers) =0;
-
- ///
- // Returns the names of all existing frames.
- ///
- /*--cef()--*/
- virtual void GetFrameNames(std::vector<CefString>& names) =0;
-
- //
- // Send a message to the specified |target_process|. Returns true if the
- // message was sent successfully.
- ///
- /*--cef()--*/
- virtual bool SendProcessMessage(CefProcessId target_process,
- CefRefPtr<CefProcessMessage> message) =0;
-};
-
-
-///
-// Callback interface for CefBrowserHost::RunFileDialog. The methods of this
-// class will be called on the browser process UI thread.
-///
-/*--cef(source=client)--*/
-class CefRunFileDialogCallback : public virtual CefBase {
- public:
- ///
- // Called asynchronously after the file dialog is dismissed. If the selection
- // was successful |file_paths| will be a single value or a list of values
- // depending on the dialog mode. If the selection was cancelled |file_paths|
- // will be empty.
- ///
- /*--cef(capi_name=cont)--*/
- virtual void OnFileDialogDismissed(
- CefRefPtr<CefBrowserHost> browser_host,
- const std::vector<CefString>& file_paths) =0;
-};
-
-
-///
-// Class used to represent the browser process aspects of a browser window. The
-// methods of this class can only be called in the browser process. They may be
-// called on any thread in that process unless otherwise indicated in the
-// comments.
-///
-/*--cef(source=library)--*/
-class CefBrowserHost : public virtual CefBase {
- public:
- typedef cef_file_dialog_mode_t FileDialogMode;
- typedef cef_mouse_button_type_t MouseButtonType;
- typedef cef_paint_element_type_t PaintElementType;
-
- ///
- // Create a new browser window using the window parameters specified by
- // |windowInfo|. All values will be copied internally and the actual window
- // will be created on the UI thread. If |request_context| is empty the
- // global request context will be used. This method can be called on any
- // browser process thread and will not block.
- ///
- /*--cef(optional_param=client,optional_param=url,
- optional_param=request_context)--*/
- static bool CreateBrowser(const CefWindowInfo& windowInfo,
- CefRefPtr<CefClient> client,
- const CefString& url,
- const CefBrowserSettings& settings,
- CefRefPtr<CefRequestContext> request_context);
-
- ///
- // Create a new browser window using the window parameters specified by
- // |windowInfo|. If |request_context| is empty the global request context
- // will be used. This method can only be called on the browser process UI
- // thread.
- ///
- /*--cef(optional_param=client,optional_param=url,
- optional_param=request_context)--*/
- static CefRefPtr<CefBrowser> CreateBrowserSync(
- const CefWindowInfo& windowInfo,
- CefRefPtr<CefClient> client,
- const CefString& url,
- const CefBrowserSettings& settings,
- CefRefPtr<CefRequestContext> request_context);
-
- ///
- // Returns the hosted browser object.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefBrowser> GetBrowser() =0;
-
- ///
- // Call this method before destroying a contained browser window. This method
- // performs any internal cleanup that may be needed before the browser window
- // is destroyed. See CefLifeSpanHandler::DoClose() documentation for
- // additional usage information.
- ///
- /*--cef()--*/
- virtual void ParentWindowWillClose() =0;
-
- ///
- // Request that the browser close. The JavaScript 'onbeforeunload' event will
- // be fired. If |force_close| is false the event handler, if any, will be
- // allowed to prompt the user and the user can optionally cancel the close.
- // If |force_close| is true the prompt will not be displayed and the close
- // will proceed. Results in a call to CefLifeSpanHandler::DoClose() if the
- // event handler allows the close or if |force_close| is true. See
- // CefLifeSpanHandler::DoClose() documentation for additional usage
- // information.
- ///
- /*--cef()--*/
- virtual void CloseBrowser(bool force_close) =0;
-
- ///
- // Set whether the browser is focused.
- ///
- /*--cef()--*/
- virtual void SetFocus(bool focus) =0;
-
- ///
- // Set whether the window containing the browser is visible
- // (minimized/unminimized, app hidden/unhidden, etc). Only used on Mac OS X.
- ///
- /*--cef()--*/
- virtual void SetWindowVisibility(bool visible) =0;
-
- ///
- // Retrieve the window handle for this browser.
- ///
- /*--cef()--*/
- virtual CefWindowHandle GetWindowHandle() =0;
-
- ///
- // Retrieve the window handle of the browser that opened this browser. Will
- // return NULL for non-popup windows. This method can be used in combination
- // with custom handling of modal windows.
- ///
- /*--cef()--*/
- virtual CefWindowHandle GetOpenerWindowHandle() =0;
-
- ///
- // Returns the client for this browser.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefClient> GetClient() =0;
-
- ///
- // Returns the request context for this browser.
- ///
- /*--cef()--*/
- virtual CefRefPtr<CefRequestContext> GetRequestContext() =0;
-
- ///
- // Get the current zoom level. The default zoom level is 0.0. This method can
- // only be called on the UI thread.
- ///
- /*--cef()--*/
- virtual double GetZoomLevel() =0;
-
- ///
- // Change the zoom level to the specified value. Specify 0.0 to reset the
- // zoom level. If called on the UI thread the change will be applied
- // immediately. Otherwise, the change will be applied asynchronously on the
- // UI thread.
- ///
- /*--cef()--*/
- virtual void SetZoomLevel(double zoomLevel) =0;
-
- ///
- // Call to run a file chooser dialog. Only a single file chooser dialog may be
- // pending at any given time. |mode| represents the type of dialog to display.
- // |title| to the title to be used for the dialog and may be empty to show the
- // default title ("Open" or "Save" depending on the mode). |default_file_name|
- // is the default file name to select in the dialog. |accept_types| is a list
- // of valid lower-cased MIME types or file extensions specified in an input
- // element and is used to restrict selectable files to such types. |callback|
- // will be executed after the dialog is dismissed or immediately if another
- // dialog is already pending. The dialog will be initiated asynchronously on
- // the UI thread.
- ///
- /*--cef(optional_param=title,optional_param=default_file_name,
- optional_param=accept_types)--*/
- virtual void RunFileDialog(FileDialogMode mode,
- const CefString& title,
- const CefString& default_file_name,
- const std::vector<CefString>& accept_types,
- CefRefPtr<CefRunFileDialogCallback> callback) =0;
-
- ///
- // Download the file at |url| using CefDownloadHandler.
- ///
- /*--cef()--*/
- virtual void StartDownload(const CefString& url) =0;
-
- ///
- // Print the current browser contents.
- ///
- /*--cef()--*/
- virtual void Print() =0;
-
- ///
- // Search for |searchText|. |identifier| can be used to have multiple searches
- // running simultaniously. |forward| indicates whether to search forward or
- // backward within the page. |matchCase| indicates whether the search should
- // be case-sensitive. |findNext| indicates whether this is the first request
- // or a follow-up.
- ///
- /*--cef()--*/
- virtual void Find(int identifier, const CefString& searchText,
- bool forward, bool matchCase, bool findNext) =0;
-
- ///
- // Cancel all searches that are currently going on.
- ///
- /*--cef()--*/
- virtual void StopFinding(bool clearSelection) =0;
-
- ///
- // Open developer tools in its own window.
- ///
- /*--cef()--*/
- virtual void ShowDevTools(const CefWindowInfo& windowInfo,
- CefRefPtr<CefClient> client,
- const CefBrowserSettings& settings) =0;
-
- ///
- // Explicitly close the developer tools window if one exists for this browser
- // instance.
- ///
- /*--cef()--*/
- virtual void CloseDevTools() =0;
-
- ///
- // Set whether mouse cursor change is disabled.
- ///
- /*--cef()--*/
- virtual void SetMouseCursorChangeDisabled(bool disabled) =0;
-
- ///
- // Returns true if mouse cursor change is disabled.
- ///
- /*--cef()--*/
- virtual bool IsMouseCursorChangeDisabled() =0;
-
- ///
- // Returns true if window rendering is disabled.
- ///
- /*--cef()--*/
- virtual bool IsWindowRenderingDisabled() =0;
-
- ///
- // Notify the browser that the widget has been resized. The browser will first
- // call CefRenderHandler::GetViewRect to get the new size and then call
- // CefRenderHandler::OnPaint asynchronously with the updated regions. This
- // method is only used when window rendering is disabled.
- ///
- /*--cef()--*/
- virtual void WasResized() =0;
-
- ///
- // Notify the browser that it has been hidden or shown. Layouting and
- // CefRenderHandler::OnPaint notification will stop when the browser is
- // hidden. This method is only used when window rendering is disabled.
- ///
- /*--cef()--*/
- virtual void WasHidden(bool hidden) =0;
-
- ///
- // Send a notification to the browser that the screen info has changed. The
- // browser will then call CefRenderHandler::GetScreenInfo to update the
- // screen information with the new values. This simulates moving the webview
- // window from one display to another, or changing the properties of the
- // current display. This method is only used when window rendering is
- // disabled.
- ///
- /*--cef()--*/
- virtual void NotifyScreenInfoChanged() =0;
-
- ///
- // Invalidate the |dirtyRect| region of the view. The browser will call
- // CefRenderHandler::OnPaint asynchronously with the updated regions. This
- // method is only used when window rendering is disabled.
- ///
- /*--cef()--*/
- virtual void Invalidate(const CefRect& dirtyRect, PaintElementType type) =0;
-
- ///
- // Send a key event to the browser.
- ///
- /*--cef()--*/
- virtual void SendKeyEvent(const CefKeyEvent& event) =0;
-
- ///
- // Send a mouse click event to the browser. The |x| and |y| coordinates are
- // relative to the upper-left corner of the view.
- ///
- /*--cef()--*/
- virtual void SendMouseClickEvent(const CefMouseEvent& event,
- MouseButtonType type,
- bool mouseUp, int clickCount) =0;
-
- ///
- // Send a mouse move event to the browser. The |x| and |y| coordinates are
- // relative to the upper-left corner of the view.
- ///
- /*--cef()--*/
- virtual void SendMouseMoveEvent(const CefMouseEvent& event,
- bool mouseLeave) =0;
-
- ///
- // Send a mouse wheel event to the browser. The |x| and |y| coordinates are
- // relative to the upper-left corner of the view. The |deltaX| and |deltaY|
- // values represent the movement delta in the X and Y directions respectively.
- // In order to scroll inside select popups with window rendering disabled
- // CefRenderHandler::GetScreenPoint should be implemented properly.
- ///
- /*--cef()--*/
- virtual void SendMouseWheelEvent(const CefMouseEvent& event,
- int deltaX, int deltaY) =0;
-
- ///
- // Send a focus event to the browser.
- ///
- /*--cef()--*/
- virtual void SendFocusEvent(bool setFocus) =0;
-
- ///
- // Send a capture lost event to the browser.
- ///
- /*--cef()--*/
- virtual void SendCaptureLostEvent() =0;
-
- ///
- // Get the NSTextInputContext implementation for enabling IME on Mac when
- // window rendering is disabled.
- ///
- /*--cef(default_retval=NULL)--*/
- virtual CefTextInputContext GetNSTextInputContext() =0;
-
- ///
- // Handles a keyDown event prior to passing it through the NSTextInputClient
- // machinery.
- ///
- /*--cef()--*/
- virtual void HandleKeyEventBeforeTextInputClient(CefEventHandle keyEvent) =0;
-
- ///
- // Performs any additional actions after NSTextInputClient handles the event.
- ///
- /*--cef()--*/
- virtual void HandleKeyEventAfterTextInputClient(CefEventHandle keyEvent) =0;
-};
-
-#endif // CEF_INCLUDE_CEF_BROWSER_H_
projects / casparcg / blobdiff