mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@ -48,9 +48,9 @@
|
||||
#include "include/cef_values.h"
|
||||
|
||||
///
|
||||
// Class used to implement render process callbacks. The methods of this class
|
||||
// will be called on the render process main thread (TID_RENDERER) unless
|
||||
// otherwise indicated.
|
||||
/// Class used to implement render process callbacks. The methods of this class
|
||||
/// will be called on the render process main thread (TID_RENDERER) unless
|
||||
/// otherwise indicated.
|
||||
///
|
||||
/*--cef(source=client,no_debugct_check)--*/
|
||||
class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
@ -58,40 +58,41 @@ class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
typedef cef_navigation_type_t NavigationType;
|
||||
|
||||
///
|
||||
// Called after WebKit has been initialized.
|
||||
/// Called after WebKit has been initialized.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnWebKitInitialized() {}
|
||||
|
||||
///
|
||||
// Called after a browser has been created. When browsing cross-origin a new
|
||||
// browser will be created before the old browser with the same identifier is
|
||||
// destroyed. |extra_info| is an optional read-only value originating from
|
||||
// CefBrowserHost::CreateBrowser(), CefBrowserHost::CreateBrowserSync(),
|
||||
// CefLifeSpanHandler::OnBeforePopup() or CefBrowserView::CreateBrowserView().
|
||||
/// Called after a browser has been created. When browsing cross-origin a new
|
||||
/// browser will be created before the old browser with the same identifier is
|
||||
/// destroyed. |extra_info| is an optional read-only value originating from
|
||||
/// CefBrowserHost::CreateBrowser(), CefBrowserHost::CreateBrowserSync(),
|
||||
/// CefLifeSpanHandler::OnBeforePopup() or
|
||||
/// CefBrowserView::CreateBrowserView().
|
||||
///
|
||||
/*--cef(optional_param=extra_info)--*/
|
||||
virtual void OnBrowserCreated(CefRefPtr<CefBrowser> browser,
|
||||
CefRefPtr<CefDictionaryValue> extra_info) {}
|
||||
|
||||
///
|
||||
// Called before a browser is destroyed.
|
||||
/// Called before a browser is destroyed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnBrowserDestroyed(CefRefPtr<CefBrowser> browser) {}
|
||||
|
||||
///
|
||||
// Return the handler for browser load status events.
|
||||
/// Return the handler for browser load status events.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefLoadHandler> GetLoadHandler() { return nullptr; }
|
||||
|
||||
///
|
||||
// Called immediately after the V8 context for a frame has been created. To
|
||||
// retrieve the JavaScript 'window' object use the CefV8Context::GetGlobal()
|
||||
// method. V8 handles can only be accessed from the thread on which they are
|
||||
// created. A task runner for posting tasks on the associated thread can be
|
||||
// retrieved via the CefV8Context::GetTaskRunner() method.
|
||||
/// Called immediately after the V8 context for a frame has been created. To
|
||||
/// retrieve the JavaScript 'window' object use the CefV8Context::GetGlobal()
|
||||
/// method. V8 handles can only be accessed from the thread on which they are
|
||||
/// created. A task runner for posting tasks on the associated thread can be
|
||||
/// retrieved via the CefV8Context::GetTaskRunner() method.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnContextCreated(CefRefPtr<CefBrowser> browser,
|
||||
@ -99,8 +100,8 @@ class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefV8Context> context) {}
|
||||
|
||||
///
|
||||
// Called immediately before the V8 context for a frame is released. No
|
||||
// references to the context should be kept after this method is called.
|
||||
/// Called immediately before the V8 context for a frame is released. No
|
||||
/// references to the context should be kept after this method is called.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnContextReleased(CefRefPtr<CefBrowser> browser,
|
||||
@ -108,9 +109,9 @@ class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefV8Context> context) {}
|
||||
|
||||
///
|
||||
// Called for global uncaught exceptions in a frame. Execution of this
|
||||
// callback is disabled by default. To enable set
|
||||
// CefSettings.uncaught_exception_stack_size > 0.
|
||||
/// Called for global uncaught exceptions in a frame. Execution of this
|
||||
/// callback is disabled by default. To enable set
|
||||
/// cef_settings_t.uncaught_exception_stack_size > 0.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnUncaughtException(CefRefPtr<CefBrowser> browser,
|
||||
@ -120,12 +121,12 @@ class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefV8StackTrace> stackTrace) {}
|
||||
|
||||
///
|
||||
// Called when a new node in the the browser gets focus. The |node| value may
|
||||
// be empty if no specific node has gained focus. The node 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.
|
||||
/// Called when a new node in the the browser gets focus. The |node| value may
|
||||
/// be empty if no specific node has gained focus. The node 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(optional_param=frame,optional_param=node)--*/
|
||||
virtual void OnFocusedNodeChanged(CefRefPtr<CefBrowser> browser,
|
||||
@ -133,9 +134,9 @@ class CefRenderProcessHandler : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefDOMNode> node) {}
|
||||
|
||||
///
|
||||
// Called when a new message is received from a different process. Return true
|
||||
// if the message was handled or false otherwise. It is safe to keep a
|
||||
// reference to |message| outside of this callback.
|
||||
/// Called when a new message is received from a different process. Return
|
||||
/// true if the message was handled or false otherwise. It is safe to keep a
|
||||
/// reference to |message| outside of this callback.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnProcessMessageReceived(CefRefPtr<CefBrowser> browser,
|
||||
|
Reference in New Issue
Block a user