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
@ -51,22 +51,22 @@
|
||||
#include "include/cef_x509_certificate.h"
|
||||
|
||||
///
|
||||
// Callback interface used to select a client certificate for authentication.
|
||||
/// Callback interface used to select a client certificate for authentication.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefSelectClientCertificateCallback : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Chooses the specified certificate for client certificate authentication.
|
||||
// NULL value means that no client certificate should be used.
|
||||
/// Chooses the specified certificate for client certificate authentication.
|
||||
/// NULL value means that no client certificate should be used.
|
||||
///
|
||||
/*--cef(optional_param=cert)--*/
|
||||
virtual void Select(CefRefPtr<CefX509Certificate> cert) = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Implement this interface to handle events related to browser requests. The
|
||||
// methods of this class will be called on the thread indicated.
|
||||
/// Implement this interface to handle events related to browser requests. The
|
||||
/// methods of this class will be called on the thread indicated.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
@ -76,16 +76,16 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
typedef std::vector<CefRefPtr<CefX509Certificate>> X509CertificateList;
|
||||
|
||||
///
|
||||
// Called on the UI thread before browser navigation. Return true to cancel
|
||||
// the navigation or false to allow the navigation to proceed. The |request|
|
||||
// object cannot be modified in this callback.
|
||||
// CefLoadHandler::OnLoadingStateChange will be called twice in all cases.
|
||||
// If the navigation is allowed CefLoadHandler::OnLoadStart and
|
||||
// CefLoadHandler::OnLoadEnd will be called. If the navigation is canceled
|
||||
// CefLoadHandler::OnLoadError will be called with an |errorCode| value of
|
||||
// ERR_ABORTED. The |user_gesture| value will be true if the browser
|
||||
// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
||||
// navigated automatically (e.g. via the DomContentLoaded event).
|
||||
/// Called on the UI thread before browser navigation. Return true to cancel
|
||||
/// the navigation or false to allow the navigation to proceed. The |request|
|
||||
/// object cannot be modified in this callback.
|
||||
/// CefLoadHandler::OnLoadingStateChange will be called twice in all cases.
|
||||
/// If the navigation is allowed CefLoadHandler::OnLoadStart and
|
||||
/// CefLoadHandler::OnLoadEnd will be called. If the navigation is canceled
|
||||
/// CefLoadHandler::OnLoadError will be called with an |errorCode| value of
|
||||
/// ERR_ABORTED. The |user_gesture| value will be true if the browser
|
||||
/// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
||||
/// navigated automatically (e.g. via the DomContentLoaded event).
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnBeforeBrowse(CefRefPtr<CefBrowser> browser,
|
||||
@ -97,20 +97,20 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the UI thread before OnBeforeBrowse in certain limited cases
|
||||
// where navigating a new or different browser might be desirable. This
|
||||
// includes user-initiated navigation that might open in a special way (e.g.
|
||||
// links clicked via middle-click or ctrl + left-click) and certain types of
|
||||
// cross-origin navigation initiated from the renderer process (e.g.
|
||||
// navigating the top-level frame to/from a file URL). The |browser| and
|
||||
// |frame| values represent the source of the navigation. The
|
||||
// |target_disposition| value indicates where the user intended to navigate
|
||||
// the browser based on standard Chromium behaviors (e.g. current tab,
|
||||
// new tab, etc). The |user_gesture| value will be true if the browser
|
||||
// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
||||
// navigated automatically (e.g. via the DomContentLoaded event). Return true
|
||||
// to cancel the navigation or false to allow the navigation to proceed in the
|
||||
// source browser's top-level frame.
|
||||
/// Called on the UI thread before OnBeforeBrowse in certain limited cases
|
||||
/// where navigating a new or different browser might be desirable. This
|
||||
/// includes user-initiated navigation that might open in a special way (e.g.
|
||||
/// links clicked via middle-click or ctrl + left-click) and certain types of
|
||||
/// cross-origin navigation initiated from the renderer process (e.g.
|
||||
/// navigating the top-level frame to/from a file URL). The |browser| and
|
||||
/// |frame| values represent the source of the navigation. The
|
||||
/// |target_disposition| value indicates where the user intended to navigate
|
||||
/// the browser based on standard Chromium behaviors (e.g. current tab,
|
||||
/// new tab, etc). The |user_gesture| value will be true if the browser
|
||||
/// navigated via explicit user gesture (e.g. clicking a link) or false if it
|
||||
/// navigated automatically (e.g. via the DomContentLoaded event). Return true
|
||||
/// to cancel the navigation or false to allow the navigation to proceed in
|
||||
/// the source browser's top-level frame.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnOpenURLFromTab(CefRefPtr<CefBrowser> browser,
|
||||
@ -122,19 +122,19 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the browser process IO thread before a resource request is
|
||||
// initiated. The |browser| and |frame| values represent the source of the
|
||||
// request. |request| represents the request contents and cannot be modified
|
||||
// in this callback. |is_navigation| will be true if the resource request is a
|
||||
// navigation. |is_download| will be true if the resource request is a
|
||||
// download. |request_initiator| is the origin (scheme + domain) of the page
|
||||
// that initiated the request. Set |disable_default_handling| to true to
|
||||
// disable default handling of the request, in which case it will need to be
|
||||
// handled via CefResourceRequestHandler::GetResourceHandler or it will be
|
||||
// canceled. To allow the resource load to proceed with default handling
|
||||
// return NULL. To specify a handler for the resource return a
|
||||
// CefResourceRequestHandler object. If this callback returns NULL the same
|
||||
// method will be called on the associated CefRequestContextHandler, if any.
|
||||
/// Called on the browser process IO thread before a resource request is
|
||||
/// initiated. The |browser| and |frame| values represent the source of the
|
||||
/// request. |request| represents the request contents and cannot be modified
|
||||
/// in this callback. |is_navigation| will be true if the resource request is
|
||||
/// a navigation. |is_download| will be true if the resource request is a
|
||||
/// download. |request_initiator| is the origin (scheme + domain) of the page
|
||||
/// that initiated the request. Set |disable_default_handling| to true to
|
||||
/// disable default handling of the request, in which case it will need to be
|
||||
/// handled via CefResourceRequestHandler::GetResourceHandler or it will be
|
||||
/// canceled. To allow the resource load to proceed with default handling
|
||||
/// return NULL. To specify a handler for the resource return a
|
||||
/// CefResourceRequestHandler object. If this callback returns NULL the same
|
||||
/// method will be called on the associated CefRequestContextHandler, if any.
|
||||
///
|
||||
/*--cef(optional_param=request_initiator)--*/
|
||||
virtual CefRefPtr<CefResourceRequestHandler> GetResourceRequestHandler(
|
||||
@ -149,16 +149,16 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread when the browser needs credentials from the user.
|
||||
// |origin_url| is the origin making this authentication request. |isProxy|
|
||||
// indicates whether the host is a proxy server. |host| contains the hostname
|
||||
// and |port| contains the port number. |realm| is the realm of the challenge
|
||||
// and may be empty. |scheme| is the authentication scheme used, such as
|
||||
// "basic" or "digest", and will be empty if the source of the request is an
|
||||
// FTP server. Return true to continue the request and call
|
||||
// CefAuthCallback::Continue() either in this method or at a later time when
|
||||
// the authentication information is available. Return false to cancel the
|
||||
// request immediately.
|
||||
/// Called on the IO thread when the browser needs credentials from the user.
|
||||
/// |origin_url| is the origin making this authentication request. |isProxy|
|
||||
/// indicates whether the host is a proxy server. |host| contains the hostname
|
||||
/// and |port| contains the port number. |realm| is the realm of the challenge
|
||||
/// and may be empty. |scheme| is the authentication scheme used, such as
|
||||
/// "basic" or "digest", and will be empty if the source of the request is an
|
||||
/// FTP server. Return true to continue the request and call
|
||||
/// CefAuthCallback::Continue() either in this method or at a later time when
|
||||
/// the authentication information is available. Return false to cancel the
|
||||
/// request immediately.
|
||||
///
|
||||
/*--cef(optional_param=realm,optional_param=scheme)--*/
|
||||
virtual bool GetAuthCredentials(CefRefPtr<CefBrowser> browser,
|
||||
@ -173,12 +173,12 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the IO thread when JavaScript requests a specific storage quota
|
||||
// size via the webkitStorageInfo.requestQuota function. |origin_url| is the
|
||||
// origin of the page making the request. |new_size| is the requested quota
|
||||
// size in bytes. Return true to continue the request and call CefCallback
|
||||
// methods either in this method or at a later time to grant or deny the
|
||||
// request. Return false to cancel the request immediately.
|
||||
/// Called on the IO thread when JavaScript requests a specific storage quota
|
||||
/// size via the webkitStorageInfo.requestQuota function. |origin_url| is the
|
||||
/// origin of the page making the request. |new_size| is the requested quota
|
||||
/// size in bytes. Return true to continue the request and call CefCallback
|
||||
/// methods either in this method or at a later time to grant or deny the
|
||||
/// request. Return false to cancel the request immediately.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnQuotaRequest(CefRefPtr<CefBrowser> browser,
|
||||
@ -189,12 +189,12 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the UI thread to handle requests for URLs with an invalid
|
||||
// SSL certificate. Return true and call CefCallback methods either in this
|
||||
// method or at a later time to continue or cancel the request. Return false
|
||||
// to cancel the request immediately. If CefSettings.ignore_certificate_errors
|
||||
// is set all invalid certificates will be accepted without calling this
|
||||
// method.
|
||||
/// Called on the UI thread to handle requests for URLs with an invalid
|
||||
/// SSL certificate. Return true and call CefCallback methods either in this
|
||||
/// method or at a later time to continue or cancel the request. Return false
|
||||
/// to cancel the request immediately. If
|
||||
/// cef_settings_t.ignore_certificate_errors is set all invalid certificates
|
||||
/// will be accepted without calling this method.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnCertificateError(CefRefPtr<CefBrowser> browser,
|
||||
@ -206,16 +206,17 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the UI thread when a client certificate is being requested for
|
||||
// authentication. Return false to use the default behavior and automatically
|
||||
// select the first certificate available. Return true and call
|
||||
// CefSelectClientCertificateCallback::Select either in this method or at a
|
||||
// later time to select a certificate. Do not call Select or call it with NULL
|
||||
// to continue without using any certificate. |isProxy| indicates whether the
|
||||
// host is an HTTPS proxy or the origin server. |host| and |port| contains the
|
||||
// hostname and port of the SSL server. |certificates| is the list of
|
||||
// certificates to choose from; this list has already been pruned by Chromium
|
||||
// so that it only contains certificates from issuers that the server trusts.
|
||||
/// Called on the UI thread when a client certificate is being requested for
|
||||
/// authentication. Return false to use the default behavior and automatically
|
||||
/// select the first certificate available. Return true and call
|
||||
/// CefSelectClientCertificateCallback::Select either in this method or at a
|
||||
/// later time to select a certificate. Do not call Select or call it with
|
||||
/// NULL to continue without using any certificate. |isProxy| indicates
|
||||
/// whether the host is an HTTPS proxy or the origin server. |host| and |port|
|
||||
/// contains the hostname and port of the SSL server. |certificates| is the
|
||||
/// list of certificates to choose from; this list has already been pruned by
|
||||
/// Chromium so that it only contains certificates from issuers that the
|
||||
/// server trusts.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnSelectClientCertificate(
|
||||
@ -229,25 +230,25 @@ class CefRequestHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called on the browser process UI thread when the render view associated
|
||||
// with |browser| is ready to receive/handle IPC messages in the render
|
||||
// process.
|
||||
/// Called on the browser process UI thread when the render view associated
|
||||
/// with |browser| is ready to receive/handle IPC messages in the render
|
||||
/// process.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnRenderViewReady(CefRefPtr<CefBrowser> browser) {}
|
||||
|
||||
///
|
||||
// Called on the browser process UI thread when the render process
|
||||
// terminates unexpectedly. |status| indicates how the process
|
||||
// terminated.
|
||||
/// Called on the browser process UI thread when the render process
|
||||
/// terminates unexpectedly. |status| indicates how the process
|
||||
/// terminated.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnRenderProcessTerminated(CefRefPtr<CefBrowser> browser,
|
||||
TerminationStatus status) {}
|
||||
|
||||
///
|
||||
// Called on the browser process UI thread when the window.document object of
|
||||
// the main frame has been created.
|
||||
/// Called on the browser process UI thread when the window.document object of
|
||||
/// the main frame has been created.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnDocumentAvailableInMainFrame(CefRefPtr<CefBrowser> browser) {}
|
||||
|
||||
Reference in New Issue
Block a user