bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve scheme handler documentation.

Browse Source 
git-svn-id: https://chromiumembedded.googlecode.com/svn/trunk@1233 5089003a-bbd8-11dd-ad1f-f1f9622dbc98
This commit is contained in:
Marshall Greenblatt
2013-04-17 21:13:26 +00:00
parent 3a801af61d
commit d6a9cea226
2 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
include/capi/cef_scheme_capi.h
View File

@ -51,11 +51,12 @@ extern "C" {
// will cause the factory to match all domain names. The |domain_name| value // will cause the factory to match all domain names. The |domain_name| value
// will be ignored for non-standard schemes. If |scheme_name| is a built-in // will be ignored for non-standard schemes. If |scheme_name| is a built-in
// scheme and no handler is returned by |factory| then the built-in scheme // scheme and no handler is returned by |factory| then the built-in scheme
// handler factory will be called. If |scheme_name| is a custom scheme the // handler factory will be called. If |scheme_name| is a custom scheme then also
// CefRegisterCustomScheme() function should be called for that scheme. This // implement the cef_app_t::on_register_custom_schemes() function in all
// function may be called multiple times to change or remove the factory that // processes. This function may be called multiple times to change or remove the
// matches the specified |scheme_name| and optional |domain_name|. Returns false // factory that matches the specified |scheme_name| and optional |domain_name|.
// (0) if an error occurs. This function may be called on any thread. // Returns false (0) if an error occurs. This function may be called on any
// thread in the browser process.
/// ///
CEF_EXPORT int cef_register_scheme_handler_factory( CEF_EXPORT int cef_register_scheme_handler_factory(
const cef_string_t* scheme_name, const cef_string_t* domain_name, const cef_string_t* scheme_name, const cef_string_t* domain_name,
@ -63,7 +64,7 @@ CEF_EXPORT int cef_register_scheme_handler_factory(
/// ///
// Clear all registered scheme handler factories. Returns false (0) on error. // Clear all registered scheme handler factories. Returns false (0) on error.
// This function may be called on any thread. // This function may be called on any thread in the browser process.
/// ///
CEF_EXPORT int cef_clear_scheme_handler_factories(); CEF_EXPORT int cef_clear_scheme_handler_factories();

9
include/cef_scheme.h
View File

@ -54,11 +54,12 @@ class CefSchemeHandlerFactory;
// will cause the factory to match all domain names. The |domain_name| value // will cause the factory to match all domain names. The |domain_name| value
// will be ignored for non-standard schemes. If |scheme_name| is a built-in // will be ignored for non-standard schemes. If |scheme_name| is a built-in
// scheme and no handler is returned by |factory| then the built-in scheme // scheme and no handler is returned by |factory| then the built-in scheme
// handler factory will be called. If |scheme_name| is a custom scheme the // handler factory will be called. If |scheme_name| is a custom scheme then
// CefRegisterCustomScheme() function should be called for that scheme. // also implement the CefApp::OnRegisterCustomSchemes() method in all processes.
// This function may be called multiple times to change or remove the factory // This function may be called multiple times to change or remove the factory
// that matches the specified |scheme_name| and optional |domain_name|. // that matches the specified |scheme_name| and optional |domain_name|.
// Returns false if an error occurs. This function may be called on any thread. // Returns false if an error occurs. This function may be called on any thread
// in the browser process.
/// ///
/*--cef(optional_param=domain_name,optional_param=factory)--*/ /*--cef(optional_param=domain_name,optional_param=factory)--*/
bool CefRegisterSchemeHandlerFactory( bool CefRegisterSchemeHandlerFactory(
@ -68,7 +69,7 @@ bool CefRegisterSchemeHandlerFactory(
/// ///
// Clear all registered scheme handler factories. Returns false on error. This // Clear all registered scheme handler factories. Returns false on error. This
// function may be called on any thread. // function may be called on any thread in the browser process.
/// ///
/*--cef()--*/ /*--cef()--*/
bool CefClearSchemeHandlerFactories(); bool CefClearSchemeHandlerFactories();