Added more XML documentation.

This commit is contained in:
salvadordf 2023-11-05 16:53:22 +01:00
parent d773926952
commit 087760492c
7 changed files with 63 additions and 3 deletions

Binary file not shown.

View File

@ -4971,6 +4971,14 @@ type
/// </remarks>
ICefSchemeHandlerFactory = interface(ICefBaseRefCounted)
['{4D9B7960-B73B-4EBD-9ABE-6C1C43C245EB}']
/// <summary>
/// Return a new resource handler instance to handle the request or an NULL
/// reference to allow default handling of the request. |browser| and |frame|
/// will be the browser window and frame respectively that originated the
/// request or NULL if the request did not originate from a browser window
/// (for example, if the request came from ICefUrlRequest). The |request|
/// object passed to this function cannot be modified.
/// </summary>
function New(const browser: ICefBrowser; const frame: ICefFrame; const schemeName: ustring; const request: ICefRequest): ICefResourceHandler;
end;

View File

@ -15,8 +15,25 @@ uses
uCEFBaseScopedWrapper, uCEFTypes, uCEFInterfaces;
type
/// <summary>
/// Class that manages custom preference registrations.
/// </summary>
/// <remarks>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_preference_capi.h">CEF source file: /include/capi/cef_preference_capi.h (cef_preference_registrar_t)</see></para>
/// </remarks>
TCefPreferenceRegistrarRef = class(TCEFBaseScopedWrapperRef)
public
/// <summary>
/// Register a preference with the specified |name| and |default_value|. To
/// avoid conflicts with built-in preferences the |name| value should contain
/// an application-specific prefix followed by a period (e.g. "myapp.value").
/// The contents of |default_value| will be copied. The data type for the
/// preference will be inferred from |default_value|'s type and cannot be
/// changed after registration. Returns true (1) on success. Returns false (0)
/// if |name| is already registered or if |default_value| has an invalid type.
/// This function must be called from within the scope of the
/// ICefBrowserProcessHandler.OnRegisterCustomPreferences callback.
/// </summary>
function AddPreference(const name: ustring; const default_value: ICefValue): Boolean;
end;

View File

@ -15,13 +15,32 @@ uses
uCEFBaseRefCounted, uCEFInterfaces, uCEFTypes, uCEFResourceHandler;
type
/// <summary>
/// Class that creates ICefResourceHandler instances for handling scheme
/// requests.
/// </summary>
/// <remarks>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_scheme_capi.h">CEF source file: /include/capi/cef_scheme_capi.h (cef_scheme_handler_factory_t)</see></para>
/// </remarks>
TCefSchemeHandlerFactoryOwn = class(TCefBaseRefCountedOwn, ICefSchemeHandlerFactory)
protected
FClass : TCefResourceHandlerClass;
/// <summary>
/// Return a new resource handler instance to handle the request or an NULL
/// reference to allow default handling of the request. |browser| and |frame|
/// will be the browser window and frame respectively that originated the
/// request or NULL if the request did not originate from a browser window
/// (for example, if the request came from ICefUrlRequest). The |request|
/// object passed to this function cannot be modified.
/// </summary>
function New(const browser: ICefBrowser; const frame: ICefFrame; const schemeName: ustring; const request: ICefRequest): ICefResourceHandler; virtual;
public
/// <summary>
/// Constructor of the scheme handler factory.
/// </summary>
/// <param name="AClass">Class of the custom resource handler used to handle custom scheme requests.</param>
constructor Create(const AClass: TCefResourceHandlerClass); virtual;
end;

View File

@ -15,8 +15,24 @@ uses
uCEFBaseScopedWrapper, uCEFTypes;
type
/// <summary>
/// Class that manages custom scheme registrations.
/// </summary>
/// <remarks>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_scheme_capi.h">CEF source file: /include/capi/cef_scheme_capi.h (cef_scheme_registrar_t)</see></para>
/// </remarks>
TCefSchemeRegistrarRef = class(TCEFBaseScopedWrapperRef)
public
/// <summary>
/// <para>Register a custom scheme. This function should not be called for the
/// built-in HTTP, HTTPS, FILE, FTP, ABOUT and DATA schemes.</para>
/// <para>This function may be called on any thread. It should only be called once
/// per unique |scheme_name| value. If |scheme_name| is already registered or
/// if an error occurs this function will return false (0).</para>
/// </summary>
/// <remarks>
/// <para><see>See the CEF_SCHEME_OPTION_* constants in the uCEFConstants unit for possible values for |options|.</see></para>
/// </remarks>
function AddCustomScheme(const schemeName: ustring; options : TCefSchemeOptions): Boolean;
end;

View File

@ -4949,7 +4949,7 @@ type
/// Structure that manages custom preference registrations.
/// </summary>
/// <remarks>
/// <para>Implemented by ICefPreferenceRegistrar.</para>
/// <para>Implemented by TCefPreferenceRegistrarRef.</para>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_preference_capi.h">CEF source file: /include/capi/cef_preference_capi.h (cef_preference_registrar_t)</see></para>
/// </remarks>
TCefPreferenceRegistrar = record
@ -6028,7 +6028,7 @@ type
/// Structure that manages custom scheme registrations.
/// </summary>
/// <remarks>
/// <para>Implemented by ICefSchemeRegistrar.</para>
/// <para>Implemented by TCefSchemeRegistrarRef.</para>
/// <para><see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_scheme_capi.h">CEF source file: /include/capi/cef_scheme_capi.h (cef_scheme_registrar_t)</see></para>
/// </remarks>
TCefSchemeRegistrar = record

View File

@ -2,7 +2,7 @@
"UpdateLazPackages" : [
{
"ForceNotify" : true,
"InternalVersion" : 535,
"InternalVersion" : 536,
"Name" : "cef4delphi_lazarus.lpk",
"Version" : "118.6.9"
}