2262 lines
83 KiB
C++
2262 lines
83 KiB
C++
// Copyright (c) 2008-2009 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_H
|
|
#define _CEF_H
|
|
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
#include "cef_ptr.h"
|
|
#include "cef_types_wrappers.h"
|
|
|
|
class CefBrowser;
|
|
class CefCookieVisitor;
|
|
class CefDOMDocument;
|
|
class CefDOMEvent;
|
|
class CefDOMEventListener;
|
|
class CefDOMNode;
|
|
class CefDOMVisitor;
|
|
class CefDownloadHandler;
|
|
class CefFrame;
|
|
class CefHandler;
|
|
class CefPostData;
|
|
class CefPostDataElement;
|
|
class CefRequest;
|
|
class CefResponse;
|
|
class CefSchemeHandler;
|
|
class CefSchemeHandlerFactory;
|
|
class CefStreamReader;
|
|
class CefStreamWriter;
|
|
class CefTask;
|
|
class CefV8Context;
|
|
class CefV8Handler;
|
|
class CefV8Value;
|
|
class CefWebURLRequest;
|
|
class CefWebURLRequestClient;
|
|
|
|
|
|
// This function should be called on the main application thread to initialize
|
|
// CEF when the application is started. A return value of true indicates that
|
|
// it succeeded and false indicates that it failed.
|
|
/*--cef()--*/
|
|
bool CefInitialize(const CefSettings& settings,
|
|
const CefBrowserSettings& browser_defaults);
|
|
|
|
// This function should be called on the main application thread to shut down
|
|
// CEF before the application exits.
|
|
/*--cef()--*/
|
|
void CefShutdown();
|
|
|
|
// Perform a single iteration of CEF message loop processing. This function is
|
|
// used to integrate the CEF message loop into an existing application message
|
|
// loop. Care must be taken to balance performance against excessive CPU usage.
|
|
// This function should only be called on the main application thread and only
|
|
// if CefInitialize() is called with a CefSettings.multi_threaded_message_loop
|
|
// value of false. This function will not block.
|
|
/*--cef()--*/
|
|
void CefDoMessageLoopWork();
|
|
|
|
// Run the CEF message loop. Use this function instead of an application-
|
|
// provided message loop to get the best balance between performance and CPU
|
|
// usage. This function should only be called on the main application thread and
|
|
// only if CefInitialize() is called with a
|
|
// CefSettings.multi_threaded_message_loop value of false. This function will
|
|
// block until a quit message is received by the system.
|
|
/*--cef()--*/
|
|
void CefRunMessageLoop();
|
|
|
|
// Register a new V8 extension with the specified JavaScript extension code and
|
|
// handler. Functions implemented by the handler are prototyped using the
|
|
// keyword 'native'. The calling of a native function is restricted to the scope
|
|
// in which the prototype of the native function is defined. This function may
|
|
// be called on any thread.
|
|
//
|
|
// Example JavaScript extension code:
|
|
//
|
|
// // create the 'example' global object if it doesn't already exist.
|
|
// if (!example)
|
|
// example = {};
|
|
// // create the 'example.test' global object if it doesn't already exist.
|
|
// if (!example.test)
|
|
// example.test = {};
|
|
// (function() {
|
|
// // Define the function 'example.test.myfunction'.
|
|
// example.test.myfunction = function() {
|
|
// // Call CefV8Handler::Execute() with the function name 'MyFunction'
|
|
// // and no arguments.
|
|
// native function MyFunction();
|
|
// return MyFunction();
|
|
// };
|
|
// // Define the getter function for parameter 'example.test.myparam'.
|
|
// example.test.__defineGetter__('myparam', function() {
|
|
// // Call CefV8Handler::Execute() with the function name 'GetMyParam'
|
|
// // and no arguments.
|
|
// native function GetMyParam();
|
|
// return GetMyParam();
|
|
// });
|
|
// // Define the setter function for parameter 'example.test.myparam'.
|
|
// example.test.__defineSetter__('myparam', function(b) {
|
|
// // Call CefV8Handler::Execute() with the function name 'SetMyParam'
|
|
// // and a single argument.
|
|
// native function SetMyParam();
|
|
// if(b) SetMyParam(b);
|
|
// });
|
|
//
|
|
// // Extension definitions can also contain normal JavaScript variables
|
|
// // and functions.
|
|
// var myint = 0;
|
|
// example.test.increment = function() {
|
|
// myint += 1;
|
|
// return myint;
|
|
// };
|
|
// })();
|
|
//
|
|
// Example usage in the page:
|
|
//
|
|
// // Call the function.
|
|
// example.test.myfunction();
|
|
// // Set the parameter.
|
|
// example.test.myparam = value;
|
|
// // Get the parameter.
|
|
// value = example.test.myparam;
|
|
// // Call another function.
|
|
// example.test.increment();
|
|
//
|
|
/*--cef()--*/
|
|
bool CefRegisterExtension(const CefString& extension_name,
|
|
const CefString& javascript_code,
|
|
CefRefPtr<CefV8Handler> handler);
|
|
|
|
// CEF supports two types of schemes, standard and non-standard.
|
|
//
|
|
// Standard schemes are subject to URL canonicalization and parsing rules as
|
|
// defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available
|
|
// at http://www.ietf.org/rfc/rfc1738.txt
|
|
//
|
|
// In particular, the syntax for standard scheme URLs must be of the form:
|
|
//
|
|
// <scheme>://<username>:<password>@<host>:<port>/<url-path>
|
|
//
|
|
// Standard scheme URLs must have a host component that is a fully qualified
|
|
// domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of RFC
|
|
// 1123. These URLs will be canonicalized to "scheme://host/path" in the
|
|
// simplest case and "scheme://username:password@host:port/path" in the most
|
|
// explicit case. For example, "scheme:host/path" and "scheme:///host/path" will
|
|
// both be canonicalized to "scheme://host/path".
|
|
//
|
|
// For non-standard scheme URLs only the "scheme:" component is parsed and
|
|
// canonicalized. The remainder of the URL will be passed to the handler as-is.
|
|
// For example, "scheme:///some%20text" will remain the same. Non-standard
|
|
// scheme URLs cannot be used as a target for form submission.
|
|
//
|
|
// Register a custom scheme handler factory for the specified |scheme_name| and
|
|
// optional |host_name|. Specifying an empty |host_name| value for standard
|
|
// schemes will match all host names. The |host_name| value will be ignored for
|
|
// non-standard schemes. Set |is_standard| to true to register as a standard
|
|
// scheme or false to register a non-standard scheme. This function may be
|
|
// called on any thread.
|
|
/*--cef()--*/
|
|
bool CefRegisterScheme(const CefString& scheme_name,
|
|
const CefString& host_name,
|
|
bool is_standard,
|
|
CefRefPtr<CefSchemeHandlerFactory> factory);
|
|
|
|
typedef cef_thread_id_t CefThreadId;
|
|
|
|
// CEF maintains multiple internal threads that are used for handling different
|
|
// types of tasks. The UI thread creates the browser window and is used for all
|
|
// interaction with the WebKit rendering engine and V8 JavaScript engine (The
|
|
// UI thread will be the same as the main application thread if CefInitialize()
|
|
// is called with a CefSettings.multi_threaded_message_loop value of false.) The
|
|
// IO thread is used for handling schema and network requests. The FILE thread
|
|
// is used for the application cache and other miscellaneous activities. This
|
|
// function will return true if called on the specified thread.
|
|
/*--cef()--*/
|
|
bool CefCurrentlyOn(CefThreadId threadId);
|
|
|
|
// Post a task for execution on the specified thread. This function may be
|
|
// called on any thread.
|
|
/*--cef()--*/
|
|
bool CefPostTask(CefThreadId threadId, CefRefPtr<CefTask> task);
|
|
|
|
// Post a task for delayed execution on the specified thread. This function may
|
|
// be called on any thread.
|
|
/*--cef()--*/
|
|
bool CefPostDelayedTask(CefThreadId threadId, CefRefPtr<CefTask> task,
|
|
long delay_ms);
|
|
|
|
// Parse the specified |url| into its component parts.
|
|
// Returns false if the URL is empty or invalid.
|
|
/*--cef()--*/
|
|
bool CefParseURL(const CefString& url,
|
|
CefURLParts& parts);
|
|
|
|
// Creates a URL from the specified |parts|, which must contain a non-empty
|
|
// spec or a non-empty host and path (at a minimum), but not both.
|
|
// Returns false if |parts| isn't initialized as described.
|
|
/*--cef()--*/
|
|
bool CefCreateURL(const CefURLParts& parts,
|
|
CefString& url);
|
|
|
|
// Visit all cookies. The returned cookies are ordered by longest path, then by
|
|
// earliest creation date. Returns false if cookies cannot be accessed.
|
|
/*--cef()--*/
|
|
bool CefVisitAllCookies(CefRefPtr<CefCookieVisitor> visitor);
|
|
|
|
// Visit a subset of cookies. The results are filtered by the given url scheme,
|
|
// host, domain and path. If |includeHttpOnly| is true HTTP-only cookies will
|
|
// also be included in the results. The returned cookies are ordered by longest
|
|
// path, then by earliest creation date. Returns false if cookies cannot be
|
|
// accessed.
|
|
/*--cef()--*/
|
|
bool CefVisitUrlCookies(const CefString& url, bool includeHttpOnly,
|
|
CefRefPtr<CefCookieVisitor> visitor);
|
|
|
|
// Sets a cookie given a valid URL and explicit user-provided cookie attributes.
|
|
// This function expects each attribute to be well-formed. It will check for
|
|
// disallowed characters (e.g. the ';' character is disallowed within the cookie
|
|
// value attribute) and will return false without setting the cookie if such
|
|
// characters are found. This method must be called on the IO thread.
|
|
/*--cef()--*/
|
|
bool CefSetCookie(const CefString& url, const CefCookie& cookie);
|
|
|
|
// Delete all cookies that match the specified parameters. If both |url| and
|
|
// |cookie_name| are specified all host and domain cookies matching both values
|
|
// will be deleted. If only |url| is specified all host cookies (but not domain
|
|
// cookies) irrespective of path will be deleted. If |url| is empty all cookies
|
|
// for all hosts and domains will be deleted. Returns false if a non-empty
|
|
// invalid URL is specified or if cookies cannot be accessed. This method must
|
|
// be called on the IO thread.
|
|
/*--cef()--*/
|
|
bool CefDeleteCookies(const CefString& url, const CefString& cookie_name);
|
|
|
|
|
|
// Interface defining the the reference count implementation methods. All
|
|
// framework classes must implement the CefBase class.
|
|
class CefBase
|
|
{
|
|
public:
|
|
// The AddRef method increments the reference count for the object. It should
|
|
// be called for every new copy of a pointer to a given object. The resulting
|
|
// reference count value is returned and should be used for diagnostic/testing
|
|
// purposes only.
|
|
virtual int AddRef() =0;
|
|
|
|
// The Release method decrements the reference count for the object. If the
|
|
// reference count on the object falls to 0, then the object should free
|
|
// itself from memory. The resulting reference count value is returned and
|
|
// should be used for diagnostic/testing purposes only.
|
|
virtual int Release() =0;
|
|
|
|
// Return the current number of references.
|
|
virtual int GetRefCt() =0;
|
|
};
|
|
|
|
|
|
// Bring in platform-specific definitions.
|
|
#if defined(_WIN32)
|
|
#include "cef_win.h"
|
|
#elif defined(__APPLE__)
|
|
#include "cef_mac.h"
|
|
#elif defined(__linux__)
|
|
#include "cef_linux.h"
|
|
#endif
|
|
|
|
|
|
// Template that provides atomic implementations of AddRef() and Release()
|
|
// along with Lock() and Unlock() methods to protect critical sections of
|
|
// code from simultaneous access by multiple threads.
|
|
//
|
|
// The below example demonstrates how to use the CefThreadSafeBase template.
|
|
//
|
|
// class MyHandler : public CefThreadSafeBase<CefHandler>
|
|
// {
|
|
// CefString m_title;
|
|
//
|
|
// virtual RetVal HandleTitleChange(const CefString& title)
|
|
// {
|
|
// Lock(); // Begin protecting code
|
|
// m_title = title;
|
|
// Unlock(); // Done protecting code
|
|
// return RV_HANDLED;
|
|
// }
|
|
// ...
|
|
// }
|
|
//
|
|
template <class ClassName>
|
|
class CefThreadSafeBase : public ClassName
|
|
{
|
|
public:
|
|
CefThreadSafeBase()
|
|
{
|
|
m_dwRef = 0L;
|
|
}
|
|
virtual ~CefThreadSafeBase()
|
|
{
|
|
}
|
|
|
|
// Atomic reference increment.
|
|
virtual int AddRef()
|
|
{
|
|
return CefAtomicIncrement(&m_dwRef);
|
|
}
|
|
|
|
// Atomic reference decrement. Delete this object when no references remain.
|
|
virtual int Release()
|
|
{
|
|
int retval = CefAtomicDecrement(&m_dwRef);
|
|
if(retval == 0)
|
|
delete this;
|
|
return retval;
|
|
}
|
|
|
|
// Return the current number of references.
|
|
virtual int GetRefCt() { return m_dwRef; }
|
|
|
|
// Use the Lock() and Unlock() methods to protect a section of code from
|
|
// simultaneous access by multiple threads.
|
|
void Lock() { m_critsec.Lock(); }
|
|
void Unlock() { m_critsec.Unlock(); }
|
|
|
|
// A helper class that acquires the lock for the given CefThreadSafeBase while
|
|
// the CefAutoLock is in scope.
|
|
class AutoLock
|
|
{
|
|
public:
|
|
AutoLock(CefThreadSafeBase* base) : base_(base)
|
|
{
|
|
base_->Lock();
|
|
}
|
|
~AutoLock()
|
|
{
|
|
base_->Unlock();
|
|
}
|
|
|
|
private:
|
|
CefThreadSafeBase* base_;
|
|
};
|
|
|
|
protected:
|
|
long m_dwRef;
|
|
CefCriticalSection m_critsec;
|
|
};
|
|
|
|
|
|
// Implement this interface for task execution. The methods of this class may
|
|
// be called on any thread.
|
|
/*--cef(source=client)--*/
|
|
class CefTask : public CefBase
|
|
{
|
|
public:
|
|
// Method that will be executed. |threadId| is the thread executing the call.
|
|
/*--cef()--*/
|
|
virtual void Execute(CefThreadId threadId) =0;
|
|
};
|
|
|
|
|
|
// Interface to implement for visiting cookie values. The methods of this class
|
|
// will always be called on the IO thread.
|
|
/*--cef(source=client)--*/
|
|
class CefCookieVisitor : public CefBase
|
|
{
|
|
public:
|
|
// Method that will be called once for each cookie. |count| is the 0-based
|
|
// index for the current cookie. |total| is the total number of cookies.
|
|
// Set |deleteCookie| to true to delete the cookie currently being visited.
|
|
// Return false to stop visiting cookies. This method may never be called if
|
|
// no cookies are found.
|
|
/*--cef()--*/
|
|
virtual bool Visit(const CefCookie& cookie, int count, int total,
|
|
bool& deleteCookie) =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a browser window. The methods of this class may be
|
|
// called on any thread unless otherwise indicated in the comments.
|
|
/*--cef(source=library)--*/
|
|
class CefBrowser : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_key_type_t KeyType;
|
|
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. The |popup| parameter should be true if
|
|
// the new window is a popup window. This method call will not block.
|
|
/*--cef()--*/
|
|
static bool CreateBrowser(CefWindowInfo& windowInfo, bool popup,
|
|
CefRefPtr<CefHandler> handler,
|
|
const CefString& url);
|
|
|
|
// Create a new browser window using the window parameters specified by
|
|
// |windowInfo|. The |popup| parameter should be true if the new window is a
|
|
// popup window. This method should only be called on the UI thread.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefBrowser> CreateBrowserSync(CefWindowInfo& windowInfo,
|
|
bool popup,
|
|
CefRefPtr<CefHandler> handler,
|
|
const CefString& url);
|
|
|
|
// Closes this browser window.
|
|
/*--cef()--*/
|
|
virtual void CloseBrowser() =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 backwards.
|
|
/*--cef()--*/
|
|
virtual void GoForward() =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;
|
|
|
|
// Set focus for the browser window. If |enable| is true focus will be set to
|
|
// the window. Otherwise, focus will be removed.
|
|
/*--cef()--*/
|
|
virtual void SetFocus(bool enable) =0;
|
|
|
|
// Retrieve the window handle for this browser.
|
|
/*--cef()--*/
|
|
virtual CefWindowHandle GetWindowHandle() =0;
|
|
|
|
// Returns true if the window is a popup window.
|
|
/*--cef()--*/
|
|
virtual bool IsPopup() =0;
|
|
|
|
// Returns the handler for this browser.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefHandler> GetHandler() =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. This method should only
|
|
// be called on the UI thread.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefFrame> GetFocusedFrame() =0;
|
|
|
|
// Returns the frame with the specified name, or NULL if not found. This
|
|
// method should only be called on the UI thread.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefFrame> GetFrame(const CefString& name) =0;
|
|
|
|
// Returns the names of all existing frames. This method should only be called
|
|
// on the UI thread.
|
|
/*--cef()--*/
|
|
virtual void GetFrameNames(std::vector<CefString>& names) =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;
|
|
|
|
// Get the zoom level.
|
|
/*--cef()--*/
|
|
virtual double GetZoomLevel() =0;
|
|
|
|
// Change the zoom level to the specified value.
|
|
/*--cef()--*/
|
|
virtual void SetZoomLevel(double zoomLevel) =0;
|
|
|
|
// Open developer tools in its own window.
|
|
/*--cef()--*/
|
|
virtual void ShowDevTools() =0;
|
|
|
|
// Explicitly close the developer tools window if one exists for this browser
|
|
// instance.
|
|
/*--cef()--*/
|
|
virtual void CloseDevTools() =0;
|
|
|
|
// Returns true if window rendering is disabled.
|
|
/*--cef()--*/
|
|
virtual bool IsWindowRenderingDisabled() =0;
|
|
|
|
// Get the size of the specified element. This method should only be called on
|
|
// the UI thread.
|
|
/*--cef()--*/
|
|
virtual bool GetSize(PaintElementType type, int& width, int& height) =0;
|
|
|
|
// Set the size of the specified element. This method is only used when window
|
|
// rendering is disabled.
|
|
/*--cef()--*/
|
|
virtual void SetSize(PaintElementType type, int width, int height) =0;
|
|
|
|
// Returns true if a popup is currently visible. This method should only be
|
|
// called on the UI thread.
|
|
/*--cef()--*/
|
|
virtual bool IsPopupVisible() =0;
|
|
|
|
// Hide the currently visible popup, if any.
|
|
/*--cef()--*/
|
|
virtual void HidePopup() =0;
|
|
|
|
// Invalidate the |dirtyRect| region of the view. This method is only used
|
|
// when window rendering is disabled and will result in a call to
|
|
// HandlePaint().
|
|
/*--cef()--*/
|
|
virtual void Invalidate(const CefRect& dirtyRect) =0;
|
|
|
|
// Get the raw image data contained in the specified element without
|
|
// performing validation. The specified |width| and |height| dimensions must
|
|
// match the current element size. On Windows |buffer| must be width*height*4
|
|
// bytes in size and represents a BGRA image with an upper-left origin. This
|
|
// method should only be called on the UI thread.
|
|
/*--cef()--*/
|
|
virtual bool GetImage(PaintElementType type, int width, int height,
|
|
void* buffer) =0;
|
|
|
|
// Send a key event to the browser.
|
|
/*--cef()--*/
|
|
virtual void SendKeyEvent(KeyType type, int key, int modifiers, bool sysChar,
|
|
bool imeChar) =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(int x, int y, 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(int x, int y, 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.
|
|
/*--cef()--*/
|
|
virtual void SendMouseWheelEvent(int x, int y, int delta) =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;
|
|
};
|
|
|
|
|
|
// 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 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| with the optional dummy target |url|.
|
|
/*--cef()--*/
|
|
virtual void LoadString(const CefString& string,
|
|
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()--*/
|
|
virtual void ExecuteJavaScript(const CefString& jsCode,
|
|
const CefString& scriptUrl,
|
|
int startLine) =0;
|
|
|
|
// Returns true if this is the main 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 this frame's name.
|
|
/*--cef()--*/
|
|
virtual CefString GetName() =0;
|
|
|
|
// Returns the URL currently loaded in this frame. This method should only be
|
|
// called on the UI thread.
|
|
/*--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;
|
|
};
|
|
|
|
|
|
// Interface that should be implemented to handle events generated by the
|
|
// browser window. The methods of this class will be called on the thread
|
|
// indicated in the method comments.
|
|
/*--cef(source=client)--*/
|
|
class CefHandler : public CefBase
|
|
{
|
|
public:
|
|
// Define handler return value types. Returning RV_HANDLED indicates
|
|
// that the implementation completely handled the method and that no further
|
|
// processing is required. Returning RV_CONTINUE indicates that the
|
|
// implementation did not handle the method and that the default handler
|
|
// should be called.
|
|
typedef cef_retval_t RetVal;
|
|
|
|
// Called on the UI thread before a new window is created. The |parentBrowser|
|
|
// parameter will point to the parent browser window, if any. The |popup|
|
|
// parameter will be true if the new window is a popup window, in which case
|
|
// |popupFeatures| will contain information about the style of popup window
|
|
// requested. If you create the window yourself you should populate the window
|
|
// handle member of |createInfo| and return RV_HANDLED. Otherwise, return
|
|
// RV_CONTINUE and the framework will create the window. By default, a newly
|
|
// created window will recieve the same handler as the parent window. To
|
|
// change the handler for the new window modify the object that |handler|
|
|
// points to.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleBeforeCreated(CefRefPtr<CefBrowser> parentBrowser,
|
|
CefWindowInfo& windowInfo, bool popup,
|
|
const CefPopupFeatures& popupFeatures,
|
|
CefRefPtr<CefHandler>& handler,
|
|
const CefString& url,
|
|
CefBrowserSettings& settings) =0;
|
|
|
|
// Called on the UI thread after a new window is created. The return value is
|
|
// currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleAfterCreated(CefRefPtr<CefBrowser> browser) =0;
|
|
|
|
// Called on the UI thread when a frame's address has changed. The return
|
|
// value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleAddressChange(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& url) =0;
|
|
|
|
// Called on the UI thread when the page title changes. The return value is
|
|
// currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleTitleChange(CefRefPtr<CefBrowser> browser,
|
|
const CefString& title) =0;
|
|
|
|
// Called on the UI thread when the navigation state has changed. The return
|
|
// value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleNavStateChange(CefRefPtr<CefBrowser> browser,
|
|
bool canGoBack, bool canGoForward) =0;
|
|
|
|
// Various browser navigation types supported by chrome.
|
|
typedef cef_handler_navtype_t NavType;
|
|
|
|
// Called on the UI thread before browser navigation. The client has an
|
|
// opportunity to modify the |request| object if desired. Return RV_HANDLED
|
|
// to cancel navigation.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleBeforeBrowse(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
CefRefPtr<CefRequest> request,
|
|
NavType navType, bool isRedirect) =0;
|
|
|
|
// Called on the UI thread when the browser begins loading a frame. The
|
|
// |frame| value will never be empty -- call the IsMain() method to check if
|
|
// this frame is the main frame. Multiple frames may be loading at the same
|
|
// time. Sub-frames may start or continue loading after the main frame load
|
|
// has ended. This method may not be called for a particular frame if the load
|
|
// request for that frame fails. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleLoadStart(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame) =0;
|
|
|
|
// Called on the UI thread when the browser is done loading a frame. The
|
|
// |frame| value will never be empty -- call the IsMain() method to check if
|
|
// this frame is the main frame. Multiple frames may be loading at the same
|
|
// time. Sub-frames may start or continue loading after the main frame load
|
|
// has ended. This method will always be called for all frames irrespective of
|
|
// whether the request completes successfully. The return value is currently
|
|
// ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleLoadEnd(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
int httpStatusCode) =0;
|
|
|
|
// Supported error code values. See net\base\net_error_list.h for complete
|
|
// descriptions of the error codes.
|
|
typedef cef_handler_errorcode_t ErrorCode;
|
|
|
|
// Called on the UI thread when the browser fails to load a resource.
|
|
// |errorCode| is the error code number and |failedUrl| is the URL that failed
|
|
// to load. To provide custom error text assign the text to |errorText| and
|
|
// return RV_HANDLED. Otherwise, return RV_CONTINUE for the default error
|
|
// text.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleLoadError(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
ErrorCode errorCode,
|
|
const CefString& failedUrl,
|
|
CefString& errorText) =0;
|
|
|
|
// Called on the IO thread before a resource is loaded. To allow the resource
|
|
// to load normally return RV_CONTINUE. To redirect the resource to a new url
|
|
// populate the |redirectUrl| value and return RV_CONTINUE. To specify data
|
|
// for the resource return a CefStream object in |resourceStream|, use the
|
|
// |response| object to set mime type, HTTP status code and optional header
|
|
// values, and return RV_CONTINUE. To cancel loading of the resource return
|
|
// RV_HANDLED. Any modifications to |request| will be observed. If the URL in
|
|
// |request| is changed and |redirectUrl| is also set, the URL in |request|
|
|
// will be used.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleBeforeResourceLoad(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefRequest> request,
|
|
CefString& redirectUrl,
|
|
CefRefPtr<CefStreamReader>& resourceStream,
|
|
CefRefPtr<CefResponse> response,
|
|
int loadFlags) =0;
|
|
|
|
// Called on the IO thread to handle requests for URLs with an unknown
|
|
// protocol component. Return RV_HANDLED to indicate that the request should
|
|
// succeed because it was externally handled. Set |allow_os_execution| to true
|
|
// and return RV_CONTINUE to attempt execution via the registered OS protocol
|
|
// handler, if any. If RV_CONTINUE is returned and either |allow_os_execution|
|
|
// is false or OS protocol handler execution fails then the request will fail
|
|
// with an error condition.
|
|
// SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED
|
|
// ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleProtocolExecution(CefRefPtr<CefBrowser> browser,
|
|
const CefString& url,
|
|
bool& allow_os_execution) =0;
|
|
|
|
// Called on the UI thread when a server indicates via the
|
|
// 'Content-Disposition' header that a response represents a file to download.
|
|
// |mimeType| is the mime type for the download, |fileName| is the suggested
|
|
// target file name and |contentLength| is either the value of the
|
|
// 'Content-Size' header or -1 if no size was provided. Set |handler| to the
|
|
// CefDownloadHandler instance that will recieve the file contents. Return
|
|
// RV_CONTINUE to download the file or RV_HANDLED to cancel the file download.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleDownloadResponse(CefRefPtr<CefBrowser> browser,
|
|
const CefString& mimeType,
|
|
const CefString& fileName,
|
|
int64 contentLength,
|
|
CefRefPtr<CefDownloadHandler>& handler) =0;
|
|
|
|
// Called on the IO thread when the browser needs credentials from the user.
|
|
// |isProxy| indicates whether the host is a proxy server. |host| contains the
|
|
// hostname and port number. Set |username| and |password| and return
|
|
// RV_HANDLED to handle the request. Return RV_CONTINUE to cancel the request.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleAuthenticationRequest(CefRefPtr<CefBrowser> browser,
|
|
bool isProxy,
|
|
const CefString& host,
|
|
const CefString& realm,
|
|
const CefString& scheme,
|
|
CefString& username,
|
|
CefString& password) =0;
|
|
|
|
// Structure representing menu information.
|
|
typedef cef_handler_menuinfo_t MenuInfo;
|
|
|
|
// Called on the UI thread before a context menu is displayed. To cancel
|
|
// display of the default context menu return RV_HANDLED.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleBeforeMenu(CefRefPtr<CefBrowser> browser,
|
|
const MenuInfo& menuInfo) =0;
|
|
|
|
// Supported menu ID values.
|
|
typedef cef_handler_menuid_t MenuId;
|
|
|
|
// Called on the UI thread to optionally override the default text for a
|
|
// context menu item. |label| contains the default text and may be modified to
|
|
// substitute alternate text. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleGetMenuLabel(CefRefPtr<CefBrowser> browser,
|
|
MenuId menuId, CefString& label) =0;
|
|
|
|
// Called on the UI thread when an option is selected from the default context
|
|
// menu. Return RV_HANDLED to cancel default handling of the action.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleMenuAction(CefRefPtr<CefBrowser> browser,
|
|
MenuId menuId) =0;
|
|
|
|
// Structure representing print options.
|
|
typedef cef_print_options_t CefPrintOptions;
|
|
|
|
// Called on the UI thread to allow customization of standard print options
|
|
// before the print dialog is displayed. |printOptions| allows specification
|
|
// of paper size, orientation and margins. Note that the specified margins may
|
|
// be adjusted if they are outside the range supported by the printer. All
|
|
// units are in inches. Return RV_CONTINUE to display the default print
|
|
// options or RV_HANDLED to display the modified |printOptions|.
|
|
/*--cef()--*/
|
|
virtual RetVal HandlePrintOptions(CefRefPtr<CefBrowser> browser,
|
|
CefPrintOptions& printOptions) =0;
|
|
|
|
// Called on the UI thread to format print headers and footers. |printInfo|
|
|
// contains platform-specific information about the printer context. |url| is
|
|
// the URL if the currently printing page, |title| is the title of the
|
|
// currently printing page, |currentPage| is the current page number and
|
|
// |maxPages| is the total number of pages. Six default header locations are
|
|
// provided by the implementation: top left, top center, top right, bottom
|
|
// left, bottom center and bottom right. To use one of these default locations
|
|
// just assign a string to the appropriate variable. To draw the header and
|
|
// footer yourself return RV_HANDLED. Otherwise, populate the approprate
|
|
// variables and return RV_CONTINUE.
|
|
/*--cef()--*/
|
|
virtual RetVal HandlePrintHeaderFooter(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
CefPrintInfo& printInfo,
|
|
const CefString& url,
|
|
const CefString& title,
|
|
int currentPage, int maxPages,
|
|
CefString& topLeft,
|
|
CefString& topCenter,
|
|
CefString& topRight,
|
|
CefString& bottomLeft,
|
|
CefString& bottomCenter,
|
|
CefString& bottomRight) =0;
|
|
|
|
// Called on the UI thread to run a JS alert message. Return RV_CONTINUE to
|
|
// display the default alert or RV_HANDLED if you displayed a custom alert.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleJSAlert(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& message) =0;
|
|
|
|
// Called on the UI thread to run a JS confirm request. Return RV_CONTINUE to
|
|
// display the default alert or RV_HANDLED if you displayed a custom alert. If
|
|
// you handled the alert set |retval| to true if the user accepted the
|
|
// confirmation.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleJSConfirm(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& message, bool& retval) =0;
|
|
|
|
// Called on the UI thread to run a JS prompt request. Return RV_CONTINUE to
|
|
// display the default prompt or RV_HANDLED if you displayed a custom prompt.
|
|
// If you handled the prompt set |retval| to true if the user accepted the
|
|
// prompt and request and |result| to the resulting value.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleJSPrompt(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& message,
|
|
const CefString& defaultValue,
|
|
bool& retval,
|
|
CefString& result) =0;
|
|
|
|
// Called on the UI thread for adding values to a frame's JavaScript 'window'
|
|
// object. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleJSBinding(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
CefRefPtr<CefV8Value> object) =0;
|
|
|
|
// Called on the UI thread just before a window is closed. The return value is
|
|
// currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleBeforeWindowClose(CefRefPtr<CefBrowser> browser) =0;
|
|
|
|
// Called on the UI thread when the browser component is about to loose focus.
|
|
// For instance, if focus was on the last HTML element and the user pressed
|
|
// the TAB key. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleTakeFocus(CefRefPtr<CefBrowser> browser,
|
|
bool reverse) =0;
|
|
|
|
// Called on the UI thread when the browser component is requesting focus.
|
|
// |isWidget| will be true if the focus is requested for a child widget of the
|
|
// browser window. Return RV_CONTINUE to allow the focus to be set or
|
|
// RV_HANDLED to cancel setting the focus.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleSetFocus(CefRefPtr<CefBrowser> browser,
|
|
bool isWidget) =0;
|
|
|
|
// Supported keyboard event types.
|
|
typedef cef_handler_keyevent_type_t KeyEventType;
|
|
|
|
// Called on the UI thread when the browser component receives a keyboard
|
|
// event. |type| is the type of keyboard event, |code| is the windows scan-
|
|
// code for the event, |modifiers| is a set of bit-flags describing any
|
|
// pressed modifier keys and |isSystemKey| is true if Windows considers this a
|
|
// 'system key' message (see
|
|
// http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx). Return
|
|
// RV_HANDLED if the keyboard event was handled or RV_CONTINUE to allow the
|
|
// browser component to handle the event.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleKeyEvent(CefRefPtr<CefBrowser> browser,
|
|
KeyEventType type,
|
|
int code,
|
|
int modifiers,
|
|
bool isSystemKey) =0;
|
|
|
|
// Called on the UI thread when the browser is about to display a tooltip.
|
|
// |text| contains the text that will be displayed in the tooltip. To handle
|
|
// the display of the tooltip yourself return RV_HANDLED. Otherwise, you can
|
|
// optionally modify |text| and then return RV_CONTINUE to allow the browser
|
|
// to display the tooltip.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleTooltip(CefRefPtr<CefBrowser> browser,
|
|
CefString& text) =0;
|
|
|
|
// Status message types.
|
|
typedef cef_handler_statustype_t StatusType;
|
|
|
|
// Called on the UI thread when the browser has a status message. |text|
|
|
// contains the text that will be displayed in the status message and |type|
|
|
// indicates the status message type. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleStatus(CefRefPtr<CefBrowser> browser,
|
|
const CefString& value,
|
|
StatusType type) =0;
|
|
|
|
// Called on the UI thread to display a console message. Return RV_HANDLED to
|
|
// stop the message from being output to the console.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleConsoleMessage(CefRefPtr<CefBrowser> browser,
|
|
const CefString& message,
|
|
const CefString& source, int line) =0;
|
|
|
|
// Called on the UI thread to report find results returned by
|
|
// CefBrowser::Find(). |identifer| is the identifier passed to
|
|
// CefBrowser::Find(), |count| is the number of matches currently identified,
|
|
// |selectionRect| is the location of where the match was found (in window
|
|
// coordinates), |activeMatchOrdinal| is the current position in the search
|
|
// results, and |finalUpdate| is true if this is the last find notification.
|
|
// The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleFindResult(CefRefPtr<CefBrowser> browser,
|
|
int identifier, int count,
|
|
const CefRect& selectionRect,
|
|
int activeMatchOrdinal, bool finalUpdate) =0;
|
|
|
|
// Called on the UI thread to retrieve either the simulated screen rectangle
|
|
// if |screen| is true or the view rectangle if |screen| is false. The view
|
|
// rectangle is relative to the screen coordinates. This method is only called
|
|
// if window rendering has been disabled. Return RV_CONTINUE if the rectangle
|
|
// was provided.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleGetRect(CefRefPtr<CefBrowser> browser, bool screen,
|
|
CefRect& rect) =0;
|
|
|
|
// Called on the UI thread retrieve the translation from view coordinates to
|
|
// actual screen coordinates. This method is only called if window rendering
|
|
// has been disabled. Return RV_CONTINUE if the screen coordinates were
|
|
// provided.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleGetScreenPoint(CefRefPtr<CefBrowser> browser,
|
|
int viewX, int viewY, int& screenX,
|
|
int& screenY) =0;
|
|
|
|
// Called on the UI thread when the browser wants to show, hide, resize or
|
|
// move the popup. If |show| is true and |rect| is zero size then the popup
|
|
// should be shown. If |show| is true and |rect| is non-zero size then |rect|
|
|
// represents the popup location in view coordinates. If |show| is false
|
|
// then the popup should be hidden. This method is only called if window
|
|
// rendering has been disabled. The return value is currently ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandlePopupChange(CefRefPtr<CefBrowser> browser, bool show,
|
|
const CefRect& rect) =0;
|
|
|
|
typedef cef_paint_element_type_t PaintElementType;
|
|
|
|
// Called when an element should be painted. |type| indicates whether the
|
|
// element is the view or the popup. |buffer| contains the pixel data for the
|
|
// whole image. |dirtyRect| indicates the portion of the image that has been
|
|
// repainted. On Windows |buffer| will be width*height*4 bytes in size and
|
|
// represents a BGRA image with an upper-left origin. This method is only
|
|
// called if window rendering has been disabled. The return value is currently
|
|
// ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandlePaint(CefRefPtr<CefBrowser> browser,
|
|
PaintElementType type, const CefRect& dirtyRect,
|
|
const void* buffer) =0;
|
|
|
|
// Called when the browser window's cursor has changed. This method is only
|
|
// called if window rendering has been disabled. The return value is currently
|
|
// ignored.
|
|
/*--cef()--*/
|
|
virtual RetVal HandleCursorChange(CefRefPtr<CefBrowser> browser,
|
|
CefCursorHandle cursor) =0;
|
|
};
|
|
|
|
// Class used to represent a web request. The methods of this class may be
|
|
// called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefRequest : public CefBase
|
|
{
|
|
public:
|
|
typedef std::map<CefString,CefString> HeaderMap;
|
|
typedef cef_weburlrequest_flags_t RequestFlags;
|
|
|
|
// Create a new CefRequest object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefRequest> CreateRequest();
|
|
|
|
// Fully qualified URL to load.
|
|
/*--cef()--*/
|
|
virtual CefString GetURL() =0;
|
|
/*--cef()--*/
|
|
virtual void SetURL(const CefString& url) =0;
|
|
|
|
// Optional request method type, defaulting to POST if post data is provided
|
|
// and GET otherwise.
|
|
/*--cef()--*/
|
|
virtual CefString GetMethod() =0;
|
|
/*--cef()--*/
|
|
virtual void SetMethod(const CefString& method) =0;
|
|
|
|
// Optional post data.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefPostData> GetPostData() =0;
|
|
/*--cef()--*/
|
|
virtual void SetPostData(CefRefPtr<CefPostData> postData) =0;
|
|
|
|
// Optional header values.
|
|
/*--cef()--*/
|
|
virtual void GetHeaderMap(HeaderMap& headerMap) =0;
|
|
/*--cef()--*/
|
|
virtual void SetHeaderMap(const HeaderMap& headerMap) =0;
|
|
|
|
// Set all values at one time.
|
|
/*--cef()--*/
|
|
virtual void Set(const CefString& url,
|
|
const CefString& method,
|
|
CefRefPtr<CefPostData> postData,
|
|
const HeaderMap& headerMap) =0;
|
|
|
|
// Optional flags. Used in combination with CefWebURLRequest.
|
|
/*--cef()--*/
|
|
virtual RequestFlags GetFlags() =0;
|
|
/*--cef()--*/
|
|
virtual void SetFlags(RequestFlags flags) =0;
|
|
|
|
// Optional URL to the first party for cookies. Used in combination with
|
|
// CefWebURLRequest.
|
|
/*--cef()--*/
|
|
virtual CefString GetFirstPartyForCookies() =0;
|
|
/*--cef()--*/
|
|
virtual void SetFirstPartyForCookies(const CefString& url) =0;
|
|
};
|
|
|
|
|
|
// Class used to represent post data for a web request. The methods of this
|
|
// class may be called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefPostData : public CefBase
|
|
{
|
|
public:
|
|
typedef std::vector<CefRefPtr<CefPostDataElement> > ElementVector;
|
|
|
|
// Create a new CefPostData object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefPostData> CreatePostData();
|
|
|
|
// Returns the number of existing post data elements.
|
|
/*--cef()--*/
|
|
virtual size_t GetElementCount() =0;
|
|
|
|
// Retrieve the post data elements.
|
|
/*--cef()--*/
|
|
virtual void GetElements(ElementVector& elements) =0;
|
|
|
|
// Remove the specified post data element. Returns true if the removal
|
|
// succeeds.
|
|
/*--cef()--*/
|
|
virtual bool RemoveElement(CefRefPtr<CefPostDataElement> element) =0;
|
|
|
|
// Add the specified post data element. Returns true if the add succeeds.
|
|
/*--cef()--*/
|
|
virtual bool AddElement(CefRefPtr<CefPostDataElement> element) =0;
|
|
|
|
// Remove all existing post data elements.
|
|
/*--cef()--*/
|
|
virtual void RemoveElements() =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a single element in the request post data. The
|
|
// methods of this class may be called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefPostDataElement : public CefBase
|
|
{
|
|
public:
|
|
// Post data elements may represent either bytes or files.
|
|
typedef cef_postdataelement_type_t Type;
|
|
|
|
// Create a new CefPostDataElement object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefPostDataElement> CreatePostDataElement();
|
|
|
|
// Remove all contents from the post data element.
|
|
/*--cef()--*/
|
|
virtual void SetToEmpty() =0;
|
|
|
|
// The post data element will represent a file.
|
|
/*--cef()--*/
|
|
virtual void SetToFile(const CefString& fileName) =0;
|
|
|
|
// The post data element will represent bytes. The bytes passed
|
|
// in will be copied.
|
|
/*--cef()--*/
|
|
virtual void SetToBytes(size_t size, const void* bytes) =0;
|
|
|
|
// Return the type of this post data element.
|
|
/*--cef()--*/
|
|
virtual Type GetType() =0;
|
|
|
|
// Return the file name.
|
|
/*--cef()--*/
|
|
virtual CefString GetFile() =0;
|
|
|
|
// Return the number of bytes.
|
|
/*--cef()--*/
|
|
virtual size_t GetBytesCount() =0;
|
|
|
|
// Read up to |size| bytes into |bytes| and return the number of bytes
|
|
// actually read.
|
|
/*--cef()--*/
|
|
virtual size_t GetBytes(size_t size, void* bytes) =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a web response. The methods of this class may be
|
|
// called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefResponse : public CefBase
|
|
{
|
|
public:
|
|
typedef std::map<CefString,CefString> HeaderMap;
|
|
|
|
// Returns/sets the response status code.
|
|
/*--cef()--*/
|
|
virtual int GetStatus() =0;
|
|
/*--cef()--*/
|
|
virtual void SetStatus(int status) = 0;
|
|
|
|
// Returns/sets the response status text.
|
|
/*--cef()--*/
|
|
virtual CefString GetStatusText() =0;
|
|
/*--cef()--*/
|
|
virtual void SetStatusText(const CefString& statusText) = 0;
|
|
|
|
// Returns/sets the response mime type.
|
|
/*--cef()--*/
|
|
virtual CefString GetMimeType() = 0;
|
|
/*--cef()--*/
|
|
virtual void SetMimeType(const CefString& mimeType) = 0;
|
|
|
|
// Returns the value for the specified response header field.
|
|
/*--cef()--*/
|
|
virtual CefString GetHeader(const CefString& name) =0;
|
|
|
|
// Retrieves/sets a map of all response header fields.
|
|
/*--cef()--*/
|
|
virtual void GetHeaderMap(HeaderMap& headerMap) =0;
|
|
/*--cef()--*/
|
|
virtual void SetHeaderMap(const HeaderMap& headerMap) =0;
|
|
};
|
|
|
|
|
|
// Interface the client can implement to provide a custom stream reader. The
|
|
// methods of this class may be called on any thread.
|
|
/*--cef(source=client)--*/
|
|
class CefReadHandler : public CefBase
|
|
{
|
|
public:
|
|
// Read raw binary data.
|
|
/*--cef()--*/
|
|
virtual size_t Read(void* ptr, size_t size, size_t n) =0;
|
|
|
|
// Seek to the specified offset position. |whence| may be any one of
|
|
// SEEK_CUR, SEEK_END or SEEK_SET.
|
|
/*--cef()--*/
|
|
virtual int Seek(long offset, int whence) =0;
|
|
|
|
// Return the current offset position.
|
|
/*--cef()--*/
|
|
virtual long Tell() =0;
|
|
|
|
// Return non-zero if at end of file.
|
|
/*--cef()--*/
|
|
virtual int Eof() =0;
|
|
};
|
|
|
|
|
|
// Class used to read data from a stream. The methods of this class may be
|
|
// called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefStreamReader : public CefBase
|
|
{
|
|
public:
|
|
// Create a new CefStreamReader object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefStreamReader> CreateForFile(const CefString& fileName);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefStreamReader> CreateForData(void* data, size_t size);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefStreamReader> CreateForHandler(
|
|
CefRefPtr<CefReadHandler> handler);
|
|
|
|
// Read raw binary data.
|
|
/*--cef()--*/
|
|
virtual size_t Read(void* ptr, size_t size, size_t n) =0;
|
|
|
|
// Seek to the specified offset position. |whence| may be any one of
|
|
// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on
|
|
// failure.
|
|
/*--cef()--*/
|
|
virtual int Seek(long offset, int whence) =0;
|
|
|
|
// Return the current offset position.
|
|
/*--cef()--*/
|
|
virtual long Tell() =0;
|
|
|
|
// Return non-zero if at end of file.
|
|
/*--cef()--*/
|
|
virtual int Eof() =0;
|
|
};
|
|
|
|
|
|
// Interface the client can implement to provide a custom stream writer. The
|
|
// methods of this class may be called on any thread.
|
|
/*--cef(source=client)--*/
|
|
class CefWriteHandler : public CefBase
|
|
{
|
|
public:
|
|
// Write raw binary data.
|
|
/*--cef()--*/
|
|
virtual size_t Write(const void* ptr, size_t size, size_t n) =0;
|
|
|
|
// Seek to the specified offset position. |whence| may be any one of
|
|
// SEEK_CUR, SEEK_END or SEEK_SET.
|
|
/*--cef()--*/
|
|
virtual int Seek(long offset, int whence) =0;
|
|
|
|
// Return the current offset position.
|
|
/*--cef()--*/
|
|
virtual long Tell() =0;
|
|
|
|
// Flush the stream.
|
|
/*--cef()--*/
|
|
virtual int Flush() =0;
|
|
};
|
|
|
|
|
|
// Class used to write data to a stream. The methods of this class may be called
|
|
// on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefStreamWriter : public CefBase
|
|
{
|
|
public:
|
|
// Create a new CefStreamWriter object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefStreamWriter> CreateForFile(const CefString& fileName);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefStreamWriter> CreateForHandler(
|
|
CefRefPtr<CefWriteHandler> handler);
|
|
|
|
// Write raw binary data.
|
|
/*--cef()--*/
|
|
virtual size_t Write(const void* ptr, size_t size, size_t n) =0;
|
|
|
|
// Seek to the specified offset position. |whence| may be any one of
|
|
// SEEK_CUR, SEEK_END or SEEK_SET.
|
|
/*--cef()--*/
|
|
virtual int Seek(long offset, int whence) =0;
|
|
|
|
// Return the current offset position.
|
|
/*--cef()--*/
|
|
virtual long Tell() =0;
|
|
|
|
// Flush the stream.
|
|
/*--cef()--*/
|
|
virtual int Flush() =0;
|
|
};
|
|
|
|
|
|
// Class that encapsulates a V8 context handle.
|
|
/*--cef(source=library)--*/
|
|
class CefV8Context : public CefBase
|
|
{
|
|
public:
|
|
// Returns the current (top) context object in the V8 context stack.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Context> GetCurrentContext();
|
|
|
|
// Returns the entered (bottom) context object in the V8 context stack.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Context> GetEnteredContext();
|
|
|
|
// Returns the browser for this context.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefBrowser> GetBrowser() =0;
|
|
|
|
// Returns the frame for this context.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefFrame> GetFrame() =0;
|
|
|
|
// Returns the global object for this context.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefV8Value> GetGlobal() =0;
|
|
|
|
// Enter this context. A context must be explicitly entered before creating a
|
|
// V8 Object, Array or Function asynchronously. Exit() must be called the same
|
|
// number of times as Enter() before releasing this context. V8 objects belong
|
|
// to the context in which they are created. Returns true if the scope was
|
|
// entered successfully.
|
|
/*--cef()--*/
|
|
virtual bool Enter() =0;
|
|
|
|
// Exit this context. Call this method only after calling Enter(). Returns
|
|
// true if the scope was exited successfully.
|
|
/*--cef()--*/
|
|
virtual bool Exit() =0;
|
|
};
|
|
|
|
|
|
typedef std::vector<CefRefPtr<CefV8Value> > CefV8ValueList;
|
|
|
|
// Interface that should be implemented to handle V8 function calls. The methods
|
|
// of this class will always be called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefV8Handler : public CefBase
|
|
{
|
|
public:
|
|
// Execute with the specified argument list and return value. Return true if
|
|
// the method was handled. To invoke V8 callback functions outside the scope
|
|
// of this method you need to keep references to the current V8 context
|
|
// (CefV8Context) along with any necessary callback objects.
|
|
/*--cef()--*/
|
|
virtual bool Execute(const CefString& name,
|
|
CefRefPtr<CefV8Value> object,
|
|
const CefV8ValueList& arguments,
|
|
CefRefPtr<CefV8Value>& retval,
|
|
CefString& exception) =0;
|
|
};
|
|
|
|
// Interface that should be implemented to handle V8 accessor calls. Accessor
|
|
// identifiers are registered by calling CefV8Value::SetValue(). The methods
|
|
// of this class will always be called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefV8Accessor : public CefBase
|
|
{
|
|
public:
|
|
// Called to get an accessor value. |name| is the name of the property being
|
|
// accessed. |object| is the This() object from V8's AccessorInfo structure.
|
|
// |retval| is the value to return for this property. Return true if handled.
|
|
/*--cef()--*/
|
|
virtual bool Get(const CefString& name,
|
|
const CefRefPtr<CefV8Value> object,
|
|
CefRefPtr<CefV8Value>& retval) =0;
|
|
|
|
// Called to set an accessor value. |name| is the name of the property being
|
|
// accessed. |value| is the new value being assigned to this property.
|
|
// |object| is the This() object from V8's AccessorInfo structure. Return true
|
|
// if handled.
|
|
/*--cef()--*/
|
|
virtual bool Set(const CefString& name,
|
|
const CefRefPtr<CefV8Value> object,
|
|
const CefRefPtr<CefV8Value> value) =0;
|
|
};
|
|
|
|
|
|
// Class representing a V8 value. The methods of this class should only be
|
|
// called on the UI thread.
|
|
/*--cef(source=library)--*/
|
|
class CefV8Value : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_v8_accesscontrol_t AccessControl;
|
|
typedef cef_v8_propertyattribute_t PropertyAttribute;
|
|
|
|
// Create a new CefV8Value object of the specified type.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateUndefined();
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateNull();
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateBool(bool value);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateInt(int value);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateDouble(double value);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateString(const CefString& value);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateObject(CefRefPtr<CefBase> user_data);
|
|
/*--cef(capi_name=cef_v8value_create_object_with_accessor)--*/
|
|
static CefRefPtr<CefV8Value> CreateObject(CefRefPtr<CefBase> user_data,
|
|
CefRefPtr<CefV8Accessor> accessor);
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateArray();
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefV8Value> CreateFunction(const CefString& name,
|
|
CefRefPtr<CefV8Handler> handler);
|
|
|
|
// Check the value type.
|
|
/*--cef()--*/
|
|
virtual bool IsUndefined() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsNull() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsBool() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsInt() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsDouble() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsString() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsObject() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsArray() =0;
|
|
/*--cef()--*/
|
|
virtual bool IsFunction() =0;
|
|
|
|
// Returns true if this object is pointing to the same handle as |that|
|
|
// object.
|
|
/*--cef()--*/
|
|
virtual bool IsSame(CefRefPtr<CefV8Value> that) =0;
|
|
|
|
// Return a primitive value type. The underlying data will be converted to
|
|
// the requested type if necessary.
|
|
/*--cef()--*/
|
|
virtual bool GetBoolValue() =0;
|
|
/*--cef()--*/
|
|
virtual int GetIntValue() =0;
|
|
/*--cef()--*/
|
|
virtual double GetDoubleValue() =0;
|
|
/*--cef()--*/
|
|
virtual CefString GetStringValue() =0;
|
|
|
|
|
|
// OBJECT METHODS - These methods are only available on objects. Arrays and
|
|
// functions are also objects. String- and integer-based keys can be used
|
|
// interchangably with the framework converting between them as necessary.
|
|
// Keys beginning with "Cef::" and "v8::" are reserved by the system.
|
|
|
|
// Returns true if the object has a value with the specified identifier.
|
|
/*--cef(capi_name=has_value_bykey)--*/
|
|
virtual bool HasValue(const CefString& key) =0;
|
|
/*--cef(capi_name=has_value_byindex)--*/
|
|
virtual bool HasValue(int index) =0;
|
|
|
|
// Delete the value with the specified identifier.
|
|
/*--cef(capi_name=delete_value_bykey)--*/
|
|
virtual bool DeleteValue(const CefString& key) =0;
|
|
/*--cef(capi_name=delete_value_byindex)--*/
|
|
virtual bool DeleteValue(int index) =0;
|
|
|
|
// Returns the value with the specified identifier.
|
|
/*--cef(capi_name=get_value_bykey)--*/
|
|
virtual CefRefPtr<CefV8Value> GetValue(const CefString& key) =0;
|
|
/*--cef(capi_name=get_value_byindex)--*/
|
|
virtual CefRefPtr<CefV8Value> GetValue(int index) =0;
|
|
|
|
// Associate a value with the specified identifier.
|
|
/*--cef(capi_name=set_value_bykey)--*/
|
|
virtual bool SetValue(const CefString& key, CefRefPtr<CefV8Value> value) =0;
|
|
/*--cef(capi_name=set_value_byindex)--*/
|
|
virtual bool SetValue(int index, CefRefPtr<CefV8Value> value) =0;
|
|
|
|
// Register an identifier whose access will be forwarded to the CefV8Accessor
|
|
// instance passed to CefV8Value::CreateObject().
|
|
/*--cef(capi_name=set_value_byaccessor)--*/
|
|
virtual bool SetValue(const CefString& key, AccessControl settings,
|
|
PropertyAttribute attribute) =0;
|
|
|
|
// Read the keys for the object's values into the specified vector. Integer-
|
|
// based keys will also be returned as strings.
|
|
/*--cef()--*/
|
|
virtual bool GetKeys(std::vector<CefString>& keys) =0;
|
|
|
|
// Returns the user data, if any, specified when the object was created.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefBase> GetUserData() =0;
|
|
|
|
|
|
// ARRAY METHODS - These methods are only available on arrays.
|
|
|
|
// Returns the number of elements in the array.
|
|
/*--cef()--*/
|
|
virtual int GetArrayLength() =0;
|
|
|
|
|
|
// FUNCTION METHODS - These methods are only available on functions.
|
|
|
|
// Returns the function name.
|
|
/*--cef()--*/
|
|
virtual CefString GetFunctionName() =0;
|
|
|
|
// Returns the function handler or NULL if not a CEF-created function.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefV8Handler> GetFunctionHandler() =0;
|
|
|
|
// Execute the function using the current V8 context.
|
|
/*--cef()--*/
|
|
virtual bool ExecuteFunction(CefRefPtr<CefV8Value> object,
|
|
const CefV8ValueList& arguments,
|
|
CefRefPtr<CefV8Value>& retval,
|
|
CefString& exception) =0;
|
|
|
|
// Execute the function using the specified V8 context.
|
|
/*--cef()--*/
|
|
virtual bool ExecuteFunctionWithContext(CefRefPtr<CefV8Context> context,
|
|
CefRefPtr<CefV8Value> object,
|
|
const CefV8ValueList& arguments,
|
|
CefRefPtr<CefV8Value>& retval,
|
|
CefString& exception) =0;
|
|
|
|
};
|
|
|
|
|
|
// Class that creates CefSchemeHandler instances. The methods of this class will
|
|
// always be called on the IO thread.
|
|
/*--cef(source=client)--*/
|
|
class CefSchemeHandlerFactory : public CefBase
|
|
{
|
|
public:
|
|
// Return a new scheme handler instance to handle the request.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefSchemeHandler> Create() =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a custom scheme handler interface. The methods of
|
|
// this class will always be called on the IO thread.
|
|
/*--cef(source=client)--*/
|
|
class CefSchemeHandler : public CefBase
|
|
{
|
|
public:
|
|
// Process the request. All response generation should take place in this
|
|
// method. If there is no response set |response_length| to zero or return
|
|
// false and ReadResponse() will not be called. If the response length is not
|
|
// known set |response_length| to -1 and ReadResponse() will be called until
|
|
// it returns false or until the value of |bytes_read| is set to 0. If the
|
|
// response length is known set |response_length| to a positive value and
|
|
// ReadResponse() will be called until it returns false, the value of
|
|
// |bytes_read| is set to 0 or the specified number of bytes have been read.
|
|
// Use the |response| object to set the mime type, http status code and
|
|
// optional header values for the response and return true. To redirect the
|
|
// request to a new URL set |redirectUrl| to the new URL and return true.
|
|
/*--cef()--*/
|
|
virtual bool ProcessRequest(CefRefPtr<CefRequest> request,
|
|
CefString& redirectUrl,
|
|
CefRefPtr<CefResponse> response,
|
|
int* response_length) =0;
|
|
|
|
// Cancel processing of the request.
|
|
/*--cef()--*/
|
|
virtual void Cancel() =0;
|
|
|
|
// Copy up to |bytes_to_read| bytes into |data_out|. If the copy succeeds
|
|
// set |bytes_read| to the number of bytes copied and return true. If the
|
|
// copy fails return false and ReadResponse() will not be called again.
|
|
/*--cef()--*/
|
|
virtual bool ReadResponse(void* data_out, int bytes_to_read,
|
|
int* bytes_read) =0;
|
|
};
|
|
|
|
|
|
// Class used to handle file downloads. The methods of this class will always be
|
|
// called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefDownloadHandler : public CefBase
|
|
{
|
|
public:
|
|
// A portion of the file contents have been received. This method will be
|
|
// called multiple times until the download is complete. Return |true| to
|
|
// continue receiving data and |false| to cancel.
|
|
/*--cef()--*/
|
|
virtual bool ReceivedData(void* data, int data_size) =0;
|
|
|
|
// The download is complete.
|
|
/*--cef()--*/
|
|
virtual void Complete() =0;
|
|
};
|
|
|
|
|
|
// Class used to make a Web URL request. Web URL requests are not associated
|
|
// with a browser instance so no CefHandler callbacks will be executed. The
|
|
// methods of this class may be called on any thread.
|
|
/*--cef(source=library)--*/
|
|
class CefWebURLRequest : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_weburlrequest_state_t RequestState;
|
|
|
|
// Create a new CefWebUrlReqeust object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefWebURLRequest> CreateWebURLRequest(
|
|
CefRefPtr<CefRequest> request,
|
|
CefRefPtr<CefWebURLRequestClient> client);
|
|
|
|
// Cancels the request.
|
|
/*--cef()--*/
|
|
virtual void Cancel() =0;
|
|
|
|
// Returns the current ready state of the request.
|
|
/*--cef()--*/
|
|
virtual RequestState GetState() =0;
|
|
};
|
|
|
|
// Interface that should be implemented by the CefWebURLRequest client. The
|
|
// methods of this class will always be called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefWebURLRequestClient : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_weburlrequest_state_t RequestState;
|
|
|
|
// Notifies the client that the request state has changed. State change
|
|
// notifications will always be sent before the below notification methods
|
|
// are called.
|
|
/*--cef()--*/
|
|
virtual void OnStateChange(CefRefPtr<CefWebURLRequest> requester,
|
|
RequestState state) =0;
|
|
|
|
// Notifies the client that the request has been redirected and provides a
|
|
// chance to change the request parameters.
|
|
/*--cef()--*/
|
|
virtual void OnRedirect(CefRefPtr<CefWebURLRequest> requester,
|
|
CefRefPtr<CefRequest> request,
|
|
CefRefPtr<CefResponse> response) =0;
|
|
|
|
// Notifies the client of the response data.
|
|
/*--cef()--*/
|
|
virtual void OnHeadersReceived(CefRefPtr<CefWebURLRequest> requester,
|
|
CefRefPtr<CefResponse> response) =0;
|
|
|
|
// Notifies the client of the upload progress.
|
|
/*--cef()--*/
|
|
virtual void OnProgress(CefRefPtr<CefWebURLRequest> requester,
|
|
uint64 bytesSent, uint64 totalBytesToBeSent) =0;
|
|
|
|
// Notifies the client that content has been received.
|
|
/*--cef()--*/
|
|
virtual void OnData(CefRefPtr<CefWebURLRequest> requester,
|
|
const void* data, int dataLength) =0;
|
|
|
|
// Supported error code values. See net\base\net_error_list.h for complete
|
|
// descriptions of the error codes.
|
|
typedef cef_handler_errorcode_t ErrorCode;
|
|
|
|
// Notifies the client that the request ended with an error.
|
|
/*--cef()--*/
|
|
virtual void OnError(CefRefPtr<CefWebURLRequest> requester,
|
|
ErrorCode errorCode) =0;
|
|
};
|
|
|
|
|
|
// Class that supports the reading of XML data via the libxml streaming API.
|
|
// The methods of this class should only be called on the thread that creates
|
|
// the object.
|
|
/*--cef(source=library)--*/
|
|
class CefXmlReader : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_xml_encoding_type_t EncodingType;
|
|
typedef cef_xml_node_type_t NodeType;
|
|
|
|
// Create a new CefXmlReader object. The returned object's methods can only
|
|
// be called from the thread that created the object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefXmlReader> Create(CefRefPtr<CefStreamReader> stream,
|
|
EncodingType encodingType,
|
|
const CefString& URI);
|
|
|
|
// Moves the cursor to the next node in the document. This method must be
|
|
// called at least once to set the current cursor position. Returns true if
|
|
// the cursor position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToNextNode() =0;
|
|
|
|
// Close the document. This should be called directly to ensure that cleanup
|
|
// occurs on the correct thread.
|
|
/*--cef()--*/
|
|
virtual bool Close() =0;
|
|
|
|
// Returns true if an error has been reported by the XML parser.
|
|
/*--cef()--*/
|
|
virtual bool HasError() =0;
|
|
|
|
// Returns the error string.
|
|
/*--cef()--*/
|
|
virtual CefString GetError() =0;
|
|
|
|
|
|
// The below methods retrieve data for the node at the current cursor
|
|
// position.
|
|
|
|
// Returns the node type.
|
|
/*--cef()--*/
|
|
virtual NodeType GetType() =0;
|
|
|
|
// Returns the node depth. Depth starts at 0 for the root node.
|
|
/*--cef()--*/
|
|
virtual int GetDepth() =0;
|
|
|
|
// Returns the local name. See
|
|
// http://www.w3.org/TR/REC-xml-names/#NT-LocalPart for additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetLocalName() =0;
|
|
|
|
// Returns the namespace prefix. See http://www.w3.org/TR/REC-xml-names/ for
|
|
// additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetPrefix() =0;
|
|
|
|
// Returns the qualified name, equal to (Prefix:)LocalName. See
|
|
// http://www.w3.org/TR/REC-xml-names/#ns-qualnames for additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetQualifiedName() =0;
|
|
|
|
// Returns the URI defining the namespace associated with the node. See
|
|
// http://www.w3.org/TR/REC-xml-names/ for additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetNamespaceURI() =0;
|
|
|
|
// Returns the base URI of the node. See http://www.w3.org/TR/xmlbase/ for
|
|
// additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetBaseURI() =0;
|
|
|
|
// Returns the xml:lang scope within which the node resides. See
|
|
// http://www.w3.org/TR/REC-xml/#sec-lang-tag for additional details.
|
|
/*--cef()--*/
|
|
virtual CefString GetXmlLang() =0;
|
|
|
|
// Returns true if the node represents an empty element. <a/> is considered
|
|
// empty but <a></a> is not.
|
|
/*--cef()--*/
|
|
virtual bool IsEmptyElement() =0;
|
|
|
|
// Returns true if the node has a text value.
|
|
/*--cef()--*/
|
|
virtual bool HasValue() =0;
|
|
|
|
// Returns the text value.
|
|
/*--cef()--*/
|
|
virtual CefString GetValue() =0;
|
|
|
|
// Returns true if the node has attributes.
|
|
/*--cef()--*/
|
|
virtual bool HasAttributes() =0;
|
|
|
|
// Returns the number of attributes.
|
|
/*--cef()--*/
|
|
virtual size_t GetAttributeCount() =0;
|
|
|
|
// Returns the value of the attribute at the specified 0-based index.
|
|
/*--cef(capi_name=get_attribute_byindex)--*/
|
|
virtual CefString GetAttribute(int index) =0;
|
|
|
|
// Returns the value of the attribute with the specified qualified name.
|
|
/*--cef(capi_name=get_attribute_byqname)--*/
|
|
virtual CefString GetAttribute(const CefString& qualifiedName) =0;
|
|
|
|
// Returns the value of the attribute with the specified local name and
|
|
// namespace URI.
|
|
/*--cef(capi_name=get_attribute_bylname)--*/
|
|
virtual CefString GetAttribute(const CefString& localName,
|
|
const CefString& namespaceURI) =0;
|
|
|
|
// Returns an XML representation of the current node's children.
|
|
/*--cef()--*/
|
|
virtual CefString GetInnerXml() =0;
|
|
|
|
// Returns an XML representation of the current node including its children.
|
|
/*--cef()--*/
|
|
virtual CefString GetOuterXml() =0;
|
|
|
|
// Returns the line number for the current node.
|
|
/*--cef()--*/
|
|
virtual int GetLineNumber() =0;
|
|
|
|
|
|
// Attribute nodes are not traversed by default. The below methods can be
|
|
// used to move the cursor to an attribute node. MoveToCarryingElement() can
|
|
// be called afterwards to return the cursor to the carrying element. The
|
|
// depth of an attribute node will be 1 + the depth of the carrying element.
|
|
|
|
// Moves the cursor to the attribute at the specified 0-based index. Returns
|
|
// true if the cursor position was set successfully.
|
|
/*--cef(capi_name=move_to_attribute_byindex)--*/
|
|
virtual bool MoveToAttribute(int index) =0;
|
|
|
|
// Moves the cursor to the attribute with the specified qualified name.
|
|
// Returns true if the cursor position was set successfully.
|
|
/*--cef(capi_name=move_to_attribute_byqname)--*/
|
|
virtual bool MoveToAttribute(const CefString& qualifiedName) =0;
|
|
|
|
// Moves the cursor to the attribute with the specified local name and
|
|
// namespace URI. Returns true if the cursor position was set successfully.
|
|
/*--cef(capi_name=move_to_attribute_bylname)--*/
|
|
virtual bool MoveToAttribute(const CefString& localName,
|
|
const CefString& namespaceURI) =0;
|
|
|
|
// Moves the cursor to the first attribute in the current element. Returns
|
|
// true if the cursor position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToFirstAttribute() =0;
|
|
|
|
// Moves the cursor to the next attribute in the current element. Returns
|
|
// true if the cursor position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToNextAttribute() =0;
|
|
|
|
// Moves the cursor back to the carrying element. Returns true if the cursor
|
|
// position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToCarryingElement() =0;
|
|
};
|
|
|
|
|
|
// Class that supports the reading of zip archives via the zlib unzip API.
|
|
// The methods of this class should only be called on the thread that creates
|
|
// the object.
|
|
/*--cef(source=library)--*/
|
|
class CefZipReader : public CefBase
|
|
{
|
|
public:
|
|
// Create a new CefZipReader object. The returned object's methods can only
|
|
// be called from the thread that created the object.
|
|
/*--cef()--*/
|
|
static CefRefPtr<CefZipReader> Create(CefRefPtr<CefStreamReader> stream);
|
|
|
|
// Moves the cursor to the first file in the archive. Returns true if the
|
|
// cursor position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToFirstFile() =0;
|
|
|
|
// Moves the cursor to the next file in the archive. Returns true if the
|
|
// cursor position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToNextFile() =0;
|
|
|
|
// Moves the cursor to the specified file in the archive. If |caseSensitive|
|
|
// is true then the search will be case sensitive. Returns true if the cursor
|
|
// position was set successfully.
|
|
/*--cef()--*/
|
|
virtual bool MoveToFile(const CefString& fileName, bool caseSensitive) =0;
|
|
|
|
// Closes the archive. This should be called directly to ensure that cleanup
|
|
// occurs on the correct thread.
|
|
/*--cef()--*/
|
|
virtual bool Close() =0;
|
|
|
|
|
|
// The below methods act on the file at the current cursor position.
|
|
|
|
// Returns the name of the file.
|
|
/*--cef()--*/
|
|
virtual CefString GetFileName() =0;
|
|
|
|
// Returns the uncompressed size of the file.
|
|
/*--cef()--*/
|
|
virtual long GetFileSize() =0;
|
|
|
|
// Returns the last modified timestamp for the file.
|
|
/*--cef()--*/
|
|
virtual time_t GetFileLastModified() =0;
|
|
|
|
// Opens the file for reading of uncompressed data. A read password may
|
|
// optionally be specified.
|
|
/*--cef()--*/
|
|
virtual bool OpenFile(const CefString& password) =0;
|
|
|
|
// Closes the file.
|
|
/*--cef()--*/
|
|
virtual bool CloseFile() =0;
|
|
|
|
// Read uncompressed file contents into the specified buffer. Returns < 0 if
|
|
// an error occurred, 0 if at the end of file, or the number of bytes read.
|
|
/*--cef()--*/
|
|
virtual int ReadFile(void* buffer, size_t bufferSize) =0;
|
|
|
|
// Returns the current offset in the uncompressed file contents.
|
|
/*--cef()--*/
|
|
virtual long Tell() =0;
|
|
|
|
// Returns true if at end of the file contents.
|
|
/*--cef()--*/
|
|
virtual bool Eof() =0;
|
|
};
|
|
|
|
|
|
// Interface to implement for visiting the DOM. The methods of this class will
|
|
// be called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefDOMVisitor : public CefBase
|
|
{
|
|
public:
|
|
// Method executed for visiting the DOM. The document object passed to this
|
|
// method represents a snapshot of the DOM at the time this method is
|
|
// executed. DOM objects are only valid for the scope of this method. Do not
|
|
// keep references to or attempt to access any DOM objects outside the scope
|
|
// of this method.
|
|
/*--cef()--*/
|
|
virtual void Visit(CefRefPtr<CefDOMDocument> document) =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a DOM document. The methods of this class should only
|
|
// be called on the UI thread.
|
|
/*--cef(source=library)--*/
|
|
class CefDOMDocument : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_dom_document_type_t Type;
|
|
|
|
// Returns the document type.
|
|
/*--cef()--*/
|
|
virtual Type GetType() =0;
|
|
|
|
// Returns the root document node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetDocument() =0;
|
|
|
|
// Returns the BODY node of an HTML document.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetBody() =0;
|
|
|
|
// Returns the HEAD node of an HTML document.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetHead() =0;
|
|
|
|
// Returns the title of an HTML document.
|
|
/*--cef()--*/
|
|
virtual CefString GetTitle() =0;
|
|
|
|
// Returns the document element with the specified ID value.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetElementById(const CefString& id) =0;
|
|
|
|
// Returns the node that currently has keyboard focus.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetFocusedNode() =0;
|
|
|
|
// Returns true if a portion of the document is selected.
|
|
/*--cef()--*/
|
|
virtual bool HasSelection() =0;
|
|
|
|
// Returns the selection start node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetSelectionStartNode() =0;
|
|
|
|
// Returns the selection offset within the start node.
|
|
/*--cef()--*/
|
|
virtual int GetSelectionStartOffset() =0;
|
|
|
|
// Returns the selection end node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetSelectionEndNode() =0;
|
|
|
|
// Returns the selection offset within the end node.
|
|
/*--cef()--*/
|
|
virtual int GetSelectionEndOffset() =0;
|
|
|
|
// Returns the contents of this selection as markup.
|
|
/*--cef()--*/
|
|
virtual CefString GetSelectionAsMarkup() =0;
|
|
|
|
// Returns the contents of this selection as text.
|
|
/*--cef()--*/
|
|
virtual CefString GetSelectionAsText() =0;
|
|
|
|
// Returns the base URL for the document.
|
|
/*--cef()--*/
|
|
virtual CefString GetBaseURL() =0;
|
|
|
|
// Returns a complete URL based on the document base URL and the specified
|
|
// partial URL.
|
|
/*--cef()--*/
|
|
virtual CefString GetCompleteURL(const CefString& partialURL) =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a DOM node. The methods of this class should only be
|
|
// called on the UI thread.
|
|
/*--cef(source=library)--*/
|
|
class CefDOMNode : public CefBase
|
|
{
|
|
public:
|
|
typedef std::map<CefString,CefString> AttributeMap;
|
|
typedef cef_dom_node_type_t Type;
|
|
|
|
// Returns the type for this node.
|
|
/*--cef()--*/
|
|
virtual Type GetType() =0;
|
|
|
|
// Returns true if this is a text node.
|
|
/*--cef()--*/
|
|
virtual bool IsText() =0;
|
|
|
|
// Returns true if this is an element node.
|
|
/*--cef()--*/
|
|
virtual bool IsElement() =0;
|
|
|
|
// Returns true if this object is pointing to the same handle as |that|
|
|
// object.
|
|
/*--cef()--*/
|
|
virtual bool IsSame(CefRefPtr<CefDOMNode> that) =0;
|
|
|
|
// Returns the name of this node.
|
|
/*--cef()--*/
|
|
virtual CefString GetName() =0;
|
|
|
|
// Returns the value of this node.
|
|
/*--cef()--*/
|
|
virtual CefString GetValue() =0;
|
|
|
|
// Set the value of this node. Returns true on success.
|
|
/*--cef()--*/
|
|
virtual bool SetValue(const CefString& value) =0;
|
|
|
|
// Returns the contents of this node as markup.
|
|
/*--cef()--*/
|
|
virtual CefString GetAsMarkup() =0;
|
|
|
|
// Returns the document associated with this node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMDocument> GetDocument() =0;
|
|
|
|
// Returns the parent node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetParent() =0;
|
|
|
|
// Returns the previous sibling node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetPreviousSibling() =0;
|
|
|
|
// Returns the next sibling node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetNextSibling() =0;
|
|
|
|
// Returns true if this node has child nodes.
|
|
/*--cef()--*/
|
|
virtual bool HasChildren() =0;
|
|
|
|
// Return the first child node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetFirstChild() =0;
|
|
|
|
// Returns the last child node.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetLastChild() =0;
|
|
|
|
// Add an event listener to this node for the specified event type. If
|
|
// |useCapture| is true then this listener will be considered a capturing
|
|
// listener. Capturing listeners will recieve all events of the specified
|
|
// type before the events are dispatched to any other event targets beneath
|
|
// the current node in the tree. Events which are bubbling upwards through
|
|
// the tree will not trigger a capturing listener. Separate calls to this
|
|
// method can be used to register the same listener with and without capture.
|
|
// See WebCore/dom/EventNames.h for the list of supported event types.
|
|
/*--cef()--*/
|
|
virtual void AddEventListener(const CefString& eventType,
|
|
CefRefPtr<CefDOMEventListener> listener,
|
|
bool useCapture) =0;
|
|
|
|
// The following methods are valid only for element nodes.
|
|
|
|
// Returns the tag name of this element.
|
|
/*--cef()--*/
|
|
virtual CefString GetElementTagName() =0;
|
|
|
|
// Returns true if this element has attributes.
|
|
/*--cef()--*/
|
|
virtual bool HasElementAttributes() =0;
|
|
|
|
// Returns true if this element has an attribute named |attrName|.
|
|
/*--cef()--*/
|
|
virtual bool HasElementAttribute(const CefString& attrName) =0;
|
|
|
|
// Returns the element attribute named |attrName|.
|
|
/*--cef()--*/
|
|
virtual CefString GetElementAttribute(const CefString& attrName) =0;
|
|
|
|
// Returns a map of all element attributes.
|
|
/*--cef()--*/
|
|
virtual void GetElementAttributes(AttributeMap& attrMap) =0;
|
|
|
|
// Set the value for the element attribute named |attrName|. Returns true on
|
|
// success.
|
|
/*--cef()--*/
|
|
virtual bool SetElementAttribute(const CefString& attrName,
|
|
const CefString& value) =0;
|
|
|
|
// Returns the inner text of the element.
|
|
/*--cef()--*/
|
|
virtual CefString GetElementInnerText() =0;
|
|
};
|
|
|
|
|
|
// Class used to represent a DOM event. The methods of this class should only
|
|
// be called on the UI thread.
|
|
/*--cef(source=library)--*/
|
|
class CefDOMEvent : public CefBase
|
|
{
|
|
public:
|
|
typedef cef_dom_event_category_t Category;
|
|
typedef cef_dom_event_phase_t Phase;
|
|
|
|
// Returns the event type.
|
|
/*--cef()--*/
|
|
virtual CefString GetType() =0;
|
|
|
|
// Returns the event category.
|
|
/*--cef()--*/
|
|
virtual Category GetCategory() =0;
|
|
|
|
// Returns the event processing phase.
|
|
/*--cef()--*/
|
|
virtual Phase GetPhase() =0;
|
|
|
|
// Returns true if the event can bubble up the tree.
|
|
/*--cef()--*/
|
|
virtual bool CanBubble() =0;
|
|
|
|
// Returns true if the event can be canceled.
|
|
/*--cef()--*/
|
|
virtual bool CanCancel() =0;
|
|
|
|
// Returns the document associated with this event.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMDocument> GetDocument() =0;
|
|
|
|
// Returns the target of the event.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetTarget() =0;
|
|
|
|
// Returns the current target of the event.
|
|
/*--cef()--*/
|
|
virtual CefRefPtr<CefDOMNode> GetCurrentTarget() =0;
|
|
};
|
|
|
|
|
|
// Interface to implement for handling DOM events. The methods of this class
|
|
// will be called on the UI thread.
|
|
/*--cef(source=client)--*/
|
|
class CefDOMEventListener : public CefBase
|
|
{
|
|
public:
|
|
// Called when an event is received. The event object passed to this method
|
|
// contains a snapshot of the DOM at the time this method is executed. DOM
|
|
// objects are only valid for the scope of this method. Do not keep references
|
|
// to or attempt to access any DOM objects outside the scope of this method.
|
|
/*--cef()--*/
|
|
virtual void HandleEvent(CefRefPtr<CefDOMEvent> event) =0;
|
|
};
|
|
|
|
#endif // _CEF_H
|