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:
Marshall Greenblatt
@ -50,9 +50,9 @@
|
||||
class CefCookieAccessFilter;
|
||||
|
||||
///
|
||||
// Implement this interface to handle events related to browser requests. The
|
||||
// methods of this class will be called on the IO thread unless otherwise
|
||||
// indicated.
|
||||
/// Implement this interface to handle events related to browser requests. The
|
||||
/// methods of this class will be called on the IO thread unless otherwise
|
||||
/// indicated.
|
||||
///
|
||||
/*--cef(source=client,no_debugct_check)--*/
|
||||
class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
@ -61,11 +61,11 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
typedef cef_urlrequest_status_t URLRequestStatus;
|
||||
|
||||
///
|
||||
// Called on the IO thread before a resource request is loaded. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. To optionally
|
||||
// filter cookies for the request return a CefCookieAccessFilter object. The
|
||||
// |request| object cannot not be modified in this callback.
|
||||
/// Called on the IO thread before a resource request is loaded. The |browser|
|
||||
/// and |frame| values represent the source of the request, and may be NULL
|
||||
/// for requests originating from service workers or CefURLRequest. To
|
||||
/// optionally filter cookies for the request return a CefCookieAccessFilter
|
||||
/// object. The |request| object cannot not be modified in this callback.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual CefRefPtr<CefCookieAccessFilter> GetCookieAccessFilter(
|
||||
@ -76,15 +76,15 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread before a resource request is loaded. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. To redirect or
|
||||
// change the resource load optionally modify |request|. Modification of the
|
||||
// request URL will be treated as a redirect. Return RV_CONTINUE to continue
|
||||
// the request immediately. Return RV_CONTINUE_ASYNC and call CefCallback
|
||||
// methods at a later time to continue or cancel the request asynchronously.
|
||||
// Return RV_CANCEL to cancel the request immediately.
|
||||
//
|
||||
/// Called on the IO thread before a resource request is loaded. The |browser|
|
||||
/// and |frame| values represent the source of the request, and may be NULL
|
||||
/// for requests originating from service workers or CefURLRequest. To
|
||||
/// redirect or change the resource load optionally modify |request|.
|
||||
/// Modification of the request URL will be treated as a redirect. Return
|
||||
/// RV_CONTINUE to continue the request immediately. Return RV_CONTINUE_ASYNC
|
||||
/// and call CefCallback methods at a later time to continue or cancel the
|
||||
/// request asynchronously. Return RV_CANCEL to cancel the request
|
||||
/// immediately.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame,
|
||||
default_retval=RV_CONTINUE)--*/
|
||||
@ -96,12 +96,12 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread before a resource is loaded. The |browser| and
|
||||
// |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. To allow the
|
||||
// resource to load using the default network loader return NULL. To specify a
|
||||
// handler for the resource return a CefResourceHandler object. The |request|
|
||||
// object cannot not be modified in this callback.
|
||||
/// Called on the IO thread before a resource is loaded. The |browser| and
|
||||
/// |frame| values represent the source of the request, and may be NULL for
|
||||
/// requests originating from service workers or CefURLRequest. To allow the
|
||||
/// resource to load using the default network loader return NULL. To specify
|
||||
/// a handler for the resource return a CefResourceHandler object. The
|
||||
/// |request| object cannot not be modified in this callback.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual CefRefPtr<CefResourceHandler> GetResourceHandler(
|
||||
@ -112,14 +112,14 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread when a resource load is redirected. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. The |request|
|
||||
// parameter will contain the old URL and other request-related information.
|
||||
// The |response| parameter will contain the response that resulted in the
|
||||
// redirect. The |new_url| parameter will contain the new URL and can be
|
||||
// changed if desired. The |request| and |response| objects cannot be modified
|
||||
// in this callback.
|
||||
/// Called on the IO thread when a resource load is redirected. The |browser|
|
||||
/// and |frame| values represent the source of the request, and may be NULL
|
||||
/// for requests originating from service workers or CefURLRequest. The
|
||||
/// |request| parameter will contain the old URL and other request-related
|
||||
/// information. The |response| parameter will contain the response that
|
||||
/// resulted in the redirect. The |new_url| parameter will contain the new URL
|
||||
/// and can be changed if desired. The |request| and |response| objects cannot
|
||||
/// be modified in this callback.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual void OnResourceRedirect(CefRefPtr<CefBrowser> browser,
|
||||
@ -129,17 +129,17 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
CefString& new_url) {}
|
||||
|
||||
///
|
||||
// Called on the IO thread when a resource response is received. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. To allow the
|
||||
// resource load to proceed without modification return false. To redirect or
|
||||
// retry the resource load optionally modify |request| and return true.
|
||||
// Modification of the request URL will be treated as a redirect. Requests
|
||||
// handled using the default network loader cannot be redirected in this
|
||||
// callback. The |response| object cannot be modified in this callback.
|
||||
//
|
||||
// WARNING: Redirecting using this method is deprecated. Use
|
||||
// OnBeforeResourceLoad or GetResourceHandler to perform redirects.
|
||||
/// Called on the IO thread when a resource response is received. The
|
||||
/// |browser| and |frame| values represent the source of the request, and may
|
||||
/// be NULL for requests originating from service workers or CefURLRequest. To
|
||||
/// allow the resource load to proceed without modification return false. To
|
||||
/// redirect or retry the resource load optionally modify |request| and return
|
||||
/// true. Modification of the request URL will be treated as a redirect.
|
||||
/// Requests handled using the default network loader cannot be redirected in
|
||||
/// this callback. The |response| object cannot be modified in this callback.
|
||||
///
|
||||
/// WARNING: Redirecting using this method is deprecated. Use
|
||||
/// OnBeforeResourceLoad or GetResourceHandler to perform redirects.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual bool OnResourceResponse(CefRefPtr<CefBrowser> browser,
|
||||
@ -150,11 +150,11 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread to optionally filter resource response content. The
|
||||
// |browser| and |frame| values represent the source of the request, and may
|
||||
// be NULL for requests originating from service workers or CefURLRequest.
|
||||
// |request| and |response| represent the request and response respectively
|
||||
// and cannot be modified in this callback.
|
||||
/// Called on the IO thread to optionally filter resource response content.
|
||||
/// The |browser| and |frame| values represent the source of the request, and
|
||||
/// may be NULL for requests originating from service workers or
|
||||
/// CefURLRequest. |request| and |response| represent the request and response
|
||||
/// respectively and cannot be modified in this callback.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual CefRefPtr<CefResponseFilter> GetResourceResponseFilter(
|
||||
@ -166,19 +166,20 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread when a resource load has completed. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. |request| and
|
||||
// |response| represent the request and response respectively and cannot be
|
||||
// modified in this callback. |status| indicates the load completion status.
|
||||
// |received_content_length| is the number of response bytes actually read.
|
||||
// This method will be called for all requests, including requests that are
|
||||
// aborted due to CEF shutdown or destruction of the associated browser. In
|
||||
// cases where the associated browser is destroyed this callback may arrive
|
||||
// after the CefLifeSpanHandler::OnBeforeClose callback for that browser. The
|
||||
// CefFrame::IsValid method can be used to test for this situation, and care
|
||||
// should be taken not to call |browser| or |frame| methods that modify state
|
||||
// (like LoadURL, SendProcessMessage, etc.) if the frame is invalid.
|
||||
/// Called on the IO thread when a resource load has completed. The |browser|
|
||||
/// and |frame| values represent the source of the request, and may be NULL
|
||||
/// for requests originating from service workers or CefURLRequest. |request|
|
||||
/// and |response| represent the request and response respectively and cannot
|
||||
/// be modified in this callback. |status| indicates the load completion
|
||||
/// status. |received_content_length| is the number of response bytes actually
|
||||
/// read. This method will be called for all requests, including requests that
|
||||
/// are aborted due to CEF shutdown or destruction of the associated browser.
|
||||
/// In cases where the associated browser is destroyed this callback may
|
||||
/// arrive after the CefLifeSpanHandler::OnBeforeClose callback for that
|
||||
/// browser. The CefFrame::IsValid method can be used to test for this
|
||||
/// situation, and care should be taken not to call |browser| or |frame|
|
||||
/// methods that modify state (like LoadURL, SendProcessMessage, etc.) if the
|
||||
/// frame is invalid.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual void OnResourceLoadComplete(CefRefPtr<CefBrowser> browser,
|
||||
@ -189,14 +190,14 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
int64 received_content_length) {}
|
||||
|
||||
///
|
||||
// Called on the IO thread to handle requests for URLs with an unknown
|
||||
// protocol component. The |browser| and |frame| values represent the source
|
||||
// of the request, and may be NULL for requests originating from service
|
||||
// workers or CefURLRequest. |request| cannot be modified in this callback.
|
||||
// Set |allow_os_execution| to true to attempt execution via the registered OS
|
||||
// protocol handler, if any.
|
||||
// SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED
|
||||
// ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
|
||||
/// Called on the IO thread to handle requests for URLs with an unknown
|
||||
/// protocol component. The |browser| and |frame| values represent the source
|
||||
/// of the request, and may be NULL for requests originating from service
|
||||
/// workers or CefURLRequest. |request| cannot be modified in this callback.
|
||||
/// Set |allow_os_execution| to true to attempt execution via the registered
|
||||
/// OS protocol handler, if any. SECURITY WARNING: YOU SHOULD USE THIS METHOD
|
||||
/// TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE
|
||||
/// ALLOWING OS EXECUTION.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual void OnProtocolExecution(CefRefPtr<CefBrowser> browser,
|
||||
@ -206,19 +207,19 @@ class CefResourceRequestHandler : public virtual CefBaseRefCounted {
|
||||
};
|
||||
|
||||
///
|
||||
// Implement this interface to filter cookies that may be sent or received from
|
||||
// resource requests. The methods of this class will be called on the IO thread
|
||||
// unless otherwise indicated.
|
||||
/// Implement this interface to filter cookies that may be sent or received from
|
||||
/// resource requests. The methods of this class will be called on the IO thread
|
||||
/// unless otherwise indicated.
|
||||
///
|
||||
/*--cef(source=client,no_debugct_check)--*/
|
||||
class CefCookieAccessFilter : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Called on the IO thread before a resource request is sent. The |browser|
|
||||
// and |frame| values represent the source of the request, and may be NULL for
|
||||
// requests originating from service workers or CefURLRequest. |request|
|
||||
// cannot be modified in this callback. Return true if the specified cookie
|
||||
// can be sent with the request or false otherwise.
|
||||
/// Called on the IO thread before a resource request is sent. The |browser|
|
||||
/// and |frame| values represent the source of the request, and may be NULL
|
||||
/// for requests originating from service workers or CefURLRequest. |request|
|
||||
/// cannot be modified in this callback. Return true if the specified cookie
|
||||
/// can be sent with the request or false otherwise.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual bool CanSendCookie(CefRefPtr<CefBrowser> browser,
|
||||
@ -229,11 +230,12 @@ class CefCookieAccessFilter : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread after a resource response is received. The
|
||||
// |browser| and |frame| values represent the source of the request, and may
|
||||
// be NULL for requests originating from service workers or CefURLRequest.
|
||||
// |request| cannot be modified in this callback. Return true if the specified
|
||||
// cookie returned with the response can be saved or false otherwise.
|
||||
/// Called on the IO thread after a resource response is received. The
|
||||
/// |browser| and |frame| values represent the source of the request, and may
|
||||
/// be NULL for requests originating from service workers or CefURLRequest.
|
||||
/// |request| cannot be modified in this callback. Return true if the
|
||||
/// specified cookie returned with the response can be saved or false
|
||||
/// otherwise.
|
||||
///
|
||||
/*--cef(optional_param=browser,optional_param=frame)--*/
|
||||
virtual bool CanSaveCookie(CefRefPtr<CefBrowser> browser,
|
||||
|
||||
Reference in New Issue
Block a user