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
@ -46,67 +46,67 @@
|
||||
class CefClient;
|
||||
|
||||
///
|
||||
// Callback interface used for asynchronous continuation of
|
||||
// CefExtensionHandler::GetExtensionResource.
|
||||
/// Callback interface used for asynchronous continuation of
|
||||
/// CefExtensionHandler::GetExtensionResource.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefGetExtensionResourceCallback : public CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Continue the request. Read the resource contents from |stream|.
|
||||
/// Continue the request. Read the resource contents from |stream|.
|
||||
///
|
||||
/*--cef(capi_name=cont,optional_param=stream)--*/
|
||||
virtual void Continue(CefRefPtr<CefStreamReader> stream) = 0;
|
||||
|
||||
///
|
||||
// Cancel the request.
|
||||
/// Cancel the request.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Cancel() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Implement this interface to handle events related to browser extensions.
|
||||
// The methods of this class will be called on the UI thread. See
|
||||
// CefRequestContext::LoadExtension for information about extension loading.
|
||||
/// Implement this interface to handle events related to browser extensions.
|
||||
/// The methods of this class will be called on the UI thread. See
|
||||
/// CefRequestContext::LoadExtension for information about extension loading.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefExtensionHandler : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Called if the CefRequestContext::LoadExtension request fails. |result| will
|
||||
// be the error code.
|
||||
/// Called if the CefRequestContext::LoadExtension request fails. |result|
|
||||
/// will be the error code.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnExtensionLoadFailed(cef_errorcode_t result) {}
|
||||
|
||||
///
|
||||
// Called if the CefRequestContext::LoadExtension request succeeds.
|
||||
// |extension| is the loaded extension.
|
||||
/// Called if the CefRequestContext::LoadExtension request succeeds.
|
||||
/// |extension| is the loaded extension.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnExtensionLoaded(CefRefPtr<CefExtension> extension) {}
|
||||
|
||||
///
|
||||
// Called after the CefExtension::Unload request has completed.
|
||||
/// Called after the CefExtension::Unload request has completed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnExtensionUnloaded(CefRefPtr<CefExtension> extension) {}
|
||||
|
||||
///
|
||||
// Called when an extension needs a browser to host a background script
|
||||
// specified via the "background" manifest key. The browser will have no
|
||||
// visible window and cannot be displayed. |extension| is the extension that
|
||||
// is loading the background script. |url| is an internally generated
|
||||
// reference to an HTML page that will be used to load the background script
|
||||
// via a <script> src attribute. To allow creation of the browser optionally
|
||||
// modify |client| and |settings| and return false. To cancel creation of the
|
||||
// browser (and consequently cancel load of the background script) return
|
||||
// true. Successful creation will be indicated by a call to
|
||||
// CefLifeSpanHandler::OnAfterCreated, and CefBrowserHost::IsBackgroundHost
|
||||
// will return true for the resulting browser. See
|
||||
// https://developer.chrome.com/extensions/event_pages for more information
|
||||
// about extension background script usage.
|
||||
/// Called when an extension needs a browser to host a background script
|
||||
/// specified via the "background" manifest key. The browser will have no
|
||||
/// visible window and cannot be displayed. |extension| is the extension that
|
||||
/// is loading the background script. |url| is an internally generated
|
||||
/// reference to an HTML page that will be used to load the background script
|
||||
/// via a "<script>" src attribute. To allow creation of the browser
|
||||
/// optionally modify |client| and |settings| and return false. To cancel
|
||||
/// creation of the browser (and consequently cancel load of the background
|
||||
/// script) return true. Successful creation will be indicated by a call to
|
||||
/// CefLifeSpanHandler::OnAfterCreated, and CefBrowserHost::IsBackgroundHost
|
||||
/// will return true for the resulting browser. See
|
||||
/// https://developer.chrome.com/extensions/event_pages for more information
|
||||
/// about extension background script usage.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnBeforeBackgroundBrowser(CefRefPtr<CefExtension> extension,
|
||||
@ -117,18 +117,19 @@ class CefExtensionHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when an extension API (e.g. chrome.tabs.create) requests creation of
|
||||
// a new browser. |extension| and |browser| are the source of the API call.
|
||||
// |active_browser| may optionally be specified via the windowId property or
|
||||
// returned via the GetActiveBrowser() callback and provides the default
|
||||
// |client| and |settings| values for the new browser. |index| is the position
|
||||
// value optionally specified via the index property. |url| is the URL that
|
||||
// will be loaded in the browser. |active| is true if the new browser should
|
||||
// be active when opened. To allow creation of the browser optionally modify
|
||||
// |windowInfo|, |client| and |settings| and return false. To cancel creation
|
||||
// of the browser return true. Successful creation will be indicated by a call
|
||||
// to CefLifeSpanHandler::OnAfterCreated. Any modifications to |windowInfo|
|
||||
// will be ignored if |active_browser| is wrapped in a CefBrowserView.
|
||||
/// Called when an extension API (e.g. chrome.tabs.create) requests creation
|
||||
/// of a new browser. |extension| and |browser| are the source of the API
|
||||
/// call. |active_browser| may optionally be specified via the windowId
|
||||
/// property or returned via the GetActiveBrowser() callback and provides the
|
||||
/// default |client| and |settings| values for the new browser. |index| is the
|
||||
/// position value optionally specified via the index property. |url| is the
|
||||
/// URL that will be loaded in the browser. |active| is true if the new
|
||||
/// browser should be active when opened. To allow creation of the browser
|
||||
/// optionally modify |windowInfo|, |client| and |settings| and return false.
|
||||
/// To cancel creation of the browser return true. Successful creation will be
|
||||
/// indicated by a call to CefLifeSpanHandler::OnAfterCreated. Any
|
||||
/// modifications to |windowInfo| will be ignored if |active_browser| is
|
||||
/// wrapped in a CefBrowserView.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool OnBeforeBrowser(CefRefPtr<CefExtension> extension,
|
||||
@ -144,13 +145,13 @@ class CefExtensionHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when no tabId is specified to an extension API call that accepts a
|
||||
// tabId parameter (e.g. chrome.tabs.*). |extension| and |browser| are the
|
||||
// source of the API call. Return the browser that will be acted on by the API
|
||||
// call or return NULL to act on |browser|. The returned browser must share
|
||||
// the same CefRequestContext as |browser|. Incognito browsers should not be
|
||||
// considered unless the source extension has incognito access enabled, in
|
||||
// which case |include_incognito| will be true.
|
||||
/// Called when no tabId is specified to an extension API call that accepts a
|
||||
/// tabId parameter (e.g. chrome.tabs.*). |extension| and |browser| are the
|
||||
/// source of the API call. Return the browser that will be acted on by the
|
||||
/// API call or return NULL to act on |browser|. The returned browser must
|
||||
/// share the same CefRequestContext as |browser|. Incognito browsers should
|
||||
/// not be considered unless the source extension has incognito access
|
||||
/// enabled, in which case |include_incognito| will be true.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefBrowser> GetActiveBrowser(
|
||||
@ -161,12 +162,12 @@ class CefExtensionHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called when the tabId associated with |target_browser| is specified to an
|
||||
// extension API call that accepts a tabId parameter (e.g. chrome.tabs.*).
|
||||
// |extension| and |browser| are the source of the API call. Return true
|
||||
// to allow access of false to deny access. Access to incognito browsers
|
||||
// should not be allowed unless the source extension has incognito access
|
||||
// enabled, in which case |include_incognito| will be true.
|
||||
/// Called when the tabId associated with |target_browser| is specified to an
|
||||
/// extension API call that accepts a tabId parameter (e.g. chrome.tabs.*).
|
||||
/// |extension| and |browser| are the source of the API call. Return true
|
||||
/// to allow access of false to deny access. Access to incognito browsers
|
||||
/// should not be allowed unless the source extension has incognito access
|
||||
/// enabled, in which case |include_incognito| will be true.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool CanAccessBrowser(CefRefPtr<CefExtension> extension,
|
||||
@ -177,14 +178,14 @@ class CefExtensionHandler : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Called to retrieve an extension resource that would normally be loaded from
|
||||
// disk (e.g. if a file parameter is specified to chrome.tabs.executeScript).
|
||||
// |extension| and |browser| are the source of the resource request. |file| is
|
||||
// the requested relative file path. To handle the resource request return
|
||||
// true and execute |callback| either synchronously or asynchronously. For the
|
||||
// default behavior which reads the resource from the extension directory on
|
||||
// disk return false. Localization substitutions will not be applied to
|
||||
// resources handled via this method.
|
||||
/// Called to retrieve an extension resource that would normally be loaded
|
||||
/// from disk (e.g. if a file parameter is specified to
|
||||
/// chrome.tabs.executeScript). |extension| and |browser| are the source of
|
||||
/// the resource request. |file| is the requested relative file path. To
|
||||
/// handle the resource request return true and execute |callback| either
|
||||
/// synchronously or asynchronously. For the default behavior which reads the
|
||||
/// resource from the extension directory on disk return false. Localization
|
||||
/// substitutions will not be applied to resources handled via this method.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool GetExtensionResource(
|
||||
|
||||
Reference in New Issue
Block a user